V1.27.0 Release Notes
Release notes for version v1.27.0 of the CDR Standards.
Changes Made
Change Requests
This release addresses the following minor defects raised on Standards Staging:
- Staging Issue 196 - Incorrect levelling of largeSecondary object
- Staging Issue 197 - Update client registration non-normative examples to include energy sectors
- Staging Issue 305 - Long lines break words and cause scrollbars
- Staging Issue 306 - Body parameter for JWT POST + PUT not displayed
- Staging Issue 307 - Incorrect non-normative example
- Staging Issue 308 - Fix link to FAPI section reference
- Staging Issue 309 - Property names wrapping to two lines
- Staging Issue 311 - Links to schemas land below the schema name
This release addresses the following change requests raised on Standards Maintenance:
- Maintenance Issue 469 - Add isQueryParamUnsupported to MetaPaginated for schema validation
- Maintenance Issue 599 - Maintenance Iteration 16 Holistic Feedback
- Maintenance Issue 605 - Metrics: Performance threshold including SDH
- Maintenance Issue 611 - Clarification of Energy PRD Obligations
Decision Proposals
This release addresses the following Decision Proposals published on Standards:
General Changes
Change | Description | Link |
---|---|---|
Links to schemas land below the schema name | Standards Staging #311: Adjusted anchor links to keep schema name in view when navigating the Standards documentation | All schema Properties tables |
Line wrapping and scrollbars | Standards Staging #305: Improved line wrapping and removed horizontal scrollbars in the 'Non-normative Examples' and 'Version Delta' tab column. | Non-normative Examples Version Delta |
Release notes for v1.25.0 | Standards Maintenance #599: Updated release notes for v1.25.0. Addresses this issue comment | Change Log |
Introduction
Change | Description | Link |
---|---|---|
Updated CDR website link | Standards Maintenance #599: Changed the link to the CDR website to be HTTPS with www. Addresses this issue comment | Informative References |
High Level Standards
No Change
API End Points
Change | Description | Link |
---|---|---|
Property names wrapping to two lines | Standards Staging #309: Changed to a non-breaking space between the indent chevron and property name in all schema Properties tables to prevent line wrapping | All schema Properties tables |
Incorrect levelling of largeSecondary object | Standards Staging #196: Resolved documentation rendering bug causing incorrect indent level to be displayed for some properties | Multiple sections, including Get Metrics |
Corrected typos | Standards Maintenance #599: Corrected descriptions mentioning electricity in the EnergyInvoiceGasUsageCharges schema. Addresses this issue comment | Energy APIs |
Corrected requirement | Standards Maintenance #599: Corrected the requirement for the authorisations property of Get Metrics v4 and v5 to be mandatory. Addresses this issue comment | Admin APIs |
Bad Request responses | Standards Maintenance #599: Removed duplicate '400 - Invalid Version' error codes from Banking endpoints and added '400 - Invalid Date' error codes to Energy and Energy Secondary DH endpoints. Addresses this issue comment | Banking APIs Energy APIs Energy Secondary DH APIs |
References to Other Versions in Telco | Standards Maintenance #599: Removed references to 'Other Versions' in 'Get Telco Accounts' and 'Get Telco Account Detail' endpoints. Addresses this issue comment | Telco APIs |
Clarified deprecated Energy endpoint expectations | Standards Maintenance #599: Added clarification for 'Get Generic Plan Detail V1', 'Get Energy Account Detail V2', 'Get Billing For Account V1', 'Get Bulk Billing V1', 'Get Billing For Specific Accounts V1', for Data Holders going live on, or after, November 1st 2023. Addresses this issue comment | Energy APIs |
Metrics: Performance threshold including SDH | Standards Maintenance #605: Added statement to clarify that aggregate performance metrics exclude Secondary Data Holder performance | Get Metrics |
isQueryParamUnsupported property | Standards Maintenance #469: Added MetaPaginatedTransaction schema to 'Get Transactions For Account' to include the isQueryParamUnsupported property | Banking APIs |
Information Security Profile
Change | Description | Link |
---|---|---|
Fix link to FAPI section reference | Standards Staging #308: Updated link to section 8.6 of FAPI Advanced | Client Registration |
Incorrect non-normative example | Standards Staging #307: Updated the 'code_challenge_methods_supported' property of the OpenID Provider Configuration to be an array | Security Endpoints |
Body parameter for JWT POST + PUT | Standards Staging #306: Updated 'Non-normative Examples' to include JWT Body parameter for POST and PUT | DCR APIs |
Updated non-normative SSA examples | Standards Staging #197: Updated encoded and decoded example SSAs to include energy scopes and minor updates for clarity and consistency. | Security Profile DCR APIs |
Corrected typo | Standards Maintenance #599: Corrected typo in the description of the software_roles field in the Client Registration and DCR APIs sections. Addresses this issue comment |
Security Profile |
Updated reference | Standards Maintenance #599: Updated [FAPI-RW-Draft] to refer to [FAPI-1.0-Advanced]. Addresses this issue comment | Security Profile |
Clarification of Energy PRD Obligations | Standards Maintenance #611: Updated the description of the PublicBaseUri field to clarify requirements for the Energy sector | Security Endpoints |
Register Standards
Change | Description | Link |
---|---|---|
Corrected typo | Standards Maintenance #599: Corrected typo in registeredCountry description. Addresses this issue comment | Register APIs |
Changed x-v headers to mandatory | Standards Maintenance #599: Changed the x-v header from optional to mandatory and removed the default x-v in 'Get Data Holder Brands', 'Get Software Statement Assertion', 'Get Software Products Statues', 'Get Data Recipients Statues', 'Get Data Recipients'. Updated the x-v and x-min-v descriptions to align to other endpoints. Addresses this issue comment | Register APIs |
Consumer Experience
No Change
Non-Functional Requirements
No Change
Additional Standards
Change | Description | Link |
---|---|---|
Non-bank Lending Draft | Added a draft (ie. non-binding) standard containing the outcomes of consultations conducted to date | Draft Standards |
Known Issues
No Change