Iteration 13 Holistic Feedback

[CDR-API-Stream]

This CR 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 real impact of readability and clarity.

Please raise any such suggestions that you would like included in Maintenance Iteration 13 and the DSB will review them. If we believe the suggestion are material we will raise a dedicated CR for them.

[CDR-API-Stream]

Update the description of accountCharges in EnergyInvoice to clarify that it is for account level charges and credits

[perlboy]

readQualities for usage is being described as an Object when it isn't:

This should be an array of objects because it is possible for there to be multiple sets of read qualities over a sampling period.

[nils-work]

A missing font reference appears to have some impact on the Standards page rendering time.
Detail is in ConsumerDataStandardsAustralia/standards-staging#235

[nils-work]

Two broken links in Register APIs documentation
ConsumerDataStandardsAustralia/standards-staging#234

[nils-work]

The first sentence in the Register APIs section of the Standards states -

This following provides an overview of the Register APIs for Data Holders and Data Recipients to collect participant metadata exclusively for the banking sector. These endpoints are exposed by the Register and consumed by Data Holders and Data Recipients.

It should be updated to -

The following section provides an overview of the Register APIs for Data Holders and Data Recipients to collect participant metadata.

[nils-work]

Links referencing TDIF should be updated to the new site - https://www.digitalidentity.gov.au/tdif

[nils-work]

Apart from the FDO table where some historical dates are maintained for reference, the Amending Authorisation Standards section repeats that the amending standards are Effective from November 2021.
As this is now almost 12 months past, it may be appropriate to remove this specific mention.

[nils-work]

Consider extending the list of applicable endpoints in the CORS section to include the unauthenticated endpoints for Energy (and Telco?) or move the endpoint designation into the respective endpoint definitions so it doesn't need to be maintained separately.
Another alternative may be to clarify that all unauthenticated endpoints require CORS, but this may not always be the case.

[nils-work]

The endpoints in the Energy Secondary DH APIs section all incorrectly state This operation does not require authentication.
These should be updated to something like This operation may only be called by Energy Primary Data Holders.

[CDR-API-Stream]

readQualities for usage is being described as an Object when it isn't:

This should be an array of objects because it is possible for there to be multiple sets of read qualities over a sampling period.

This defect was fixed in version 1.20.0 release of the standards.

[nils-work]

One additional documentation fix that may warrant late inclusion for MI13 is a typo in this statement in the Version Delta alongside HTTP Headers -
Clarified that the x-fapi-interaction-id is not required for authenticated resource APIs
It should state unauthenticated -
Clarified that the x-fapi-interaction-id is not required for unauthenticated resource APIs

[nils-work]

These items were delivered through ConsumerDataStandardsAustralia/standards#272 (comment)