From a7e49d31160ec5283b09ae85881f78c4a9fa54bc Mon Sep 17 00:00:00 2001 From: James Bligh <40985476+JamesMBligh@users.noreply.github.com> Date: Thu, 18 Jan 2024 15:13:32 +1100 Subject: [PATCH] Update to known issues to highlight typo in 1.29.0 (#341) * Create clean version of release 1.29.0 * Added releasenotes file for 1.29.0 * Added redirect_uri * Update CX Guidlines link * Removed amending authz * added RFC7636 to refs * Updated Intro DSB link * Differences in naming of Register endpoints * Added obligation schedule to FDO * Updated desc of minimumValue maximumValue unitOfMeasure * Updated markdown of minimumValue maximumValue unitOfMeasure * Added missing fields for PAID_OUT_AT_MATURITY ROLLED_OVER for maturityInstructions * Updated definition of Number in common field types * Updated descriptions on ErrorMetricsV2 * Modified URL in line with request example * url encoded * Retain Version Delta for Additional Standards Re-added the 1.28.0 Version Delta comments for the Candidate and Draft Standards recently updated and still under consultation in 1.29.0. * Added authorization_signed_response_alg & authorization_encrypted_response_alg as conditional * Resolve link and navigation issues Addresses: https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/222 * Switch tracking and add Standards category ribbon Addresses: https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/334, https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/332 * Corrected minor typos only Addresses typos: https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/312 * Remove resource name to reduce length + complexity Addresses: https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/222 * Added end & * Removed FDO Obligation date from Amending authorisation * Created a single link for [PKCE] / [RFC7636] * Standards Maintenance Issue #587: Added new field measureUnit in EnergyBillingDemandTransaction * Adjust heading levels and add navigation classes Addresses: https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/338 * Identifying superseded versions in obsolete path Addresses: https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/334 * Business Consumer Provisions Addresses: https://github.com/ConsumerDataStandardsAustralia/standards/issues/333 * Added link to change description * Added link to change description * Standards Maintenance Issue #587: Fixed typos. Re-arranged order of api versions for consistency * Add style to override class for CX submenu items * Added Data Holder Dashboards section Addresses: https://github.com/ConsumerDataStandardsAustralia/standards/issues/334 * Added link to issue * Added issue link to description * Added issue link to description * Updated with data attribute to apply CSS * Updated with data attribute * Added FDO details * Standards Maintenance Issue #613: Changed type of time fields in energy plan data to ExternalRef referring to ISO 8601 Times specification * Standards Maintenance Issue #613: Changed description of affected time fields for clarity. * Standards Maintenance Issue #587: Fixed typos * Standards Maintenance Issue #587: Fixed typo in FDO table * Retaining majority of useful original anchors Addresses: https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/222 * Display the x-cds-type for array items Addresses: https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/348 * Show format of request parameter enums correctly Addresses: https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/349 * Adding release notes and delta comments Update for: https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/348 * Update to release notes and NBL version delta * Remove last diffs * Moving NBL Draft to Candidate Standards Addresses: https://github.com/ConsumerDataStandardsAustralia/standards/issues/318 * Rebuild * Add FDO diff statement for 587 * Add diff statements and release notes * Add diff and release notes * Add release note reference to CR620 * Add release notes * Add santa hat * Update release date * Fix release notes Update obligation date counts * Corrected typo * Add MI 17 DP to release notes Addresses: https://github.com/ConsumerDataStandardsAustralia/standards/issues/328 * Updated links * Updated dates * Added deprecation dates * Corrected typo * Rebuild * Update change log with DP328 * Standards Staging Issue #359: Known Issues table updated noting incorrect version of Energy Billing APIs * Updated to known issues --------- Co-authored-by: Hemang Rathod Co-authored-by: kirkycdr Co-authored-by: Nils Berge <60594671+nils-work@users.noreply.github.com> --- .../additional20240118-34355-ehy0fg | 27 +++++++++++++++++++ docs/includes/known-issues | 7 ++++- docs/index.html | 7 ++++- slate/source/includes/known-issues.md | 5 ++++ 4 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 docs/includes/additional/additional20240118-34355-ehy0fg diff --git a/docs/includes/additional/additional20240118-34355-ehy0fg b/docs/includes/additional/additional20240118-34355-ehy0fg new file mode 100644 index 00000000..ce2c083a --- /dev/null +++ b/docs/includes/additional/additional20240118-34355-ehy0fg @@ -0,0 +1,27 @@ +

Additional Standards

The Draft Non-Bank Lending Standards have been made as Candidate Standards -
++ Candidate Standards for the Banking and Non-Bank Lending sector
+- Draft Standards for the Banking and Non-Bank Lending sector
+
+Added a red ribbon below the CDS logo on different Standards versions to visually distinguish them from the binding version
+
+

The Consumer Data Standards also incorporate other non-binding standards that are developed to facilitate consultation and feedback or to facilitate voluntary extension of CDR implementations.

+ +

These standards fall into three categories:

+ +
    +
  1. Candidate standards that are non-binding and stable
    2. +
  2. Draft standards that are non-binding but volatile as they are under development
    3. +
  3. Experimental standards that are transient and created to test concepts
    4. +
+

Candidate Standards

+

The Consumer Data Standards currently include the following Candidate Standards:

+ + +

Draft Standards

+

The Consumer Data Standards do not currently include any Draft Standards.

+

Experimental Standards

+

The experimental standards developed by the Data Standards Body are developed in this GitHub repository and are published here.

diff --git a/docs/includes/known-issues b/docs/includes/known-issues index 6d881124..e6d2f087 100644 --- a/docs/includes/known-issues +++ b/docs/includes/known-issues @@ -1,4 +1,5 @@ -

Known Issues

+

Known Issues

Incorrect version of `Get Bulk Billing` and `Get Billing For Specific Accounts` Energy APIs noted in Known Issues table
+

There are certain aspects of the standards that are actively under review. These known issues are articulated in the following table.

@@ -19,6 +20,10 @@ + + + +
DCR and Register Swagger naming conventions The DCR and Register naming conventions are not consistent with the broader data standards. Field names should be standardised to camelCase and snake_case inline with the data standards
Incorrect version of Energy Billing APIsThe version of Get Bulk Billing and Get Billing For Specific Accounts Energy APIs is incorrectly noted as 2 in v1.29.0 of the standards. The correct version should be 3.

Future improvements

The following improvements will be incorporated into future versions of the Standards

diff --git a/docs/index.html b/docs/index.html index 490c1346..4c887cf1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -55599,7 +55599,8 @@

Draft Standards

Experimental Standards

The experimental standards developed by the Data Standards Body are developed in this GitHub repository and are published here.

-

Known Issues

+

Known Issues

Incorrect version of `Get Bulk Billing` and `Get Billing For Specific Accounts` Energy APIs noted in Known Issues table
+

There are certain aspects of the standards that are actively under review. These known issues are articulated in the following table.

@@ -55620,6 +55621,10 @@

Known Issues

+ + + +
DCR and Register Swagger naming conventions The DCR and Register naming conventions are not consistent with the broader data standards. Field names should be standardised to camelCase and snake_case inline with the data standards
Incorrect version of Energy Billing APIsThe version of Get Bulk Billing and Get Billing For Specific Accounts Energy APIs is incorrectly noted as 2 in v1.29.0 of the standards. The correct version should be 3.

Future improvements

The following improvements will be incorporated into future versions of the Standards

diff --git a/slate/source/includes/known-issues.md b/slate/source/includes/known-issues.md index fbaec268..c6b82494 100644 --- a/slate/source/includes/known-issues.md +++ b/slate/source/includes/known-issues.md @@ -1,5 +1,9 @@ # Known Issues +```diff +Incorrect version of `Get Bulk Billing` and `Get Billing For Specific Accounts` Energy APIs noted in Known Issues table +``` + There are certain aspects of the standards that are actively under review. These known issues are articulated in the following table. @@ -9,6 +13,7 @@ Issue | Description Register APIs use local version of common definitions | The Register APIs use a locally defined version of common schema definitions such as `ResponseErrorList` for error responses. These need to be updated to reference common swagger specifications inherited by the Common Swagger spec. Register APIs use different field type definitions | The Register APIs define their own field types that are not consistent with the [Common Field Types](#common-field-types) defined in the data standards. As part of porting the Register standards across to the primary data standards, the field types need to be re-aligned to use the common field type definitions. For example, `string (data-time)` should be changed to `DataTime` and `integer(int32)` should be changed to `PositiveInteger`. DCR and Register Swagger naming conventions | The DCR and Register naming conventions are not consistent with the broader data standards. Field names should be standardised to camelCase and snake_case inline with the data standards +Incorrect version of Energy Billing APIs | The version of `Get Bulk Billing` and `Get Billing For Specific Accounts` Energy APIs is incorrectly noted as 2 in v1.29.0 of the standards. The correct version should be 3. ## Future improvements