Maintenance Iteration 16 Holistic Feedback

[CDR-API-Stream]

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 16 and the DSB will review them. If a suggestion is a material change a dedicated CR will be raised.

[HemangCDR]

• Remove duplicate 400 - Invalid Version from Banking API Responses (see example below):
• Add 400 - Invalid Date in Energy API Responses that have DateTimeString, DateString, and TimeString field type query parameters

[nils-work]

The V1.25.0 Release Notes page doesn't mention the following issues that were part of that release. For future reference, the page should be updated.

These should have been included under the Change Requests section from Standards Maintenance and the appropriate sections:

• Standards Maintenance Issue 413 - 400 Error code missing in swagger for some endpoints
• Standards Maintenance Issue 575 - Inconsistency of data types in various schema
• Standards Maintenance Issue 585 - Clarify Base and Adjustment Rate Types

API endpoints Standards Maintenance #413: Added missing error response codes. Standards Maintenance #585: Split the 'Product & Account Components' tables that provide more detail on the 'Product Deposit Rate Types' and 'Product Lending Rate Types' into Base Rate Types and Adjustment Rate Types.

Register Standards Standards Maintenance #575: Updated a number of headers to use more consistent types.

[nils-work]

The link in this text under Informative References:

Consumer Data Right: http://cdr.gov.au/

Should be updated to: https://www.cdr.gov.au/

[nils-work]

Changes for the following Staging and Telco Documentation fixes are staged here for review. There was also an update that included splitting out the changes for 595.

Issues:

• Telco 'other versions' fix
• #236 - Broken links to sections of the standards (anchors)
• #253 - Apply consistent month name format
• #256 - Typos in archived Register API versions
• #268 - Remove character in aud description
• #270 - Get Accounts V1 link in FDO
• #271 - Typos in Get Transactions For Account parameters
• #280 - Typo in Account Detail bundleName description

[nils-work]

Fix incorrect spelling of 'registeration' in the registeredCountry field in LegalEntityDetail.

[perlboy]

The endpoint versioning schedule is incorrect for the CDR Arrangement Revocation End Point.

[perlboy]

Multiple descriptions have copy/paste errors in regards to Gas. E.g.:

[ACCC-CDR]

Effective from 21 September 2023, the ACCC will retire the following Register API versions:

• Get Data Holder Brands (V1)
• Get Software Statement Assertion (V1 and V2)
• Get Software Products Statues (V1)
• Get Data Recipients Statues (V1)
• Get Data Recipients (V1 and V2)

These API versions were deprecated by the Data Standards Body on 23 December 2021. After retirement, any calls to these versions will result in a 406 Unsupported Version error.

On the retirement date the x-v header will change from optional to mandatory. This change was discussed in issue 544 and determined that the standards would be updated once a retirement date was set. Now that the retirement date has been set can the CDS be updated to make 'x-v' header mandatory for:

• Get Data Holder Brands
• Get Software Statement Assertion
• Get Software Products Statues
• Get Data Recipients Statues
• Get Data Recipients

[nils-work]

The authorisations property in Get Metrics v4 and v5 is marked as optional. This may have been intended to be mandatory as per most other top-level properties.

[perlboy]

For the new Energy endpoints mandated for November 1, there does not appear to be an allowance for new entrants into the ecosystem (i.e. Tranche 3 launching November 1) to not implement the previous versions, notably Get Energy Account Detail V2. Is this intentional? If not, can the Standards be clarified that new Holders are not required to deliver the old endpoint?

[nils-work]

Typo in two instances of this text - String containing a role of the software in the CDR Regime. Initially the only value used with be

It should end ...will be

[nils-work]

The link in this text under Informative References:

Consumer Data Right: http://cdr.gov.au/

Should be updated to: https://www.cdr.gov.au/

This change has been staged for review: https://github.com/ConsumerDataStandardsAustralia/standards-staging/commit/97befb570f82f3c274e6aae2d6062c830f6f8499

[nils-work]

Fix incorrect spelling of 'registeration' in the registeredCountry field in LegalEntityDetail.

This change has been staged for review: https://github.com/ConsumerDataStandardsAustralia/standards-staging/commit/85781a30f1a707912a0147e616e29c641e7ba3dc

[nils-work]

The V1.25.0 Release Notes page doesn't mention the following issues that were part of that release. For future reference, the page should be updated.

These should have been included under the Change Requests section from Standards Maintenance and the appropriate sections:

• Standards Maintenance Issue 413 - 400 Error code missing in swagger for some endpoints
• Standards Maintenance Issue 575 - Inconsistency of data types in various schema
• Standards Maintenance Issue 585 - Clarify Base and Adjustment Rate Types

API endpoints Standards Maintenance #413: Added missing error response codes. Standards Maintenance #585: Split the 'Product & Account Components' tables that provide more detail on the 'Product Deposit Rate Types' and 'Product Lending Rate Types' into Base Rate Types and Adjustment Rate Types.

Register Standards Standards Maintenance #575: Updated a number of headers to use more consistent types.

A fix for this issue comment has been staged for review: https://github.com/ConsumerDataStandardsAustralia/standards-staging/commit/3686ab7fcac1c208cc5396087a052a46c612edaa

[nils-work]

Typo in two instances of this text - String containing a role of the software in the CDR Regime. Initially the only value used with be

It should end ...will be

A fix for this issue comment has been staged for review: https://github.com/ConsumerDataStandardsAustralia/standards-staging/commit/2e6091865bb3f5a2c078239601bafb52260abd44

[anzbankau]

The AuthorisationMetricsv2 has 3 additional chevron symbols (denoting indentation) from the revokedAuthorisationCount onwards. See the structure in the example.

[nils-work]

The AuthorisationMetricsv2 has 3 additional chevron symbols (denoting indentation) from the revokedAuthorisationCount onwards. See the structure in the example.

Thanks @anzbankau, I think this seems to be the same issue that was noted here - https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/196

[nils-work]

Multiple descriptions have copy/paste errors in regards to Gas. E.g.:

A fix for this issue comment has been staged for review: https://github.com/ConsumerDataStandardsAustralia/standards-staging/commit/bae9f3ec656de3af9cfe543af378e738d1e94214

[nils-work]

The authorisations property in Get Metrics v4 and v5 is marked as optional. This may have been intended to be mandatory as per most other top-level properties.

A fix for this issue comment has been staged for review: https://github.com/ConsumerDataStandardsAustralia/standards-staging/commit/fa3d92404e5ec6b65cb20994eee7c35fb5c69481

[nils-work]

• Remove duplicate 400 - Invalid Version from Banking API Responses (see example below):
• Add 400 - Invalid Date in Energy API Responses that have DateTimeString, DateString, and TimeString field type query parameters

A fix for this issue comment has been staged for review: https://github.com/ConsumerDataStandardsAustralia/standards-staging/commit/62aa07185c8dac313d6c1b7c8a7d1f0b5f0c103e

[nils-work]

The [FAPI-RW-Draft] link in the Security Endpoints section is broken and should be updated to refer to [FAPI-1.0-Advanced]

[nils-work]

The endpoint versioning schedule is incorrect for the CDR Arrangement Revocation End Point.

Hi @perlboy Thanks for this, it looks like there could be a few older versions that may be worth noting in that section. If we can't get all the version and date details together before the upcoming release, a fix for this will be carried into the next maintenance iteration.

[nils-work]

The [FAPI-RW-Draft] link in the Security Endpoints section is broken and should be updated to refer to [FAPI-1.0-Advanced]

A fix for this issue comment has been staged for review: https://github.com/ConsumerDataStandardsAustralia/standards-staging/commit/d6b3b6cdcaaa25206aaf0fce135e56756d107658

[nils-work]

• Telco 'other versions' fix

A fix for this issue comment has been staged for review: https://github.com/ConsumerDataStandardsAustralia/standards-staging/commit/29656cdb12787479bcf73570d21b924fa5eb8ea1

[nils-work]

For the new Energy endpoints mandated for November 1, there does not appear to be an allowance for new entrants into the ecosystem (i.e. Tranche 3 launching November 1) to not implement the previous versions, notably Get Energy Account Detail V2. Is this intentional? If not, can the Standards be clarified that new Holders are not required to deliver the old endpoint?

A fix for this issue comment has been staged for review: https://github.com/ConsumerDataStandardsAustralia/standards-staging/commit/74781ac5f5e07564d2e3bdb741a0893adc5e790a

[nils-work]

Effective from 21 September 2023, the ACCC will retire the following Register API versions:

• Get Data Holder Brands (V1)
• Get Software Statement Assertion (V1 and V2)
• Get Software Products Statues (V1)
• Get Data Recipients Statues (V1)
• Get Data Recipients (V1 and V2)

These API versions were deprecated by the Data Standards Body on 23 December 2021. After retirement, any calls to these versions will result in a 406 Unsupported Version error.

On the retirement date the x-v header will change from optional to mandatory. This change was discussed in issue 544 and determined that the standards would be updated once a retirement date was set. Now that the retirement date has been set can the CDS be updated to make 'x-v' header mandatory for:

• Get Data Holder Brands
• Get Software Statement Assertion
• Get Software Products Statues
• Get Data Recipients Statues
• Get Data Recipients

A fix for this issue comment has been staged for review: https://github.com/ConsumerDataStandardsAustralia/standards-staging/commit/97f27ac9988f05c4c06980a9c9f1ffdc1f46bad7

[nils-work]

These changes have been incorporated into version 1.27.0