Skip to content

Commit

Permalink
Merge pull request #262 from ConsumerDataStandardsAustralia/staging/245
Browse files Browse the repository at this point in the history 
Issue 245 & 152 - Meta objects for energy APIs
  • Loading branch information
@JamesMBligh
JamesMBligh authored Mar 20, 2023
2 parents aa02e5a + 7880ecd commit 58d264f
Show file tree
Hide file tree
Showing 13 changed files with 167 additions and 267 deletions.
20 changes: 10 additions & 10 deletions docs/includes/cds_energy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2314,7 +2314,7 @@ x-cds-client-headers: string
<td>» meta</td>
<td>body</td>
<td><a href="#schemacdr-energy-apimeta">Meta</a></td>
<td>mandatory</td>
<td>optional</td>
<td>none</td>
</tr>
</tbody></table>
Expand Down Expand Up @@ -3185,7 +3185,7 @@ x-cds-client-headers: string
<td>» meta</td>
<td>body</td>
<td><a href="#schemacdr-energy-apimeta">Meta</a></td>
<td>mandatory</td>
<td>optional</td>
<td>none</td>
</tr>
</tbody></table>
Expand Down Expand Up @@ -5315,7 +5315,7 @@ x-cds-client-headers: string
<td>» meta</td>
<td>body</td>
<td><a href="#schemacdr-energy-apimeta">Meta</a></td>
<td>mandatory</td>
<td>optional</td>
<td>none</td>
</tr>
</tbody></table>
Expand Down Expand Up @@ -6229,7 +6229,7 @@ x-cds-client-headers: string
<td>» meta</td>
<td>body</td>
<td><a href="#schemacdr-energy-apimeta">Meta</a></td>
<td>mandatory</td>
<td>optional</td>
<td>none</td>
</tr>
</tbody></table>
Expand Down Expand Up @@ -7252,7 +7252,7 @@ x-cds-client-headers: string
<td>» meta</td>
<td>body</td>
<td><a href="#schemacdr-energy-apimeta">Meta</a></td>
<td>mandatory</td>
<td>optional</td>
<td>none</td>
</tr>
</tbody></table>
Expand Down Expand Up @@ -8540,7 +8540,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<tr>
<td>meta</td>
<td><a href="#schemacdr-energy-apimeta">Meta</a></td>
<td>mandatory</td>
<td>optional</td>
<td>none</td>
</tr>
</tbody></table>
Expand Down Expand Up @@ -9029,7 +9029,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<tr>
<td>meta</td>
<td><a href="#schemacdr-energy-apimeta">Meta</a></td>
<td>mandatory</td>
<td>optional</td>
<td>none</td>
</tr>
</tbody></table>
Expand Down Expand Up @@ -9105,7 +9105,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<tr>
<td>meta</td>
<td><a href="#schemacdr-energy-apimeta">Meta</a></td>
<td>mandatory</td>
<td>optional</td>
<td>none</td>
</tr>
</tbody></table>
Expand Down Expand Up @@ -9168,7 +9168,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<tr>
<td>meta</td>
<td><a href="#schemacdr-energy-apimeta">Meta</a></td>
<td>mandatory</td>
<td>optional</td>
<td>none</td>
</tr>
</tbody></table>
Expand Down Expand Up @@ -9288,7 +9288,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<tr>
<td>meta</td>
<td><a href="#schemacdr-energy-apimeta">Meta</a></td>
<td>mandatory</td>
<td>optional</td>
<td>none</td>
</tr>
</tbody></table>
Expand Down
78 changes: 14 additions & 64 deletions docs/includes/endpoint-version-schedule/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -273,73 +273,23 @@ <h1 id='obligation-dates-schedule'>Obligation Dates Schedule</h1>
</thead><tbody>
<tr>
<td style="text-align: left"><strong>Legacy FDO</strong></td>
<td style="text-align: center">01/07/2021</td>
<td style="text-align: center">1</td>
</tr>
<tr>
<td style="text-align: left"><strong>Legacy FDO</strong></td>
<td style="text-align: center">31/07/2021</td>
<td style="text-align: center">1</td>
</tr>
<tr>
<td style="text-align: left"><strong>Legacy FDO</strong></td>
<td style="text-align: center">31/10/2021</td>
<td style="text-align: center">1</td>
</tr>
<tr>
<td style="text-align: left"><strong>Legacy FDO</strong></td>
<td style="text-align: center">01/11/2021</td>
<td style="text-align: center">2</td>
</tr>
<tr>
<td style="text-align: left"><strong>Legacy FDO</strong></td>
<td style="text-align: center">01/02/2022</td>
<td style="text-align: center">2</td>
</tr>
<tr>
<td style="text-align: left"><strong>Y22 #1</strong></td>
<td style="text-align: center">31/03/2022</td>
<td style="text-align: center">1</td>
</tr>
<tr>
<td style="text-align: left"><strong>Legacy FDO</strong></td>
<td style="text-align: center">01/07/2022</td>
<td style="text-align: center">2</td>
</tr>
<tr>
<td style="text-align: left"><strong>Y22 #2</strong></td>
<td style="text-align: center">04/07/2022</td>
<td style="text-align: center">16/09/2022</td>
<td style="text-align: center">1</td>
</tr>
<tr>
<td style="text-align: left"><strong>Legacy FDO</strong></td>
<td style="text-align: center">31/07/2022</td>
<td style="text-align: center">4</td>
</tr>
<tr>
<td style="text-align: left"><strong>Legacy FDO</strong></td>
<td style="text-align: center">30/07/2022</td>
<td style="text-align: center">6</td>
</tr>
<tr>
<td style="text-align: left"><strong>Y22 #3</strong></td>
<td style="text-align: center">31/08/2022</td>
<td style="text-align: center">2</td>
</tr>
<tr>
<td style="text-align: left"><strong>Legacy FDO</strong></td>
<td style="text-align: center">16/09/2022</td>
<td style="text-align: center">01/10/2022</td>
<td style="text-align: center">1</td>
</tr>
<tr>
<td style="text-align: left"><strong>Legacy FDO</strong></td>
<td style="text-align: center">01/10/2022</td>
<td style="text-align: center">01/11/2022</td>
<td style="text-align: center">1</td>
</tr>
<tr>
<td style="text-align: left"><strong>Y22 #4</strong></td>
<td style="text-align: center">15/11/2022</td>
<td style="text-align: center">1</td>
<td style="text-align: center">3</td>
</tr>
<tr>
<td style="text-align: left"><strong>Legacy FDO</strong></td>
Expand All @@ -359,17 +309,17 @@ <h1 id='obligation-dates-schedule'>Obligation Dates Schedule</h1>
<tr>
<td style="text-align: left"><strong>Y23 #1</strong></td>
<td style="text-align: center">14/04/2023</td>
<td style="text-align: center">1</td>
<td style="text-align: center">3</td>
</tr>
<tr>
<td style="text-align: left"><strong>Y23 #2</strong></td>
<td style="text-align: center">08/05/2023</td>
<td style="text-align: center">0</td>
<td style="text-align: center">15/05/2023</td>
<td style="text-align: center">1</td>
</tr>
<tr>
<td style="text-align: left"><strong>Y23 #3</strong></td>
<td style="text-align: center">10/07/2023</td>
<td style="text-align: center">1</td>
<td style="text-align: center">3</td>
</tr>
<tr>
<td style="text-align: left"><strong>Y23 #4</strong></td>
Expand All @@ -384,7 +334,7 @@ <h1 id='obligation-dates-schedule'>Obligation Dates Schedule</h1>
<tr>
<td style="text-align: left"><strong>Y24 #1</strong></td>
<td style="text-align: center">11/03/2024</td>
<td style="text-align: center">0</td>
<td style="text-align: center">2</td>
</tr>
<tr>
<td style="text-align: left"><strong>Y24 #2</strong></td>
Expand Down Expand Up @@ -808,7 +758,7 @@ <h2 id='energy-apis'>Energy APIs</h2>
<td>2022-11-15</td>
<td>2023-04-14</td>
<td>2021-10-29, V1.14.0</td>
<td>TBC, V1.19.0</td>
<td>2022-09-13, V1.19.0</td>
</tr>
<tr>
<td>Energy APIs</td>
Expand All @@ -818,7 +768,7 @@ <h2 id='energy-apis'>Energy APIs</h2>
<td>V2</td>
<td>2023-04-14</td>
<td>N/A</td>
<td>TBC, V1.19.0</td>
<td>2022-09-13, V1.19.0</td>
<td>N/A</td>
</tr>
<tr>
Expand All @@ -830,17 +780,17 @@ <h2 id='energy-apis'>Energy APIs</h2>
<td>2022-11-15</td>
<td>2023-04-14</td>
<td>2021-10-29, V1.14.0</td>
<td>TBC, V1.19.0</td>
<td>2022-09-13, V1.19.0</td>
</tr>
<tr>
<td>Energy APIs</td>
<td>Get Energy Account Detail</td>
<td><code>/energy/accounts/{accountId}</code></td>
<td><span class="method get">GET</span></td>
<td>V2</td>
<td>2022-04-14</td>
<td>2023-04-14</td>
<td>N/A</td>
<td>TBC, V1.19.0</td>
<td>2022-09-13, V1.19.0</td>
<td>N/A</td>
</tr>
<tr>
Expand Down
47 changes: 37 additions & 10 deletions docs/includes/releasenotes/releasenotes.1.22.1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -251,16 +251,43 @@ <h2 id='changes-made'>Changes Made</h2><h3 id='change-requests'>Change Requests<
<p>This release addresses the following minor defects raised on <a href="https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues">Standards Staging</a>:</p>

<ul>
<li>XXXX</li>
<li>Issue <a href="https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/257">257</a>: Notice for the Binding Data Standard</li>
<li>Issue <a href="https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/255">255</a>: Maintenance of obligation date tables</li>
<li>Issue <a href="https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/254">254</a>: Get Energy Account Detail V2 - Fix binding date</li>
<li>Issue <a href="https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/254">245</a>: Get Energy APIs: meta object should not be mandatory</li>
<li>Issue <a href="https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/152">152</a>: Get Meta objects to be optional in energy requests</li>
</ul>
<h3 id='decision-proposals'>Decision Proposals</h3>
<p>This release addresses the following Decision Proposals published on <a href="https://github.com/ConsumerDataStandardsAustralia/standards/issues">Standards</a>:</p>

<ul>
<li>XXXX</li>
</ul>
<p>This release is a patch release and does not include any changes arising from a decision of the Chair</p>
<h2 id='introduction'>Introduction</h2>
<p>No changes</p>
<table><thead>
<tr>
<th>Change</th>
<th>Description</th>
<th>Link</th>
</tr>
</thead><tbody>
<tr>
<td>Binding Statement</td>
<td>Added binding statement to the Introduction section</td>
<td><a href="../../#introduction">Introduction</a></td>
</tr>
<tr>
<td>Align Obligation Dates</td>
<td>Corrections to the future dated obligations table</td>
<td><a href="../../#future-dated-obligations">FDOs</a></td>
</tr>
<tr>
<td>Align Obligation Dates</td>
<td>Corrections to the obligation dates table</td>
<td><a href="../endpoint-version-schedule/#obligation-dates-schedule">Obligations Table</a></td>
</tr>
<tr>
<td>Fix Binding Date</td>
<td>Correct the binding date for Get Energy Account Detail V2 in the end point schedule</td>
<td><a href="../endpoint-version-schedule/#endpoint-version-schedule">FDOs</a></td>
</tr>
</tbody></table>
<h2 id='high-level-standards'>High Level Standards</h2>
<p>No changes</p>
<h2 id='api-end-points'>API End Points</h2>
Expand All @@ -272,9 +299,9 @@ <h2 id='api-end-points'>API End Points</h2>
</tr>
</thead><tbody>
<tr>
<td>XXXX</td>
<td>XXXX</td>
<td>XXXX</td>
<td>Meta Objects Optional</td>
<td>Made the meta object in requests and non-list responses optional for energy APIs to align with decisions</td>
<td><a href="../../#energy-apis">Energy APIs</a></td>
</tr>
</tbody></table>
<h2 id='information-security-profile'>Information Security Profile</h2>
Expand Down
14 changes: 7 additions & 7 deletions docs/includes/swagger/cds_energy.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4737,7 +4737,7 @@
"$ref" : "#/components/schemas/Meta"
}
},
"required" : [ "data", "meta" ],
"required" : [ "data" ],
"type" : "object"
}
}
Expand Down Expand Up @@ -4767,7 +4767,7 @@
"$ref" : "#/components/schemas/Meta"
}
},
"required" : [ "data", "meta" ],
"required" : [ "data" ],
"type" : "object"
}
}
Expand Down Expand Up @@ -5285,7 +5285,7 @@
"$ref" : "#/components/schemas/Meta"
}
},
"required" : [ "data", "links", "meta" ],
"required" : [ "data", "links" ],
"type" : "object"
},
"EnergyAccountListResponseV2" : {
Expand Down Expand Up @@ -5315,7 +5315,7 @@
"$ref" : "#/components/schemas/Meta"
}
},
"required" : [ "data", "links", "meta" ],
"required" : [ "data", "links" ],
"type" : "object"
},
"EnergyPaymentScheduleResponse" : {
Expand All @@ -5330,7 +5330,7 @@
"$ref" : "#/components/schemas/Meta"
}
},
"required" : [ "data", "links", "meta" ],
"required" : [ "data", "links" ],
"type" : "object"
},
"EnergyConcessionsResponse" : {
Expand All @@ -5345,7 +5345,7 @@
"$ref" : "#/components/schemas/Meta"
}
},
"required" : [ "data", "links", "meta" ],
"required" : [ "data", "links" ],
"type" : "object"
},
"EnergyBalanceListResponse" : {
Expand Down Expand Up @@ -5375,7 +5375,7 @@
"$ref" : "#/components/schemas/Meta"
}
},
"required" : [ "data", "links", "meta" ],
"required" : [ "data", "links" ],
"type" : "object"
},
"EnergyInvoiceListResponse" : {
Expand Down
Loading

0 comments on commit 58d264f

Please sign in to comment.