Skip to content

Commit

Permalink
Update to known issues to highlight typo in 1.29.0 (#341)
Browse files Browse the repository at this point in the history
* 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: ConsumerDataStandardsAustralia/standards-staging#222

* Switch tracking and add Standards category ribbon

Addresses: ConsumerDataStandardsAustralia/standards-staging#334, ConsumerDataStandardsAustralia/standards-staging#332

* Corrected minor typos only

Addresses typos: ConsumerDataStandardsAustralia/standards-staging#312

* Remove resource name to reduce length + complexity

Addresses: ConsumerDataStandardsAustralia/standards-staging#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: ConsumerDataStandardsAustralia/standards-staging#338

* Identifying superseded versions in obsolete path

Addresses: ConsumerDataStandardsAustralia/standards-staging#334

* Business Consumer Provisions

Addresses: #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: #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: ConsumerDataStandardsAustralia/standards-staging#222

* Display the x-cds-type for array items

Addresses: ConsumerDataStandardsAustralia/standards-staging#348

* Show format of request parameter enums correctly

Addresses: ConsumerDataStandardsAustralia/standards-staging#349

* Adding release notes and delta comments

Update for: ConsumerDataStandardsAustralia/standards-staging#348

* Update to release notes and NBL version delta

* Remove last diffs

* Moving NBL Draft to Candidate Standards

Addresses: #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: #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 <hemang.rathod@consumerdatastandards.gov.au>
Co-authored-by: kirkycdr <brian.kirkpatrick@consumerdatastandards.gov.au>
Co-authored-by: Nils Berge <60594671+nils-work@users.noreply.github.com>
  • Loading branch information
4 people committed Jan 18, 2024
1 parent d03fc70 commit a7e49d3
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 2 deletions.
27 changes: 27 additions & 0 deletions docs/includes/additional/additional20240118-34355-ehy0fg
@@ -0,0 +1,27 @@
<h1 id='additional-standards'>Additional Standards</h1><pre class="highlight diff tab-diff"><code>The Draft Non-Bank Lending Standards have been made as Candidate Standards -
<span class="gi">+ Candidate Standards for the Banking and Non-Bank Lending sector
</span><span class="gd">- Draft Standards for the Banking and Non-Bank Lending sector
</span>
Added a red ribbon below the CDS logo on different Standards versions to visually distinguish them from the binding version
</code></pre>
<p>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.</p>

<p>These standards fall into three categories:</p>

<ol>
<li><code>Candidate</code> standards that are non-binding and stable</li>
<li><code>Draft</code> standards that are non-binding but volatile as they are under development</li>
<li><code>Experimental</code> standards that are transient and created to test concepts</li>
</ol>
<h2 id='candidate-standards'>Candidate Standards</h2>
<p>The Consumer Data Standards currently include the following Candidate Standards:</p>

<ul>
<li><a href="./includes/additional/candidates/telco.html">Candidate Standards for the Telecommunications sector</a></li>
<li><a href="./includes/additional/candidates/dp306/banking-dp306.html">Candidate Standards for Banking Decision Proposal 306</a></li>
<li><a href="./includes/additional/candidates/non-bank-lending/banking-non-bank-lending.html">Candidate Standards for the Banking and Non-Bank Lending sector</a></li>
</ul>
<h2 id='draft-standards'>Draft Standards</h2>
<p>The Consumer Data Standards do not currently include any Draft Standards.</p>
<h2 id='experimental-standards'>Experimental Standards</h2>
<p>The experimental standards developed by the Data Standards Body are developed in this <a href="https://github.com/ConsumerDataStandardsAustralia/standards-experimental">GitHub repository</a> and are <a href="https://consumerdatastandardsaustralia.github.io/standards-experimental/">published here</a>.</p>
7 changes: 6 additions & 1 deletion docs/includes/known-issues
@@ -1,4 +1,5 @@
<h1 id='known-issues'>Known Issues</h1>
<h1 id='known-issues'>Known Issues</h1><pre class="highlight diff tab-diff"><code>Incorrect version of `Get Bulk Billing` and `Get Billing For Specific Accounts` Energy APIs noted in Known Issues table
</code></pre>
<p>There are certain aspects of the standards that are actively under review. These known issues are articulated in the following table.</p>

<table><thead>
Expand All @@ -19,6 +20,10 @@
<td style="text-align: left">DCR and Register Swagger naming conventions</td>
<td style="text-align: left">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</td>
</tr>
<tr>
<td style="text-align: left">Incorrect version of Energy Billing APIs</td>
<td style="text-align: left">The version of <code>Get Bulk Billing</code> and <code>Get Billing For Specific Accounts</code> Energy APIs is incorrectly noted as 2 in v1.29.0 of the standards. The correct version should be 3.</td>
</tr>
</tbody></table>
<h2 id='future-improvements'>Future improvements</h2>
<p>The following improvements will be incorporated into future versions of the Standards</p>
Expand Down
7 changes: 6 additions & 1 deletion docs/index.html
Expand Up @@ -55599,7 +55599,8 @@ <h2 id='draft-standards'>Draft Standards</h2>
<h2 id='experimental-standards'>Experimental Standards</h2>
<p>The experimental standards developed by the Data Standards Body are developed in this <a href="https://github.com/ConsumerDataStandardsAustralia/standards-experimental">GitHub repository</a> and are <a href="https://consumerdatastandardsaustralia.github.io/standards-experimental/">published here</a>.</p>
<h1 style="display:none"></h1>
<h1 id='known-issues'>Known Issues</h1>
<h1 id='known-issues'>Known Issues</h1><pre class="highlight diff tab-diff"><code>Incorrect version of `Get Bulk Billing` and `Get Billing For Specific Accounts` Energy APIs noted in Known Issues table
</code></pre>
<p>There are certain aspects of the standards that are actively under review. These known issues are articulated in the following table.</p>

<table><thead>
Expand All @@ -55620,6 +55621,10 @@ <h1 id='known-issues'>Known Issues</h1>
<td style="text-align: left">DCR and Register Swagger naming conventions</td>
<td style="text-align: left">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</td>
</tr>
<tr>
<td style="text-align: left">Incorrect version of Energy Billing APIs</td>
<td style="text-align: left">The version of <code>Get Bulk Billing</code> and <code>Get Billing For Specific Accounts</code> Energy APIs is incorrectly noted as 2 in v1.29.0 of the standards. The correct version should be 3.</td>
</tr>
</tbody></table>
<h2 id='future-improvements'>Future improvements</h2>
<p>The following improvements will be incorporated into future versions of the Standards</p>
Expand Down
5 changes: 5 additions & 0 deletions 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.


Expand All @@ -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
Expand Down

0 comments on commit a7e49d3

Please sign in to comment.