Removed x-diff custom key from json swagger. Moved diff statement int…

…o energy erb file
ConsumerDataStandardsAustralia · Sep 20, 2024 · 2a52100 · 2a52100
1 parent c8bfdff
commit 2a52100
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 16 deletions.
diff --git a/slate/source/includes/_energy_apis.md.erb b/slate/source/includes/_energy_apis.md.erb
@@ -1,13 +1,18 @@
 
 # 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>
 <tr><td><a href='./includes/swagger/cds_energy.json'>Energy OpenAPI Specification (JSON)</a></td></tr>
 <tr><td><a href='./includes/swagger/cds_energy.yaml'>Energy OpenAPI Specification (YAML)</a></td></tr>
 </table>
 
-
-
 <%= partial "includes/cds_energy.md" %>
diff --git a/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md b/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md
@@ -51,7 +51,7 @@ This release addresses the following Decision Proposals published on [Standards]
 ## API Endpoints
 |Change|Description|Link|
 |------|-----------|----|
-| Amend <i>dailySupplyChargeType</i> description | [**Standards Maintenance #653**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/653): Amended the  description of the <i>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.| [EnergyPlanContractV3](../../#cdr-energy-api_schemas_tocSenergyplancontractv3)
+| 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
 |Change|Description|Link|

diff --git a/swagger-gen/api/cds_energy.json b/swagger-gen/api/cds_energy.json
@@ -674,7 +674,6 @@
             },
             "EnergyPlanContractV3": {
                 "type": "object",
-                "x-diff": "Updated description of dailySupplyChargeType from: \n- Specifies if daily supply charge is single or banded. Default value is SINGLE if field not provided with a new line\nto:\n+ Specifies if daily supply charge is single or banded.",
                 "required": [
                     "pricingModel",
                     "isFixed",
@@ -4853,7 +4852,6 @@
 				],
                 "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.",
-                "x-diff": "Removed the default value assumption of SINGLE for the dailySupplyChargeType field when not provided",
 				"parameters": [{
 						"name": "planId",
 						"description": "ID of the specific plan requested",
@@ -5875,7 +5873,6 @@
 				],
                 "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.",
-                "x-diff": "Removed the default value assumption of SINGLE for the dailySupplyChargeType field when not provided",
 				"parameters": [{
 						"$ref": "#/components/parameters/accountId"
 					},

diff --git a/swagger-gen/widdershins-cdr/templates/openapi3/main.dot b/swagger-gen/widdershins-cdr/templates/openapi3/main.dot
@@ -30,11 +30,6 @@
 {{ var schema = data.api.components.schemas[s]; }}
 
 <h3 class="schema-toc" id="{{= data.title_prefix }}_schemas_tocS{{=s.toLowerCase() }}">{{= s }}</h3>
-{{? schema["x-diff"] }}
-```diff
-{{= schema["x-diff"]}}
-```
-{{?}}
 <p id="tocS{{=s.toLowerCase()}}" class="orig-anchor"></p>
 
 <p>

diff --git a/swagger-gen/widdershins-cdr/templates/openapi3/operation.dot b/swagger-gen/widdershins-cdr/templates/openapi3/operation.dot
@@ -2,11 +2,6 @@
 {{ data.cds_uniqueAnchorPrefix = data.title_prefix + '_' + data.cds_operationUniqueSlug; }}
 
 <h2 id="{{= data.cds_uniqueAnchorPrefix }}">{{= data.operationUniqueName}}</h2>
-{{? data.operation["x-diff"] }}
-```diff
-{{= data.operation["x-diff"]}}
-```
-{{?}}
 <p id="{{= data.cds_operationUniqueSlug}}" class="orig-anchor"></p>
 
 {{? data.operation.operationId}}