Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix typos #411

Closed
nils-work opened this issue Jun 24, 2024 · 8 comments
Closed

Fix typos #411

nils-work opened this issue Jun 24, 2024 · 8 comments
Assignees
@nils-work
Labels
enhancement New feature or request
Milestone
v1.32.0

Comments

@nils-work
Copy link
Member

The following typos have been identified in the Standards -

  1. Add hyphen (although this description may also require general clarification)
- including the original User Agent header
+ including the original User-Agent header 
- Each element has a field name additionalValue.
+ Each element has a field named additionalValue. 
- Only relevant is thoroughfareNumber
+ Only relevant if thoroughfareNumber
- If absent then all accounts returned.)
+ If absent then all accounts returned.

  1. Remove double spaces in source code text - they are rendered as single spaces in the generated HTML.

- they can all link to a single hosted page and use difference HTML anchors
+ they can all link to a single hosted page and use different HTML anchors
- Fees applicable for the product
+ Fees applicable to the product
- Display text providing more information the constraint
+ Display text providing more information on the constraint
- current rate to calculate interest earned being applied
+ Current rate to calculate interest earned being applied
- CDR Registrer supports
+ CDR Register supports
@nils-work nils-work added the enhancement New feature or request label Jun 24, 2024
@nils-work nils-work self-assigned this Jun 24, 2024
@nils-work nils-work added this to the v1.32.0 milestone Jul 5, 2024
@nils-work nils-work mentioned this issue Jul 5, 2024
Closed
@nils-work
Copy link
Member Author 

- Products that are no long offered
+ Products that are no longer offered

nils-work added a commit that referenced this issue Aug 27, 2024
@nils-work
Fixed typos
1237677 
Addresses: #411
@nils-work nils-work mentioned this issue Aug 27, 2024
Merged
@nils-work
Copy link
Member Author

Standardise end point to endpoint and end points to endpoints as noted in this issue.

nils-work added a commit that referenced this issue Aug 28, 2024
@nils-work
Endpoint as one word
218d2d0 
Addresses: #411 (comment) and ConsumerDataStandardsAustralia/standards-maintenance#527 (comment)
@nils-work
Copy link
Member Author

Correct the subtitle of the Common APIs section:

- This specification defines the Common APIs that apply to Data Holders multiple sectors.
+ This specification defines the Common APIs that apply to Data Holders in all sectors.

@nils-work
Copy link
Member Author

Correct the subtitle of the Admin APIs section:

- This provides an overview of CDS Administration Endpoints. Please note this API is intended for Data Holders/ Recipients only.
+ This specification defines the Admin APIs that apply to Data Holders.

@nils-work
Copy link
Member Author

Update the description of the Product Categories section:

- The Product Category enumeration lists the available product categories for categorising products and accounts.
+ The productCategory enumeration provides the values for categorising products and accounts.

nils-work added a commit that referenced this issue Aug 28, 2024
@nils-work
Update description of Product Categories section
7ae6166 
Addresses: #411 (comment)
@nils-work
Copy link
Member Author

Fix link to default file for local build testing (insert index.html) -

- A table-view of all endpoint versioning is available <a href='includes/endpoint-version-schedule/#endpoint-version-schedule'>here</a>.
+ A table-view of all endpoint versioning is available <a href='includes/endpoint-version-schedule/index.html#endpoint-version-schedule'>here</a>.

@nils-work
Copy link
Member Author

Most endpoints refer to the 400 - Missing Field error code.
The title of this error code, as stated in the Error Codes section, should be '400 - Missing Required Field'.

nils-work added a commit that referenced this issue Sep 17, 2024
@nils-work
Corrected error title
5defa97 
Addresses: #411 (comment)
nils-work added a commit that referenced this issue Oct 21, 2024
@nils-work
Merge pull request #422 from ConsumerDataStandardsAustralia/defect/411
2949db4 
Staging #411 - Fixed typos
nils-work added a commit to ConsumerDataStandardsAustralia/standards that referenced this issue Oct 21, 2024
@nils-work @markverstege @HemangCDR
Release/1.32.0 (#358)
2a69040 
* Created 1.32.0 branch base

* Updated to newer openapi-generator-cli

Added new jar and removed older jars

* Merged the Change Log and Archives sections

Addresses: ConsumerDataStandardsAustralia/standards-staging#413

* Retaining original anchors

* Fixed spelling mistake for authorization_code reference. Addresses issue comment ConsumerDataStandardsAustralia/standards-maintenance#647 (comment)

* Removed redundant statement regarding client ID. Addresses issue ConsumerDataStandardsAustralia/standards-maintenance#647 (comment)

* Corrected field description for tariffUType. Addresses issue ConsumerDataStandardsAustralia/standards-maintenance#647 (comment)

* Updated URIString example to use HTTPS scheme rather than HTTP. Addresses issue ConsumerDataStandardsAustralia/standards-maintenance#647 (comment)

* Update details in Common Field Types section

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#641

* Clarified the format of adjustment rate values

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#641

* Fixed typos

Addresses: ConsumerDataStandardsAustralia/standards-staging#411

* Endpoint as one word

Addresses: ConsumerDataStandardsAustralia/standards-staging#411 (comment) and ConsumerDataStandardsAustralia/standards-maintenance#527 (comment)

* Corrected required properties

Addresses: ConsumerDataStandardsAustralia/standards-staging#417

* Add version delta comment and removed line breaks

* #418 - Add CX guidelines link to footer

Addresses: ConsumerDataStandardsAustralia/standards-staging#418

* Update Common and Admin APIs descriptions

* Staging #419 - Update field name styling

Addresses: ConsumerDataStandardsAustralia/standards-staging#419

* Update description of Product Categories section

Addresses: ConsumerDataStandardsAustralia/standards-staging#411 (comment)

* Staging #426 - Corrected OAS, moved files

Addresses: ConsumerDataStandardsAustralia/standards-staging#426

* Fixed typos

* Standards Maintenance Issue #652: Updated description of AmountString field clarifying the currency format and noting it defaults to AUD

* adding 'and'

for one hundred 'and' twenty-three dollars

* Minor update to styling and wording

* Fix link for local build testing

* Added x-version-notes and x-diff custom extension keys. x-version-notes allows capturing API version notes. x-diff allows capturing diff statements against specific API or schemas

* Standards Maintenance Issue #653: Amended description of dailySupplyChargeType field

* Standards Maintenance Issue #653: Fixed incorrect diff statement

* Staging #438 - Improve code samples

Addresses: ConsumerDataStandardsAustralia/standards-staging#438

* Version delta and release notes

* Staging #437 - Remove Known Issues

Addresses: ConsumerDataStandardsAustralia/standards-staging#437

* Corrected error title

Addresses: ConsumerDataStandardsAustralia/standards-staging#411 (comment)

* Update _errors.md

* Corrected quotes in JSON samples

* Added Register Base URLs to spec

* Updated links

* Added TLS changes to align with BCP 195 and FAPI 2.0. Addresses issue: ConsumerDataStandardsAustralia/standards-maintenance#648

* Removed x-diff custom key from json swagger. Moved diff statement into energy erb file

* BCP195 as one word, bolded key words

* Update "account id" to "accountId"

* Removed bold styling

* Update to validation version only

Clearly distinguishing the specific JAR versions used in each step of the build process and updated to the newer JAR for validation only.

* Reverted non-RateString changes

* Updated notes

* Update issue title

* Resolve release notes and change log

* 1.32.0 build for Staging

* Build 1.32.0

---------

Co-authored-by: Mark Verstege <[email protected]>
Co-authored-by: Hemang Rathod <[email protected]>
@nils-work
Copy link
Member Author

Incorporated into Standards v1.32.0

@nils-work nils-work mentioned this issue Oct 22, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nils-work nils-work

Labels
enhancement New feature or request
Projects
None yet
Milestone
v1.32.0
Development

No branches or pull requests
1 participant
@nils-work