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 15 Holistic Feedback #586

Closed CDR-API-Stream closed 1 year ago

CDR-API-Stream commented 1 year 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 15 and the DSB will review them. If a suggestion is a material change a dedicated CR will be raised.

HemangCDR commented 1 year ago

Following energy APIs should be listed with the POST instead of GET method in the endpoint version schedule:

CDR-API-Stream commented 1 year ago

The following hygiene tasks are planned for this iteration:

markverstege commented 1 year ago

Following energy APIs should be listed with the POST instead of GET method in the endpoint version schedule:

  • Get Usage For Specific Service Points
  • Get Balances For Specific Energy Accounts

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

Note it is compared against the previous release. At present no draft 1.25.0 release has been staged but it is expected this change will target 1.25.0 for release at the end of maintenance iteration 15.

markverstege commented 1 year ago

The following hygiene tasks are planned for this iteration:

  • Clean up the future dated obligations table where obligations are greater than six months in the past.
  • Clean up of FAPI 1.0 references. This has been broken out as a standalone CR. See Remove FAPI 1.0 draft references #590

The clean up of future dated obligations has been staged for review: https://github.com/ConsumerDataStandardsAustralia/standards-staging/commit/2083b3f79839dde868584392e60bb72e66f26755

Note it is compared against the previous release. At present no draft 1.25.0 release has been staged but it is expected this change will target 1.25.0 for release at the end of maintenance iteration 15.

markverstege commented 1 year ago

Add the CDR Register hosted "Get Data Holder Brands Summary" API into the Endpoint Version Schedule.

markverstege commented 1 year ago

Add the CDR Register hosted "Get Data Holder Brands Summary" API into the Endpoint Version Schedule.

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

The Data Holder APIs have been grouped together for readability.

nils-work commented 1 year ago

There are two minor typos in the Endpoint Version Schedule introductory text:

Binding Date indicates the dates date the particular version of an endpoint becomes binding in the data standards.

Retirement Date indicates, where relevant, denotes the date a specific version can be retired and is no longer supported. All consumers of the affected endpoint must upgrade to a more recent version currently available.

markverstege commented 1 year ago

There are two minor typos in the Endpoint Version Schedule introductory text:

Binding Date indicates the ~dates~ date the particular version of an endpoint becomes binding in the data standards.

Retirement Date indicates, where relevant, ~denotes~ the date a specific version can be retired and is no longer supported. All consumers of the affected endpoint must upgrade to a more recent version currently available.

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

nils-work commented 1 year ago

For consistency with the Standards, consider the following Endpoint Version Schedule 'Section' name updates:

markverstege commented 1 year ago

For consistency with the Standards, consider the following Endpoint Version Schedule 'Section' name updates:

  • change InfoSec Profile to Security Profile in three places
  • change CDR Register APIs to Register APIs in the title and rows of that table.

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

nils-work commented 1 year ago

There's a typo in this line in the FDO section -

This applies to ADRs and the CDR Register authenticating with Data Holders and ADRs authenticating with the CDR Regsiter.

markverstege commented 1 year ago

There's a typo in this line in the FDO section -

This applies to ADRs and the CDR Register authenticating with Data Holders and ADRs authenticating with the CDR Regsiter.

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

nils-work commented 1 year ago

Correct the typo in this text in the introduction of the Get Products endpoint -

and one refers to an account that actual actually has been instantiated

perlboy commented 1 year ago

Add note that AER hosted APIs are currently non-compliant with any version of Get Generic Plan Detail. Not putting a note to this effect makes the published standards in the area of Generic Plan detail very misleading.

markverstege commented 1 year ago

Correct the typo in this text in the introduction of the Get Products endpoint -

and one refers to an account that ~actual~ actually has been instantiated

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

nils-work commented 1 year ago

Standards version 1.25.0 has now been published, incorporating this set of changes.