Skip to content

Commit

Permalink
Release/1.19.0 Correction (#271)
Browse files Browse the repository at this point in the history
* 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

* Created baseline release 1.18.0

* Updated change log

* Fixes link to profile scope data language. Addresses ConsumerDataStandardsAustralia/standards-maintenance#511 (comment)

* Fixes formatting of bullet point list in Authorisation Code Flow section. Addresses ConsumerDataStandardsAustralia/standards-maintenance#511 (comment)

* Standards Maintenance Issue 487: Fix URLs for DCR API non-normative examples. Addresses ConsumerDataStandardsAustralia/standards-maintenance#487

* Standards Maintenance Issue 494: Fixed documentation in Response Payload Structure. Addresses ConsumerDataStandardsAustralia/standards-maintenance#494

* Added link to the issue # in the changelog

* Updated changelog and added diff records

* Standards Maintenance Issue 489: Corrected references to x-fapi-auth-date in resource APIs. Addresses ConsumerDataStandardsAustralia/standards-maintenance#489

* Standards Maintenance Issue 497: Corrected references to addr-spec. Addresses ConsumerDataStandardsAustralia/standards-maintenance#497

* Standards Maintenance Issue 511: Corrected bullet point list formatting for Mandatory Fields in the Payload Conventions

* Standards Maintenance Issue 511: Updates for the Energy schema types, description and formatting. Addresses comment ConsumerDataStandardsAustralia/standards-maintenance#511 (comment)

* Updated release notes for issue 511

* Removed constraint that data holder brands could only map to a single industry

* Standards Maintenance Issue 521: Updated transition arrangements for implementation of the CDR Arrangement JWT method for the Data Recipience Arrangement Revocation endpoint

* Standards Maintenance Issue 493: Fixed error code documentation for the Banking Get Transaction Detail API

* Added clarification on algorithm coverage required for data holders and data recipients

* Added diffs and change log entries

* Added clarifying statement for Data Recipient validation

* Registration validation future obligation date changed from 15th November 2022 to 31st August 2022

* Added future improvement Register API error codes need to be aligned with the CDS standardised error codes

* Get Software Statement Assertion API v1 & v2 has the scope claim explicitly defined and added version schedule for obsolete v1 of the GetSSA API

* Corrected presentation of schema elements in the navigation bar for GetSSA V2

* Added obligation date to data holder requirements regarding unsupported authorisation scopes

* Added default x-v version as 1 for all APIs where x-v is optional

* Added changes to introduction documentation to correct CDR agency hyperlinks and informative references

* Moved normative and informative reference Markdown into the 'introduction' section

* Standards Maintenance Issue #472: Made EnergyPlanControlledLoad into an array and updated structure to allow representation of time of use based rates

* Standards Maintenance Issue #150: Made changes to EnergyUsageRead structure of both primary and secondary data holder to optimise sharing of large volume of interval read data. The change also includes adding a new interval-reads query parameter to usage APIs.

* Standards Maintenance Issue 499: Corrected incorrect reference of  object as a required component of a sibling object in the energy specification

* Standards Maintenance Issue 461: Corrected the conditional statement for the EnergyPlanContract.variation parameter

* Fixed HTML rendering for the bullet point list within the Array Conventions section

* Standards Maintenance Issue #495: Added notes to clarify intent of Get Agreed Payment Schedule API. Made EnergyPaymentScheduleResponse into an array. Added digitalWallet structure to EnergyPaymentSchedule. Updated description of isTokenised by removing conditional statements for bsb and accountNumber fields

* Standards Maintenance Issue #502: Converted EnergyPlanSolarFeedInTariff.timeVaryingTariffs.timeVariations.days and EnergyPlanTariffPeriod.demandCharges.days into ENUM. Updated ENUM values for EnergyPlanTariffPeriod.timeOfUseRates.timeOfUse.days

* Standards Maintenance Issue #505: Converted timeOfUseRates.timeOfUse.startTime, timeOfUseRates.timeOfUse.endTime, demandCharges.startTime and demandCharges.endTime to TimeString type

* Standards Maintenance Issue #511: Updated description of EnergyUsageListResponse in Energy Data Holder and Secondary Data Holders endpoints with sort order

* Standards Staging Issue #192: Corrected property value name in EnergyServicePointListResponse

* Standards Staging Issue #200: Update the description of EnergyInvoice in EnergyInvoiceListResponse to clarify the sorting is done by issueDate

* Standards Maintenance Issue #485: Customer data language moved from sector specific to common area. Title of profile scope language amended

* Rebuild

* CR 515
Update change log entry got 1.18.0
Fix release notes formatting

* Rebuild

* Update for should vs must language arising from CR 511

* Standards Maintenance Issue #512: Added distributors string array to EnergyPlan.geography object

* Add test documentation link to the TOC
Rebuild

* Bump libraries

* Update swagger versions
Create archive
Rebuild

* Rebuild

* Standards Release 1.18.0# Applied DER changes identified in CR511 to secondary data holder APIs

* Rebuild

* Rebuild

* Baseline for v1.19.0

* Removed legacy v1.18.0 diff notes

* Standards Maintenance Issue 429: Updated Energy data language standards

* Updated the version number in the release notes heading

* Simplified delta comments and corrected the referenced change request in the release notes

* Removed FDO because it is the commencement of Energy go-live

* Decision Proposal 260: Updated get energy accounts and get energy account details with changes from DP260

* Added obsolete v1 versions for Get Energy Accounts and Get Energy Account Detail. Updated Energy OAS object versions accordingly

* Decision Proposal #260: Updated changelog, releasenotes, fdo, energy api version schedule. Renamed get-energy-account-v1.html.md to get-energy-accounts-v1.html.md

* Added release notes for OAIC link fix

* Added archive for v1.18.0

* fixed typos in changelog and get energy account v1

* Moved the diff statements closer to the changes within the energy data language standards

* Updated release notes

* Rebuild

* Update publish dates
Minor changes to release notes

* Update swagger version numbers

* Defect fix: removed open-status query param from Get Energy Account Detail API

* Fixes

Co-authored-by: Mark Verstege <[email protected]>
Co-authored-by: Ivan Hosgood <[email protected]>
Co-authored-by: James Bligh <[email protected]>
Co-authored-by: Hemang Rathod <[email protected]>
Co-authored-by: James Bligh <[email protected]>
Co-authored-by: Ivan Hosgood <[email protected]>
  • Loading branch information
7 people authored Sep 13, 2022
1 parent cdc600b commit 31c5091
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 112 deletions.
83 changes: 28 additions & 55 deletions docs/includes/cds_energy
Original file line number Diff line number Diff line change
Expand Up @@ -3700,13 +3700,6 @@ x-cds-client-headers: string
<td>ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List end point.</td>
</tr>
<tr>
<td>open-status</td>
<td>query</td>
<td>string</td>
<td>optional</td>
<td>Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed</td>
</tr>
<tr>
<td>x-v</td>
<td>header</td>
<td>string</td>
Expand Down Expand Up @@ -3749,26 +3742,6 @@ x-cds-client-headers: string
<td>The customer&#39;s original standard http headers <a href="#common-field-types">Base64</a> encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-6'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Parameter</th>
<th>Value</th>
</tr>
</thead><tbody>
<tr>
<td>open-status</td>
<td>ALL</td>
</tr>
<tr>
<td>open-status</td>
<td>CLOSED</td>
</tr>
<tr>
<td>open-status</td>
<td>OPEN</td>
</tr>
</tbody></table>

<blockquote>
<p>Example responses</p>
Expand Down Expand Up @@ -9804,7 +9777,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Array of distributors for the plan. Must have at least one entry</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-7'>Enumerated Values</h4>
<h4 id='enumerated-values-6'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -10744,7 +10717,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Array of tariff periods</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-8'>Enumerated Values</h4>
<h4 id='enumerated-values-7'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -11106,7 +11079,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>An array of the available billing schedules for this contract. Formatted according to <a href="https://en.wikipedia.org/wiki/ISO_8601#Durations">ISO 8601 Durations</a> (excludes recurrence syntax)</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-9'>Enumerated Values</h4>
<h4 id='enumerated-values-8'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -11367,7 +11340,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>The type of usage that the rate applies to</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-10'>Enumerated Values</h4>
<h4 id='enumerated-values-9'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -11544,7 +11517,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>A display message outlining an eligibility criteria that may apply</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-11'>Enumerated Values</h4>
<h4 id='enumerated-values-10'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -11694,7 +11667,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>The usage amount threshold above which the discount applies</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-12'>Enumerated Values</h4>
<h4 id='enumerated-values-11'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -11826,7 +11799,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>The amount of the charge if the type implies the application of a fixed amount</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-13'>Enumerated Values</h4>
<h4 id='enumerated-values-12'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -11908,7 +11881,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>A description of the eligibility restriction</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-14'>Enumerated Values</h4>
<h4 id='enumerated-values-13'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -12056,7 +12029,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>A description of the fee</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-15'>Enumerated Values</h4>
<h4 id='enumerated-values-14'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -12306,7 +12279,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>The end of the time period per day for which the tariff applies. If absent assumes end of day (ie. one second before midnight)</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-16'>Enumerated Values</h4>
<h4 id='enumerated-values-15'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -12703,7 +12676,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Charge period for the demand tariff</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-17'>Enumerated Values</h4>
<h4 id='enumerated-values-16'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -13058,7 +13031,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below: <ul><li><strong>LOW</strong> - Consumption is less than the ‘lower consumption threshold’ as defined in the National Energy Retail Regulations</li><li><strong>MEDIUM</strong> - Consumption is equal to or greater than the ‘lower consumption threshold’, but less than the ‘upper consumption threshold’, as defined in the National Energy Retail Regulations</li><li><strong>HIGH</strong> - Consumption is equal to or greater than the ‘upper consumption threshold’ as defined in the National Energy Retail Regulations</li></ul></td>
</tr>
</tbody></table>
<h4 id='enumerated-values-18'>Enumerated Values</h4>
<h4 id='enumerated-values-17'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -13508,7 +13481,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Actual/Subtractive Indicator. Note the details of enumeration values below: <ul><li><strong>ACTUAL</strong> implies volume of energy actually metered between two dates</li><li><strong>CUMULATIVE</strong> indicates a meter reading for a specific date. A second Meter Reading is required to determine the consumption between those two Meter Reading dates</li></ul></td>
</tr>
</tbody></table>
<h4 id='enumerated-values-19'>Enumerated Values</h4>
<h4 id='enumerated-values-18'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -13930,7 +13903,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>The quality of the read taken</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-20'>Enumerated Values</h4>
<h4 id='enumerated-values-19'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -14284,7 +14257,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Maximum storage capacity in kVAh. This refers to the capacity of each storage module within the device group. Mandatory if type is equal to “STORAGE”</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-21'>Enumerated Values</h4>
<h4 id='enumerated-values-20'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -14408,7 +14381,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>The date that the account was created or opened. Mandatory if openStatus is OPEN</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-22'>Enumerated Values</h4>
<h4 id='enumerated-values-21'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -15130,7 +15103,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Used for a trailing suffix to the name (e.g. Jr)</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-23'>Enumerated Values</h4>
<h4 id='enumerated-values-22'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -15318,7 +15291,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>The frequency with which a bill will be issued. Formatted according to <a href="https://en.wikipedia.org/wiki/ISO_8601#Durations">ISO 8601 Durations</a> (excludes recurrence syntax)</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-24'>Enumerated Values</h4>
<h4 id='enumerated-values-23'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -15511,7 +15484,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Array of ENUM&#39;s to specify what the concession applies to. Multiple ENUM values can be provided. If absent, USAGE is assumed</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-25'>Enumerated Values</h4>
<h4 id='enumerated-values-24'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -15731,7 +15704,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Indicator of the payment status for the invoice</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-26'>Enumerated Values</h4>
<h4 id='enumerated-values-25'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -15834,7 +15807,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>The total GST for all electricity usage charges. If absent then zero is assumed</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-27'>Enumerated Values</h4>
<h4 id='enumerated-values-26'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -15953,7 +15926,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>The total GST for all electricity usage charges. If absent then zero is assumed</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-28'>Enumerated Values</h4>
<h4 id='enumerated-values-27'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -16182,7 +16155,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Represents a payment to the account. Mandatory if transactionUType is equal to payment</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-29'>Enumerated Values</h4>
<h4 id='enumerated-values-28'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -16345,7 +16318,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>A free text description of the adjustment</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-30'>Enumerated Values</h4>
<h4 id='enumerated-values-29'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -16557,7 +16530,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>A free text description of the adjustment</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-31'>Enumerated Values</h4>
<h4 id='enumerated-values-30'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -16768,7 +16741,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>A free text description of the adjustment</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-32'>Enumerated Values</h4>
<h4 id='enumerated-values-31'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -16843,7 +16816,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>The method of payment</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-33'>Enumerated Values</h4>
<h4 id='enumerated-values-32'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -16949,7 +16922,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Australian address formatted according to the file format defined by the <a href="https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf">PAF file format</a>. Required if addressUType is set to paf</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-34'>Enumerated Values</h4>
<h4 id='enumerated-values-33'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down
Loading

0 comments on commit 31c5091

Please sign in to comment.