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.

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

Maintenance Iteration 20 Holistic Feedback #647

Closed
CDR-API-Stream opened this issue Jun 27, 2024 · 15 comments
Closed

Maintenance Iteration 20 Holistic Feedback #647

CDR-API-Stream opened this issue Jun 27, 2024 · 15 comments
Labels
Non-breaking change A change that is not expected to result in a new endpoint version.
Milestone

Comments

@CDR-API-Stream
Copy link
Collaborator

This change request has been created to simplify the raising of minor changes, such as text corrections or description clarifications, that are not really material to the standards but do have a real impact on readability and clarity.

Please raise any such suggestions that you would like included in Maintenance Iteration 20 on this issue and the DSB will review them. If a suggestion is a material change a dedicated CR will be raised.

@nils-work nils-work added the Non-breaking change A change that is not expected to result in a new endpoint version. label Jul 1, 2024
@nils-work
Copy link
Member

nils-work commented Jul 1, 2024

In the section Data Recipients calling Data Holders, the first bullet point appears to be redundant and could be removed - the second point seems to state the same requirement more clearly (change highlighted here).

There is a typo in the first sentence of the third point. Make the following change:

- authorisation_code
+ authorization_code

@nils-work
Copy link
Member

@nils-work
Copy link
Member

In the Security Profile section > Data Recipients calling Data Holders, the requirements in the first two bullet points appear to be repeated. The highlighted text in the statements is identical:

image

The proposal is to remove the first bullet point:

  • The client ID represents the ID issued to the Data Recipient Software Product by the Data Holder upon successful dynamic client registration.

@nils-work
Copy link
Member

There appears to be a copy/paste error in the description of the tariffUType field in the EnergyPlanSolarFeedInTariffV3 schema:

- The type of the payer
+ Reference to the applicable tariff structure.

@nils-work
Copy link
Member

The "Reference to the applicable [type] structure." convention could be applied to all ...UType field descriptions for consistency and clarity of interpretation.

The following sample shows the current variation across schemas:

  • The type of recurrence used to define the schedule.
  • The type of structure to present account specific fields.
  • Indicator of the type of transaction object present in this record
  • The type of address object present
  • The type of object present in this response (from EnergyPaymentSchedule)
  • Type of object included that describes the payee in detail.
  • The type of customer object that is present
  • Type of account object included.

@nils-work
Copy link
Member

In the Common Field Types section, change the value in the Valid Examples column for the URIString type:

- "http://www.google.com"
+ "https://www.example.com"

@nils-work
Copy link
Member

A documentation change has also been posted on the Staging repository: #413 - Merge Change Log and Archives sections

@markverstege
Copy link
Member

In the section Data Recipients calling Data Holders, the first bullet point appears to be redundant and could be removed - the second point seems to state the same requirement more clearly (change highlighted here).

There is a typo in the first sentence of the third point. Make the following change:

- authorisation_code
+ authorization_code

This issue has been staged for review: ConsumerDataStandardsAustralia/standards-staging@59db12d

@markverstege
Copy link
Member

markverstege commented Sep 3, 2024

In the Security Profile section > Data Recipients calling Data Holders, the requirements in the first two bullet points appear to be repeated. The highlighted text in the statements is identical:

image

The proposal is to remove the first bullet point:

  • The client ID represents the ID issued to the Data Recipient Software Product by the Data Holder upon successful dynamic client registration.

This issue has been staged for review: ConsumerDataStandardsAustralia/standards-staging@0f6604b

@markverstege
Copy link
Member

In the Common Field Types section, change the value in the Valid Examples column for the URIString type:

- "http://www.google.com"
+ "https://www.example.com"

This issue has been staged for review: ConsumerDataStandardsAustralia/standards-staging@53c9ace

@markverstege
Copy link
Member

There appears to be a copy/paste error in the description of the tariffUType field in the EnergyPlanSolarFeedInTariffV3 schema:

- The type of the payer
+ Reference to the applicable tariff structure.

This issue has been staged for review: ConsumerDataStandardsAustralia/standards-staging@9c0ae78

@nils-work
Copy link
Member

@nils-work
Copy link
Member

The "Reference to the applicable [type] structure." convention could be applied to all ...UType field descriptions for consistency and clarity of interpretation.

The following sample shows the current variation across schemas:

  • The type of recurrence used to define the schedule.
  • The type of structure to present account specific fields.
  • Indicator of the type of transaction object present in this record
  • The type of address object present
  • The type of object present in this response (from EnergyPaymentSchedule)
  • Type of object included that describes the payee in detail.
  • The type of customer object that is present
  • Type of account object included.

This will be deferred to a later MI - #434 - Apply consistent UType field descriptions

@nils-work
Copy link
Member

A documentation change has also been posted on the Staging repository: #413 - Merge Change Log and Archives sections

This has been staged - Merged the Change Log and Archives sections

nils-work added a commit to ConsumerDataStandardsAustralia/standards that referenced this issue Oct 21, 2024
* 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

Incorporated into Standards v1.32.0.

@github-project-automation github-project-automation bot moved this from Awaiting Chair Approval to Done in Data Standards Maintenance Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Non-breaking change A change that is not expected to result in a new endpoint version.
Projects
Status: Done
Development

No branches or pull requests

3 participants