ConsumerDataStandardsAustralia / standards-maintenance

This repository houses the interactions, consultations and work management to support the maintenance of baselined components of the Consumer Data Right API Standards and Information Security profile.
41 stars 9 forks source link

Maintenance Iteration 20 Holistic Feedback #647

Closed CDR-API-Stream closed 1 month ago

CDR-API-Stream commented 4 months ago

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 commented 4 months ago

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 commented 4 months ago

Documentation updates:

nils-work commented 4 months ago

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 commented 4 months ago

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 commented 4 months ago

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:

nils-work commented 4 months ago

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 commented 4 months ago

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

markverstege commented 2 months ago

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: https://github.com/ConsumerDataStandardsAustralia/standards-staging/commit/59db12da27f91a7cc868037c50426ac408987292

markverstege commented 2 months ago

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: https://github.com/ConsumerDataStandardsAustralia/standards-staging/commit/0f6604bed1811a6d755af89342da953d58da1741

markverstege commented 2 months ago

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: https://github.com/ConsumerDataStandardsAustralia/standards-staging/commit/53c9ace73285cbe10eff1c3e6dfb218d777368c7

markverstege commented 2 months ago

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: https://github.com/ConsumerDataStandardsAustralia/standards-staging/commit/9c0ae785111ec513ba4f693ab73383356c60d89d

nils-work commented 2 months ago

Documentation updates:

These have been staged -

nils-work commented 2 months ago

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 commented 2 months ago

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 commented 1 month ago

Incorporated into Standards v1.32.0.