ConsumerDataStandardsAustralia / standards-maintenance

This repository houses the interactions, consultations and work management to support the maintenance of baselined components of the Consumer Data Right API Standards and Information Security profile.

41 stars 9 forks source link

Documentation Improvement: EnergyPlanContract.variation #461

Closed DannyDuong closed 2 years ago

DannyDuong commented 2 years ago

Description

The EnergyPlanContract.variation is a conditional field, but the condition described is wrong and needs to be corrected.

Area Affected

Energy APIs - Get Generic Plan Detail

Change Proposed

Change the Properties Description for the EnergyPlanContract.variation field.

From: Free text description of price variation policy and conditions for the contract. Mandatory if isFixed is true

To: The Free text description of price variation policy and conditions for the contract. Mandatory if isFixed is false

CDR-API-Stream commented 2 years ago

This CR is now included in MI11. This is a result of re-prioritisation work the DSB carried out as per action raised in MI11 session on 25th May.

This will be addressed as documentation fix as part of CR https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/511.

CDR-API-Stream commented 2 years ago

This change has been staged for review: https://github.com/ConsumerDataStandardsAustralia/standards-staging/compare/release/1.18.0...maintenance/461

CDR-API-Stream commented 2 years ago

This change was incorporated into release v1.18.0. Refer to Decision 249 for further details.