Standards Maintenance #653

slate/source/includes/_energy_apis.md.erb

@@ -1,6 +1,13 @@
 
 # Energy APIs
 
+```diff
+Updated description of EnergyPlanTariffPeriodV2.dailySupplyChargeType from: 
+- Specifies if daily supply charge is single or banded. Default value is SINGLE if field not provided with a new line.
+to:
++ Specifies if daily supply charge is single or banded.
+```
+
 This specification defines the APIs for Data Holders exposing Energy endpoints.
 
 <table>
@@ -11,5 +18,4 @@ This specification defines the APIs for Data Holders exposing Energy endpoints.
 ```diff
 Corrected mistake in the timeVaryingTariffs schema which specified amount as a required property
 ```
-
 <%= partial "includes/cds_energy.md" %>

slate/source/includes/releasenotes/releasenotes.1.32.0.html.md

@@ -28,6 +28,7 @@ This release addresses the following change requests raised on [Standards Mainte
 
 - [Standards Maintenance #641 - Update CDS documentation to clarify expected rate value 'sign' (+/-) for each RateType](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/641)
 - [Standards Maintenance #652 - Specify units of currency to be used for the AmountString field type](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/652)
+- [Standards Maintenance #653 - EnergyPlanTariffPeriod - cater for plans with no dailySupplyCharge](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/653)
 
 
 ### Decision Proposals
@@ -63,6 +64,7 @@ This release addresses the following Decision Proposals published on [Standards]
 |------|-----------|----|
 | Corrected required properties | [**Standards Staging #417**](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/417): Corrected mistake in the _timeVaryingTariffs_ schema which specified _amount_ as a required property | [Energy APIs](../../#energy-apis)
 | Update field name styling | [**Standards Staging #419**](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/419): Updated styling of field names in the Banking APIs section, including Product Categories and Product & Account Components | [Banking APIs](../../#banking-apis)
+| Amend <i>dailySupplyChargeType</i> description | [**Standards Maintenance #653**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/653): Amended the  description of the <i>EnergyPlanTariffPeriodV2.dailySupplyChargeType</i> field to remove the default value assumption of `SINGLE` if the field is not provided, allowing plans without a specific daily supply charge to be shared. This change will be included in the existing 11 Nov 2024 FDO for Get Generic Plan Detail v4 and Get Energy Account Detail v5, and will be treated as errata to avoid a version update.| [Energy APIs](../../#energy-apis)
 
 
 ## Information Security Profile

swagger-gen/api/cds_energy.json

@@ -1560,7 +1560,7 @@
                         },
                         "dailySupplyChargeType": {
                             "type": "string",
-                            "description": "Specifies if daily supply charge is single or banded. Default value is SINGLE if field not provided",
+                            "description": "Specifies if daily supply charge is single or banded.",
                             "enum": ["SINGLE",
                                 "BAND"
                             ]
@@ -4851,6 +4851,7 @@
 					"Generic Tariffs"
 				],
                 "x-version": "3",
+                "x-version-notes": "- The <i>dailySupplyChargeType</i> field was added in endpoint v3 as part of Standards v1.30.0. In Standards v1.32.0, the description of that field was changed to remove the default value, but it did not result in a new endpoint version. Refer to the [v1.32.0 release notes](includes/releasenotes/releasenotes.1.32.0.html) for more details.",
 				"parameters": [{
 						"name": "planId",
 						"description": "ID of the specific plan requested",
@@ -5871,6 +5872,7 @@
 					"Energy Accounts"
 				],
                 "x-version": "4",
+                "x-version-notes": "- The <i>dailySupplyChargeType</i> field was added in endpoint v3 as part of Standards v1.30.0. In Standards v1.32.0, the description of that field was changed to remove the default value, but it did not result in a new endpoint version. Refer to the [v1.32.0 release notes](includes/releasenotes/releasenotes.1.32.0.html) for more details.",
 				"parameters": [{
 						"$ref": "#/components/parameters/accountId"
 					},

swagger-gen/widdershins-cdr/templates/openapi3/operation.dot

@@ -44,6 +44,11 @@
 |---|--|
 |Version|**{{? data.operation["x-version"]}}{{= data.operation["x-version"]}}{{??}}Versioning is not supported for this endpoint{{?}}**
 
+{{? data.operation["x-version-notes"]}}
+<h3 id="{{= data.cds_uniqueAnchorPrefix }}_version-notes">Version Notes</h3>
+{{= data.operation["x-version-notes"]}}
+{{?}}
+
 {{? data.parameters && data.parameters.length }}
 {{#def.parameters}}
 {{?}}