-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Iteration 11 Holistic Feedback #511
Comments
First comment, this one looks like it could be rolled in: #461 |
Clarification on This leads to the following clarifications required:
There is also an MI item #495 for this, happy to move this comment there if it seems more appropriate. Further update from implementation call for this endpoint:
|
Merged enum related components
|
The following fields are currently specified in the Standards as
The following fields have implied defaults if not specified, may be integers and DER Guidelines state
The following fields seem either non-existent or incorrectly defined:
The following fields have descriptions worth that should probably be fixed with proposals in italics:
|
Clarification is requested for
|
Via CDR Support Portal. The language for some of the common types (e.g. MaskedPANString) use 'should' inconsistently with RFC2119 as their language predates the use of the RFC. The type descriptions should be reviewed to align to the intent (i.e. make each 'should' an explicit SHOULD or MUST). |
From v1.17.0, I think the anchor link in this section is incorrect, perhaps it should point to - |
The following CRs have been included in Maintenance Iteration 11. Each represents a minor documentation fix. They've been cross posted here within the holistic feedback CR for the iteration. Changes will be staged against each within a maintenance/511 branch as individual commits.
The following CRs will be closed:
|
This issue has been fixed. It is staged for review here: ConsumerDataStandardsAustralia/standards-staging@release/1.18.0...maintenance/511. Commit cb9e55d. |
This issue has been fixed. It is staged for review here: ConsumerDataStandardsAustralia/standards-staging@release/1.18.0...maintenance/511. Commit 7b05677. |
Issue #487 has been staged for review: #487 (comment) |
To improve consistency, bold all Requirement Level keywords usages (e.g. MUST, SHOULD, ...) throughout the standards. |
Issue #494 has been staged for review: #494 (comment) |
The baseline review branch for these holistic changes has been staged here: https://github.com/ConsumerDataStandardsAustralia/standards-staging/compare/release/1.18.0..maintenance/511. As changes are addressed in the comments above, they will be incorporated into this staging branch for community review. |
Issue #489 has been staged for review: #489 (comment) |
Specify that the sort order of usage reads in the energy standards (i.e. in EnergyUsageListResponse) will be by NMI (ascending), read start date (descending) |
Issue #497 has been staged for review: #497 (comment) |
@HemangCDR, sorry I added this without realising you already had. For what it's worth, the sort order doesn't appear to have a ratified Decision Proposal supporting it. Original Post: Sort order of usage data is not specified. In fact the DP for usage data didn't seem to specify it either. It appears to have last been discussed in an abandoned prior decision proposal. |
@perlboy no worries. DP 195 did have the sort order specified, it was in the "General Notes" section of the proposal as below:
It was missed in the decision document (which is probably why it isn't in the standards). We will ratify it part of MI11. |
Yes. That was what I was highlighting. The only thing binding is the Standards which are tied to decisions of the Chair and the decision the Chair provided didn't include it. Consequently the sort order isn't actually ratified by the Chair. It should be. 😄 |
Another minor documentation update similar to above, I think these should also be a list - |
Suggested updates to EnergyDerRecord, note some of these overlap with Stuart's suggestions.
In regards to Stuart's comments on the manufacturer and model's potentially being enumerated, these values aren't enumerated in the DER Register so enumeration can't be supported. |
|
Thanks for confirming this Opal. Any reason why this couldn't be an enum instead? It seems more descriptive is all. Also, does the Australian energy market actually have live 2 phase installs? I thought 2 phase was killed off in the early 1900s?
This really sounds like an enum. The table from the NEM 12/13 spec in Appendix B (Page 22) was quite helpful and we wondered whether a universal
The timezone problem looks like one of the more difficult problems to solve in this sector. While I accept that all AEMO data is currently AEST embedding this timezone will generally preclude other potential meter sources (for instance voluntary data holders that don't participate in the NEM) and plan data has this concept of |
This issue has been fixed. It is staged for review here: ConsumerDataStandardsAustralia/standards-staging@release/1.18.0...maintenance/511. Commit 4e285de. |
The above comments have been addressed in CR #495. Please refer to this comment. |
In response to @perlboy's comment
Based on @OpalRussAEMO's comment, the DSB proposes to make the above attributes PositiveInteger. We can update the description to state the acceptable values are 1, 2 and 3.
The above attribute is represented exactly as it is from AEMOs DER specification similar to other attributes.
The default values have been left out in the CDS on purpose after consultations with AEMO. This is mainly because the default values cannot be assumed as there are scenarios where the distributor/installer may not supply the value to AEMO and it is unknown. The underlying specs may also change the default values in the future.
The description of the above field in DER spec, is defined as - "Sustained Over voltage protection delay in volts (V)". The DSB can update the description of the field based on AEMO's feedback.
The fields were not made ENUM based on consultation with AEMO as the values change frequently (more devices models added) and the data provided by the installer may not be consistent.
The above understanding is correct, it is a simple 24 months subtraction.
The |
👍
This may be the case but the Standards state:
The justification of aligning to a source document is neither a Standard, a camel case clarification nor makes much sense since the DER specification also includes the following statement:
By the above interpretation the attribute name for Suggest the DSB follow its own Standard regardless of source document or there won't actually be a Standard when you get to Telco. The default values have been left out in the CDS on purpose after consultations with AEMO. This is mainly because the default values cannot be assumed as there are scenarios where the distributor/installer may not supply the value to AEMO and it is unknown. The underlying specs may also change the default values in the future. This makes it even more important to treat values AEMO does not know as something other than Suggest instead of a
👍
That would be preferred because it is impossible to state that all interval reads will always be in AEST because payloads may not always be served by AEMO (eg. other non-included states may be different or voluntary data holders providing metering data from consumer solar installations). Also, can I refloat the question around making |
These changes have been staged for review here: ConsumerDataStandardsAustralia/standards-staging@maintenance/511...maintenance/511-requirement-levels. Given the large number of changes they have been staged under a separate feature branch off maintenance/511. |
Can you click the Create PR Request button please so that an inline review can happen. Otherwise this thread is going to get crazy long. Edit: I actually question whether doing this change in a feedback thread is appropriate. Converting to binding 2119 should be treated as a task in itself. Prior "clarification" changes the DSB have made have blown up in implementers faces, it would be advisable for the DSB to learn from this mistake. |
Hi @perlboy, done: ConsumerDataStandardsAustralia/standards-staging#195 Given the changes are staged in a separate branch we can discuss the treatment of them in the next Maintenance Iteration call. This review was conducted under the normative standards review and could be considered under that work: https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/blob/master/reviews/2021-05/analysis/analysis-rfc2119-rfc8174-20210519.md |
ConsumerDataStandardsAustralia/standards-staging#195 (review) Repasting what I wrote as a comment in the PR Review:
|
Below is a list of all the changes the DSB will recommend be made to the DER structure discussed within this CR:
|
… description and formatting. Addresses comment ConsumerDataStandardsAustralia/standards-maintenance#511 (comment)
These changes have been staged for review: ConsumerDataStandardsAustralia/standards-staging@0cba7f7 |
Issue #493 has been staged for review: #493 (comment) |
Given the large number of changes they have been staged under a separate feature branch off maintenance/511. Based on feedback, this change won't be included in release 1.18.0. The feedback has been helpful and further changes to deal with consistency for requirement levels will be progressed in Maintenance Iteration 12. |
* 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 * 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 Co-authored-by: James Bligh <[email protected]> Co-authored-by: Mark Verstege <[email protected]> Co-authored-by: James Bligh <[email protected]> Co-authored-by: Hemang Rathod <[email protected]> Co-authored-by: Ivan Hosgood <[email protected]> Co-authored-by: Ivan Hosgood <[email protected]>
* 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 * 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 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]>
* 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]>
* 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 * Updated non-normative examples * 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 * Standards Maintenance Issue 447: Corrected typo for CORS * Standards Maintenance Issue 411: Clarification that the x-fapi-interaction-id is not used for unathenticated APIs. * Standards Maintenance Issue 414: Corrected conditional requirements for NPP extendedData>extendedDescription * Removed legacy v1.18.0 diff notes * Added diff notes * Added diff notes * Corrected diff notes * Corrected 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 * Baseline for v1.20.0 * Standards Maintenance Issue 525: Corrected the softwareProductDescription to be a mandatory response paramater returned by the CDR Register * 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 * Removed v1.19.0 diff statements and updated archives and changelog * Standards Maintenance Issue #524: Updated description of fields in EnergyDerRecord.acConnections noting 0 as default when value not known * Standards Maintenance Issue #526: Changed type of EnergyDerRecord.availablePhasesCount and EnergyDerRecord.installedPhasesCount to NaturalNumber. Updated description of approvedCapacity, availablePhasesCount and installedPhasesCount fields in EnergyDerRecord to note 0 indicates no DER record exsits * Standards Maintenance Issue #506: Added isSecondaryDataHolderError flag to Error Response Structure and noted its FDO * Standards Maintenance Issue #506: Updated FDO date to 15th May 2023 * Updated changes to target release v1.20.0 * Updated all Swagger files to release version 1.20.0 * Updated non-normative security examples * Add energy swagger * Build * Updated non-normative security examples * Update Telco standards and build * Do checklist items * Corrected release notes * Minor fixes * Build * Fixes to markdown generation Rebuild * Complete holistic changes Co-authored-by: Hemang Rathod <[email protected]> Co-authored-by: Ivan Hosgood <[email protected]> Co-authored-by: Ivan Hosgood <[email protected]> Co-authored-by: Mark Verstege <[email protected]>
Description
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 11 and the DSB will review them. If we believe the suggestion are material we will raise a dedicated CR for them.
The text was updated successfully, but these errors were encountered: