Skip to content

Commit

Permalink
Release/1.17.0 (#253)
Browse files Browse the repository at this point in the history
* Standards Staging Issue #115: Update text description of bulk balance for energy in endpoint version schedule

* Cleared out the diff comments presented on the Version Delta tab

* Added an empty release 1.16.0 release notes page

* Incremented version numbers for swagger files to 1.16.0

* Added archive link to 1.15.0

* Reverted back to standard (non-festive) logo

* Incremented version number in introduction

* Added normative reference link to RFC9126

* Added link to 1.16.0 release notes

* Corrected link for RFC2119

* Clarified requirements for Data Recipient Software Products S256 code challenge method by removing the redundant \'if supported\' text

* Standards Staging Issue #116 Change type of page and page-size in Energy APIs to PositiveInteger

* Updates for DP166

* Updates for DP166

* Removed duplicate section: Data Holders calling Data Recipients

* Corrected GetProducts response reference from ResponseBankingProductList to ResponseBankingProductListV2

* Removed the unintended additional formatting from the cds_banking.json to make diffs easier

* Corrected Register Discovery Document definition defect renaming request_object_signing_alg_values_supported to token_endpoint_auth_signing_alg_values_supported

* Corrected GetDataHolderBrands RegisterDataHolderAuth and jwksEndpoint schema definitions to clarify their usage in DH to ADR client authentication

* Standards Staging Issue #115: Updated release notes for this change

* fixed typos and ordering

* Removed tables

* Rechanged ordering

* Build and final checks

* Convert swagger to OAS
Remove 4xx error codes

* Rebuild

* Fix json typos
Update error codes for energy OAS

* Rebuild

* Added tooltip support for RFCs and normative/informative references. Also fixed invalid or missing RFC links

* Fixed markdown issue with normative references table

* Converted more normative reference links to dynamic tooltips

* Updated FAPI informative reference

* - Formatting improvements. - Added additional tooltip references

* - Moved normative references out of the Security section into the Introduction. - Added additional tooltip references

* Updated code generation for normative and informative references

* Added link to the endpoint versioning schedule to the high level standards

* Added 1.16.1 release notes

* Added release notes for Standards Staging issue 130

* Added release notes for Standards Staging issue 132

* Updated RFC4122 links in Banking and Common schemas to include tooltips

* poc secondary-dataholder-apis: Added changes to include Energy Secondary Data Holder OAS in standards

* Fix for staging 139

* fix #138

* Fix for #137

* Fix #136

* Fix #135

* Fix #134

* Initial build for review

* Update version number everywhere

* Add archive entry for 1.16.0
Clean up diff statements
Update release notes

* Fixes to SR swagger

* Update Swagger to OAS in markdown

* Updated Energy SDH swagger file to lastest version with fixes applied for error codes and attribute types

* Remove known issues that are resolved
Full rebuild

* Version bumps to address GitHub security notices

* Updated additional informative references to include tooltips

* Fix SDH security

* Fix for controlledLoad flag in energy
Rebuild

* Minor release notes and diff fixes

* Standards Release 1.17.0: Added release notes file

* Standards Maintenance Issue #448: Changed percentOfBill, percentOfUse, fixedAmount and percentOverThreshold attributes from optional to conditional within EnergyPlanDiscounts schema

* Standards Release 1.17.0: Removed version deltas, incremented version numbers in swagger files, added archieve entry for 1.16.1

* Updates to baseline 1.17.0 to remove legacy diffs and include a link to the release notes

* Standards Maintenance Issue 503: Fixed documentation for CDR Arrangement Form Parameter and JWT method requirements

* Added scrollabe diffs and examples to support previous and next scrolling

* Added release notes

* Updated prev/next button titles

* Minor refactoring to remove unused vars

* Standards Maintenance Issue 504: Corrected the profile scope data language to clarify request of individual claims

* Added diff

* Standards Maintenance Issue #449: Made EnergyPlanSolarFeedInTariff.timeVaryingTariffs.timeVariations.days field mandatory

* Added proof of concept to highlight obligations in the endpoint versioning schedule based on a selected mileston date

* Added release notes

* Removed diff comments

* Fix for padding of last input field in datepicker

* Added collapsible obligations that hide any future, retired, and inactive obligations

* Tweaks to collapsed highlighting

* Updated release notes to include standards maintenance issue number

* Corrected release description

* Updated CDR Arrangement Recovation JWT documentation to articulate requirements in accordance to self signed JWTs

* Added a new section to summarise all change requests in the release notes

* Added headings

* Added obligation milestones

* Improvement to wording of profile scope data language based on commmunity feedback

* Updated diff

* corrected non-normative examples using the unsupported HS256 alg. Changed examples to PS256 to align with FAPI requirements

* Added 482 descriptions to the release notes

* Updated release notes

* Update dcr OAS so it compiles

* Standards Maintenance Issue #457: Made EnergyServicePointDetail.meters.registers.registerSuffix field optional

* Updated release notes to contain links to the associated change request

* Updated Register swagger to addres empty content fields causing compilation issues

* header requirements for versioned Register APIs moved from mandatory to optional

* Standards Maintenance Issue #438: Added calculationFactors and adjustments objects to EnergyBillingOtherTransaction model

* Added version delta comments

* Rebuild
Fix minor typos in diffs

* Removed debugging output for date picker

* Standards Maintenance Issue #439: Added timezone field to EnergyPlanTariffPeriod

* Fixed compile issues for date picker scripts

* Added Register dependency schedule table to differentiate Register delivery from Participant future dated obligations

* Added requirement for data holders to ignore unsupported authorisation scopes

* Updated endpoint version schedule to 2022-11-15 for register API versions where binding date was subject to ACCC review

* Standards Maintenance Issue #476: Updated EnergyConcession model to cater for variable concessions. Changed RateString to represent generic percentages.

* Standards Maintenance Issue #476: Moved RateString change description to High Level Standards in Release Notes. Move RateString diff in High Level Standards

* Moved change description to API Endpoints sections in Release Notes

* Set retirement dates for outstanding deprecated Register APIs

* Added standards maintenance issue reference to release notes

* Added standards maintenance issue reference to release notes

* New authenticated endpoints only require cdr-register:read as the authorisation scope

* Added clarification that when statuses are not received or recognised from the CDR Register, the ACCC can inform Data Holders of statuses to trust using an alternative mechanism

* Added GetDataHolderBrandsSummary API to expose public details of Data Holder Brands from the CDR Register to public clients

* Standards Maintenance Issue #478: Made EnergyServicePointDetail.meters and EnergyServicePointDetail.meters.registers fields optional and updated their descriptions

* Documented scopes usage for the authenticated Register endpoint versions

* Changed formatting of dependency dates to remove leading zero

* XV header is a required field

* Made SHOULD requirement bold

* Added version-deltas for register scope usage

* Standards Staging Issue #133: Corrected description of 'oldest-date' by removing the word 'days'

* Standards Staging Issue #170: Documentation fix - EnergyServicePointDetail.meters and EnergyServicePointDetail.meters.registers have been converted into arrays

* Standards Maintenance Issue #439: Updated description of EnergyPlanContract.timezone and EnergyPlanTariffPeriod.timezone to specify default values

* Standards Staging Issue #131: Minor edit- clarification added that ServicePointId to be replaced with NMI in path param as well

* Corrected version delta presentation

* Added Get Data Holder Brands Summary to the endpoints table

* Corrected whitespacing in version deltas

* Standards Staging Issue #153: Modified Energy location to be a CommonPhysicalAddress model

* Added support for 404 response code

* Full rebuild

* Add release date
Reorder release notes

* Standards Staging Issue #167: Corrected x-fapi-interaction-id header to be mandatory for Energy SDH APIs

* Fix to force version delta code blocks to break at word boundaries not at overflow

* 404 now only applies when industry is not found

* Cosmetic improvements in the release notes

* Cleaned up version deltas to follow conventions

* Removed reference to the ACCC delivery schedule

* Full rebuild

* Correct change for staging issue 170

Co-authored-by: Hemang Rathod <[email protected]>
Co-authored-by: Ivan Hosgood <[email protected]>
Co-authored-by: Kirkycdr <[email protected]>
Co-authored-by: James Bligh <[email protected]>
Co-authored-by: James Bligh <[email protected]>
Co-authored-by: Mark Verstege <[email protected]>
Co-authored-by: Ivan Hosgood <[email protected]>
  • Loading branch information
8 people authored May 23, 2022
1 parent ce6426d commit c4bb11c
Show file tree
Hide file tree
Showing 122 changed files with 14,032 additions and 6,009 deletions.
5 changes: 5 additions & 0 deletions docs/includes/archives
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@
</tr>
</thead><tbody>
<tr>
<td><a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.16.1/'>22/03/2022</a></td>
<td>1.16.1</td>
<td><a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.16.1/'>Minor errata and documentation fixes. Update of swagger files to OAS3</a></td>
</tr>
<tr>
<td><a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.16.0/'>04/02/2022</a></td>
<td>1.16.0</td>
<td><a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.16.0/'>Changes arising from Decision 222 (Insights and Trusted Adviser Disclosure Consents CX Standards)</a></td>
Expand Down
30 changes: 23 additions & 7 deletions docs/includes/cds_dcr
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ This operation does not require authentication
<td>header</td>
<td>string</td>
<td>mandatory</td>
<td>An Authorisation Token as per <a href="https://tools.ietf.org/html/rfc6750">RFC6750</a></td>
<td>An Authorisation Token as per <strong><a href="#nref-RFC6750">[RFC6750]</a></strong></td>
</tr>
</tbody></table>

Expand Down Expand Up @@ -298,7 +298,7 @@ This operation does not require authentication
<td>WWW-Authenticate</td>
<td>string</td>
<td></td>
<td>The Response Header Field as per <a href="https://tools.ietf.org/html/rfc6750">RFC6750</a></td>
<td>The Response Header Field as per <strong><a href="#nref-RFC6750">[RFC6750]</a></strong></td>
</tr>
</tbody></table>

Expand Down Expand Up @@ -379,7 +379,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>header</td>
<td>string</td>
<td>mandatory</td>
<td>An Authorisation Token as per <a href="https://tools.ietf.org/html/rfc6750">RFC6750</a></td>
<td>An Authorisation Token as per <strong><a href="#nref-RFC6750">[RFC6750]</a></strong></td>
</tr>
<tr>
<td>body</td>
Expand Down Expand Up @@ -485,7 +485,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>WWW-Authenticate</td>
<td>string</td>
<td></td>
<td>The Response Header Field as per <a href="https://tools.ietf.org/html/rfc6750">RFC6750</a></td>
<td>The Response Header Field as per <strong><a href="#nref-RFC6750">[RFC6750]</a></strong></td>
</tr>
</tbody></table>

Expand Down Expand Up @@ -559,7 +559,7 @@ Authorization: string
<td>header</td>
<td>string</td>
<td>mandatory</td>
<td>An Authorisation Token as per <a href="https://tools.ietf.org/html/rfc6750">RFC6750</a></td>
<td>An Authorisation Token as per <strong><a href="#nref-RFC6750">[RFC6750]</a></strong></td>
</tr>
</tbody></table>

Expand Down Expand Up @@ -613,7 +613,7 @@ Authorization: string
<td>WWW-Authenticate</td>
<td>string</td>
<td></td>
<td>The Response Header Field as per <a href="https://tools.ietf.org/html/rfc6750">RFC6750</a></td>
<td>The Response Header Field as per <strong><a href="#nref-RFC6750">[RFC6750]</a></strong></td>
</tr>
</tbody></table>

Expand Down Expand Up @@ -790,7 +790,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>jwks_uri</td>
<td>string</td>
<td>mandatory</td>
<td>URL string referencing the client JSON Web Key (JWK) Set [RFC7517] document, which contains the client public keys</td>
<td>URL string referencing the client JSON Web Key (JWK) Set <strong><a href="#nref-RFC7517">[RFC7517]</a></strong> document, which contains the client public keys</td>
</tr>
<tr>
<td>revocation_uri</td>
Expand Down Expand Up @@ -903,6 +903,22 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>ES256</td>
</tr>
<tr>
<td>grant_types</td>
<td>client_credentials</td>
</tr>
<tr>
<td>grant_types</td>
<td>authorization_code</td>
</tr>
<tr>
<td>grant_types</td>
<td>refresh_token</td>
</tr>
<tr>
<td>response_types</td>
<td>code id_token</td>
</tr>
<tr>
<td>application_type</td>
<td>web</td>
</tr>
Expand Down
1,150 changes: 743 additions & 407 deletions docs/includes/cds_energy

Large diffs are not rendered by default.

782 changes: 461 additions & 321 deletions docs/includes/cds_energy_sdh

Large diffs are not rendered by default.

Loading

0 comments on commit c4bb11c

Please sign in to comment.