V1.33.1 Release Notes
Release notes for version 1.33.1 of the CDR Standards.
Changes Made
Change Requests
This release addresses the following minor defects raised on Standards Staging:
General Changes
| Change |
Description |
Link |
| Refactor swagger definitions |
Standards Staging #183: Key changes resulting from this issue are described below as part of Staging #472. |
N/A |
| Fixes for Telco spec. |
Standards Staging #428: Key changes resulting from this issue are described below as part of Staging #472. |
N/A |
| Specify custom OpenAPI Spec. (OAS) fields consistently |
Standards Staging #432: Where schema extensions such as x-cds-type and x-conditional had been applied, these are now in a consistent location and duplicate statements have been removed. Other redundant statements ("x-cds-type": "enum", "x-cds-type": "Boolean") have been removed as these can be inferred from normative statements. |
N/A |
| Refactor, bug fixes, typos and formatting |
Standards Staging #472: - Corrected typos and text styling.
- Requirements for endpoint response headers are now displayed.
- For consistency, common statements referring to endpoint behaviour have been simplified to remove specific participant references. (e.g., 'the data holder MUST' and 'the Register MUST' have become 'the endpoint MUST')
- Refactored all OpenAPI Spec. (OAS) files to use components consistently. Some components have been renamed to provide clarity or remain unique or consistent across the complete standards API suite.
- Updated endpoint tags in the OAS to improve grouping and sorting of endpoints in the Standards and other schema tools. The endpoint menu order has changed in the Register and Banking sections as a result.
- Updated the referencing of the ResponseErrorList schema for consistency across all APIs and corrected the requirement of the meta field from optional to conditional, to align to the condition specified in the code field.
- Updated some endpoint operationId values for consistency and to ensure they are unique across the complete API suite.
- Where field descriptions specified default values, they are now also specified in the schema and displayed in the schema Properties tables.
- Updated description of Energy minDemand field to represent the default value in the specified AmountString format (
0.00) instead of 0. - Corrected the specification of custom descriptions for referenced schemas that were ignored outside the rendering of the Standards page (e.g. other Swagger tools) by enclosing the referenced schemas in allOf statements.
- Removed duplicate code (endpoint properties) in the Energy APIs and Energy Secondary DH APIs OAS - the EnergyServicePointDetail schema now references common fields from the EnergyServicePoint schema rather than duplicating them.
- Created Enum schemas to allow frequently used values to reference a common source rather than being duplicated inline (Register: industries, Energy: measureUnit, days).
- Consolidated multiple instances of common requestBody schemas into requestBodies components.
- Removed the x-codegen-request-body-name custom field specified a limited number of times in the following APIs (endpoint instances): DCR (2), Banking (3), Admin (1).
- Where ID Permanence values were specified, previously discrete fields now reference a common schema component describing the respective field.
- Removed unused schemas from the Telco OAS.
- Added an item to the Known Issues section detailing Telco Candidate issues.
These changes are not intended to modify the requirements or obligations of the Standards, but aim to clarify and improve the technical specifications supporting them. |
N/A |
Introduction
None
High Level Standards
None
API Endpoints
None
None
Register Standards
None
Consumer Experience
None
Non-Functional Requirements
None
Additional Standards
None
Known Issues
None
