Skip to content

Commit

Permalink
Merge pull request #154 from ConsumerDataStandardsAustralia/maintenan…
Browse files Browse the repository at this point in the history
…ce/448

Standards Maintenance Issue #448:
  • Loading branch information
JamesMBligh authored May 22, 2022
2 parents 945e36f + 246952c commit 252b0ff
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 0 deletions.
7 changes: 7 additions & 0 deletions slate/source/includes/_energy_apis.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@ This specification defines the APIs for Data Holders exposing Energy endpoints.


```diff
Below are the changes to the Energy APIs section of the
standards.

The following minor corrections have been made:

* The `percentOfBill`. `percentOfUse`, `fixedAmount` and `percentOverThreshold` fields in `EnergyPlanDiscounts` model have been made condtitional

The following objects were added to EnergyBillingOtherTransaction model
+ calculationFactors
+ adjustments
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ This release addresses the following change requests raised on [Standards Mainte
- [Standards Maintenance Issue 476: Modify Energy concessions structure to allow non-fixed (e.g. daily, monthly etc.) concessions](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/476)
- [Standards Maintenance Issue 488: Data holder behaviour clarification required when receiving registrations with unsupported authorisation scopes](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/488)
- [Standards Maintenance Issue 465: Confirm Register API 2022 release dates](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/465)
- [Standards Maintenance Issue 448: EnergyPlanDiscounts contains optional fields that should be conditional](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/448)


### Decision Proposals
Expand All @@ -53,6 +54,7 @@ This release addresses the following Decision Proposals published on [Standards]

|Change|Description|Link|
|------|-----------|----|
| Energy schema | [**Standards Maintenance #448**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/448): Changed percentOfBill, percentOfUse, fixedAmount and percentOverThreshold attributes from optional to conditional within [EnergyPlanDiscounts](../../#tocSenergyplandiscounts) schema | [Energy Schema](../../#energy-apis) |
| Energy schema | [**Standards Maintenance #438**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/438): Added 'calculationFactors' and 'adjustments' objects to ['EnergyBillingOtherTransaction'](../../#tocSenergybillingothertransaction) model to allow consistent representation of any calculation factors (i.e. DLF or MLF) used for deriving other charges and any adjustments arising from other types of charges such as environmental charge. | [Energy Schema](../../#energy-apis) |
| Register APIs | [**Standards Maintenance #501**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/501): `x-v` header requirements for versioned Register APIs moved from mandatory to optional | [Register APIs](../../index.html#register-apis) |
| Energy schema | [**Standards Maintenance #457**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/457) Made EnergyServicePointDetail.meters.registers.registerSuffix field optional | [Energy Schema](../../#energy-apis) |
Expand Down
1 change: 1 addition & 0 deletions swagger-gen/api/cds_energy.json
Original file line number Diff line number Diff line change
Expand Up @@ -894,6 +894,7 @@
"items": {
"type": "object",
"required": ["displayName", "type", "methodUType"],
"x-conditional": ["percentOfBill", "percentOfUse", "fixedAmount", "percentOverThreshold"],
"properties": {
"displayName": {
"type": "string",
Expand Down

0 comments on commit 252b0ff

Please sign in to comment.