diff --git a/jars/openapi-codegen/openapi-generator-cli.jar b/jars/openapi-codegen/openapi-generator-cli-6.6.0.jar similarity index 53% rename from jars/openapi-codegen/openapi-generator-cli.jar rename to jars/openapi-codegen/openapi-generator-cli-6.6.0.jar index 5d4736941..a7b8736b3 100644 Binary files a/jars/openapi-codegen/openapi-generator-cli.jar and b/jars/openapi-codegen/openapi-generator-cli-6.6.0.jar differ diff --git a/slate/source/includes/_banking_apis.md.erb b/slate/source/includes/_banking_apis.md.erb index dc20b7433..d35f9afc5 100644 --- a/slate/source/includes/_banking_apis.md.erb +++ b/slate/source/includes/_banking_apis.md.erb @@ -1,6 +1,8 @@ # Banking APIs - +```diff +Updated styling of field names in the description of the 'effective' parameter of Get Products and 'type' parameter of Get Payees. +``` This specification defines the APIs for Data Holders exposing Banking endpoints. diff --git a/slate/source/includes/_energy_apis.md.erb b/slate/source/includes/_energy_apis.md.erb index 5524d3c3b..9cd000896 100644 --- a/slate/source/includes/_energy_apis.md.erb +++ b/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. @@ -8,6 +15,7 @@ This specification defines the APIs for Data Holders exposing Energy endpoints.
Energy OpenAPI Specification (YAML)
- - +```diff +Corrected mistake in the timeVaryingTariffs schema which specified amount as a required property +``` <%= partial "includes/cds_energy.md" %> diff --git a/slate/source/includes/additional.md b/slate/source/includes/additional.md index 9e661f85f..3d59bc53b 100644 --- a/slate/source/includes/additional.md +++ b/slate/source/includes/additional.md @@ -1,7 +1,5 @@ # Additional Standards - - The Consumer Data Standards also incorporate other non-binding standards that are developed to facilitate consultation and feedback or to facilitate voluntary extension of CDR implementations. These standards fall into three categories: @@ -12,9 +10,13 @@ These standards fall into three categories: ## Candidate Standards +```diff +Updated Telco specification to ensure response header details are displayed correctly +``` + The Consumer Data Standards currently include the following Candidate Standards: -- [Candidate Standards for the Telecommunications sector](./includes/additional/candidates/telco.html) +- [Candidate Standards for the Telecommunications sector](./includes/additional/candidates/telco/telco.html) - [Candidate Standards for Banking Decision Proposal 306](./includes/additional/candidates/dp306/banking-dp306.html) - [Candidate Standards for the Banking and Non-Bank Lending sector](./includes/additional/candidates/non-bank-lending/banking-non-bank-lending.html) diff --git a/slate/source/includes/additional/candidates/telco.html.md b/slate/source/includes/additional/candidates/telco/telco.html.md similarity index 68% rename from slate/source/includes/additional/candidates/telco.html.md rename to slate/source/includes/additional/candidates/telco/telco.html.md index 93103bd61..2c35371f5 100644 --- a/slate/source/includes/additional/candidates/telco.html.md +++ b/slate/source/includes/additional/candidates/telco/telco.html.md @@ -6,11 +6,11 @@ language_tabs: - diff: Version Delta toc_footers: - - Consumer Data Standards + - Consumer Data Standards includes: - additional/candidates/candidate_header - - additional/candidates/telco_apis + - additional/candidates/telco/telco_apis - cds_telco search: true diff --git a/slate/source/includes/additional/candidates/telco/telco_apis.md b/slate/source/includes/additional/candidates/telco/telco_apis.md new file mode 100644 index 000000000..715980c77 --- /dev/null +++ b/slate/source/includes/additional/candidates/telco/telco_apis.md @@ -0,0 +1,10 @@ +This specification defines the APIs for Data Holders exposing Telecommunications endpoints. + +```diff +Updated Telco specification to ensure response header details are displayed correctly +``` + + + + +
Telco OpenAPI Specification (JSON)
Telco OpenAPI Specification (YAML)
diff --git a/slate/source/includes/additional/candidates/telco_apis.md b/slate/source/includes/additional/candidates/telco_apis.md deleted file mode 100644 index deea765d6..000000000 --- a/slate/source/includes/additional/candidates/telco_apis.md +++ /dev/null @@ -1,8 +0,0 @@ -This specification defines the APIs for Data Holders exposing Telecommunications endpoints. - - - - - - -
Telco OpenAPI Specification (JSON)
Telco OpenAPI Specification (YAML)
diff --git a/slate/source/includes/archives.md b/slate/source/includes/archives.md deleted file mode 100644 index 2e047b39d..000000000 --- a/slate/source/includes/archives.md +++ /dev/null @@ -1,51 +0,0 @@ -# Archives - - - -The following table lists archived versions of the Consumer Data Standards. These are older versions of the standards that are available for reference only. They are not considered binding. - -|Release Date|Version|Description| -|-------------|-------|-----------| -|03/07/2024 | 1.31.0 | Changes from Maintenance Iteration 19 | -|24/04/2024 | 1.30.0 | Changes from maintenance iteration 18 | -|28/02/2024 | 1.29.1 | Patch release fixing minor issues | -|21/12/2023 | 1.29.0 | Changes from maintenance iteration 17. Also includes CX Standards changes to uplift Data Holder Dashboards and accommodate Business Consumers | -|10/11/2023 | 1.28.0 | Candidate standards arising from Decision 306 and updated draft non-bank lending standards | -|10/10/2023 | 1.27.0 | Changes arising from Decision 313 (Maintenance Iteration 16) | -|24/08/2023 | 1.26.0 | Changes to obligations for the implementation of Get Metrics | -|08/07/2023|1.25.0|Changes arising from Decision 303 (Maintenance iteration 15) and Decision 288 (Metrics and NFRs)| -|07/05/2023|1.24.0|Changes arising from Decision 281 (Maintenance iteration 14)| -|24/04/2023|1.23.0|Changes arising from Decision Proposal 298| -|22/03/2023|1.22.1|Patch release including updates to draft Telco standards| -|22/12/2022|1.22.0|Changes arising from Decision 271 (Maintenance iteration 13)| -|16/12/2022|1.21.0|Changes arising from Decision 282| -|13/11/2022|1.20.0|Changes arising from Decision 259 (Maintenance iteration 12)| -|13/09/2022|1.19.0|Changes arising from Decision 260 (Energy Closed Accounts)| -|11/08/2022|1.18.0|Changes arising from Decision 249 (Maintenance Iteration 11)| -|23/05/2022|1.17.0|Changes arising from Decision 237 (Maintenance Iteration 10)| -|22/03/2022|1.16.1|Minor errata and documentation fixes. Update of swagger files to OAS3| -|04/02/2022|1.16.0|Changes arising from Decision 222 (Insights and Trusted Adviser Disclosure Consents CX Standards)| -|23/12/2021|1.15.0|Changes arising from Decision 199, 162, 209, 216 and 212
See [Decision 199 (Binding Energy Standards)](https://github.com/ConsumerDataStandardsAustralia/standards/issues/199), [Decision 162 (Joint Account CX standards)](https://github.com/ConsumerDataStandardsAustralia/standards/issues/162), [Decision 209 (FAPI 1.0 migration)](https://github.com/ConsumerDataStandardsAustralia/standards/issues/209), [Decision 216 (OIDC Profile Scope)](https://github.com/ConsumerDataStandardsAustralia/standards/issues/216) and [Decision 212 (Maintenance Iteration 9 change requests)](https://github.com/ConsumerDataStandardsAustralia/standards/issues/212) for details| -|29/10/2021|1.14.0|Inclusion of full candidate level standards for the energy sector| -|22/10/2021|1.13.0|Changes arising from Decisions 206 (Register Standards), 191 and 192| -|22/10/2021|1.12.0|Inclusion of a series of decisions related to energy and non-functional requirements| -|05/10/2021|1.11.1|Changes arising from Decision Proposals 193 and 208. See [Decision 193](https://github.com/ConsumerDataStandardsAustralia/standards/issues/193) and [Decision 208](https://github.com/ConsumerDataStandardsAustralia/standards/issues/208) for details | -|30/06/2021|1.11.0|Changes arising from Decision Proposals 160, 187 and maintenance iteration 7 Decision Proposal 178. See [Decision 160](https://github.com/ConsumerDataStandardsAustralia/standards/issues/160), [Decision 187](https://github.com/ConsumerDataStandardsAustralia/standards/issues/187) and [Decision 178](https://github.com/ConsumerDataStandardsAustralia/standards/issues/178) for details | -|01/06/2021|1.10.0|Changes arising from Enhanced Error Handling decision proposals. See [Decision 154](https://github.com/ConsumerDataStandardsAustralia/standards/issues/154) for details | -|29/04/2021|1.9.0|Changes arising from the sixth Data Standards Maintenance Iteration related to [Decision 161](https://github.com/ConsumerDataStandardsAustralia/standards/issues/161) | -|16/04/2021|1.8.0|CX Standards for Amending Consent related to [Decision 144](https://github.com/ConsumerDataStandardsAustralia/standards/issues/144) -|10/03/2021|1.7.0|Banking Maintenance Iteration 5 and related changes arising from [Decision 159](https://github.com/ConsumerDataStandardsAustralia/standards/issues/159) -|23/12/2020|1.6.0|Update to audience claim for client authentication arising from Decision Proposal 325 -|25/9/2020|1.5.1|Revert 1.5.0 CRN update -|16/9/2020|1.5.0|Banking Maintenance Iteration 4 Release -|12/8/2020|1.4.0|Banking Maintenance Iteration 3 Release -|22/5/2020|1.3.1|May Banking Maintenance Iteration 2 Release| -|17/4/2020|1.3.0|April 1.3.0 Release| -|31/1/2020|1.2.0|January 1.2.0 Release| -|30/9/2019|1.0.0|September 1.0.0 Release| -|4/9/2019|0.9.6|September fixes update| -|15/7/2019|0.9.5|July 2019 Working Draft| -|29/5/2019|0.9.3|May 2019 Working Draft| -|18/12/2018|0.1.0|Christmas 2018 Working Draft - InfoSec Profile| -|18/12/2018|0.2.0|Christmas 2018 Working Draft - Standards| -|2/11/2018|0.1.0|November 2018 Working Draft| diff --git a/slate/source/includes/banking/_product_categories.md b/slate/source/includes/banking/_product_categories.md index c6c713b91..2e1cb5bf7 100644 --- a/slate/source/includes/banking/_product_categories.md +++ b/slate/source/includes/banking/_product_categories.md @@ -2,7 +2,7 @@ -The [Product Category enumeration](#cdr-banking-api_schemas_tocSbankingproductcategory) lists the available product categories for categorising products and accounts. These are explained in the following tables: +The [_productCategory_ enumeration](#cdr-banking-api_schemas_tocSbankingproductcategory) lists the available product categories for categorising products and accounts. These are explained in the following tables: **Deposit Products** @@ -10,7 +10,7 @@ The [Product Category enumeration](#cdr-banking-api_schemas_tocSbankingproductca |----|-----------| |REGULATED_TRUST_ACCOUNTS|This grouping of products includes accounts were funds are held in trust in regulated industries with complex rules embedded on how the products must operate. Industries that require this sort of product include real estate agents, solicitors and conveyancers.| |TERM_DEPOSITS|This grouping of products includes all accounts where cash is deposited in the account for a set time period with restrictions on when funds can be withdrawn. Includes traditional Term Deposits and specialised deposits with either fixed terms or notice periods for withdrawal of funds.| -|TRANS_AND_SAVINGS_ACCOUNTS|This grouping of products includes all accounts where cash is deposited in the account and is accessible to the customer when they choose. These are given many names on the market including Cash Accounts, Saving Accounts, Transaction Accounts, Current Accounts, Cheque Accounts, Passbook Accounts, etc...| +|TRANS_AND_SAVINGS_ACCOUNTS|This grouping of products includes all accounts where cash is deposited in the account and is accessible to the customer when they choose. These are given many names on the market including Cash Accounts, Saving Accounts, Transaction Accounts, Current Accounts, Cheque Accounts, Passbook Accounts, etc.| |TRAVEL_CARDS|This grouping of products includes prepaid cards with multi-currency capabilities.| **Lending Products** @@ -19,7 +19,7 @@ The [Product Category enumeration](#cdr-banking-api_schemas_tocSbankingproductca |----|-----------| |BUSINESS_LOANS|This grouping of products incorporates all types of lending for business purpose that is not a trade finance facility, lease, overdraft, residential mortgage, credit card or margin lending. It includes traditional term loans, bank guarantees and commercial bills. This category would incorporate both secured and unsecured business purpose lending including all business purpose equipment finance that is not covered by a lease.| |CRED_AND_CHRG_CARDS|This grouping of products includes all lending products that are issued for the purpose of allowing a flexible line of credit accessed through use of a card. These may be called various names including Credit Cards, Charge Cards and Store Cards.| -|LEASES|This grouping of products will include all types of leases including Financial Lease, Operating Lease, Sale and leaseback, etc...| +|LEASES|This grouping of products will include all types of leases including Financial Lease, Operating Lease, Sale and leaseback, etc.| |MARGIN_LOANS|This grouping of products includes all types of margin loans which let you borrow money to invest in traded assets including shares & commodities or in managed funds.| |OVERDRAFTS|This grouping of products includes all types of lending which allows for the loan amount to be withdrawn, repaid, and redrawn again in any manner and any number of times, until the arrangement expires. These loans may be secured or unsecured, and generally don’t have set / minimum repayment requirements.| |PERS_LOANS|This grouping of products includes all lending for personal purposes that is not a residential mortgage, credit card or margin lending. These loans may be unsecured loans and term loans for purchase assets used as security such as motor vehicles. These may be called various names including Personal Loans and Car Loans.| diff --git a/slate/source/includes/banking/_product_components.md b/slate/source/includes/banking/_product_components.md index 6a2b44c52..aec45c50b 100644 --- a/slate/source/includes/banking/_product_components.md +++ b/slate/source/includes/banking/_product_components.md @@ -3,217 +3,224 @@

Product Feature Types

-Description of the usage of the featureType field as it applies to products. - - -|Value|Description|Use of additionalValue Field| -|-----|-----------|----------------------------| -|ADDITIONAL_CARDS|Additional cards can be requested|The maximum number of additional cards. If no maximum then should be set to null| -|BALANCE_TRANSFERS|Balance transfers can be made to the account (eg. for credit cards)|NA| -|BILL_PAYMENT|The product can be attached to an automatic budgeting and bill payment service|Optional name of the service| -|BONUS_REWARDS|Bonus loyalty rewards points are available|Number of points available| -|CARD_ACCESS|A card is available for the product to access funds|Text describing list of card types that this product can be linked to| -|CASHBACK_OFFER | Subject to terms, conditions and eligibility criteria, the product has a cashback offer for opening an account or by spending at a certain retailer. | The amount of the cashback offer (in AUD) | -|COMPLEMENTARY_PRODUCT_DISCOUNTS|Indicates that complementary, discounted offerings (such as gift cards, or discounted travel) is available|Description of the complementary offering| -|DIGITAL_BANKING|Access is available to online banking features for the product|NA| -|DIGITAL_WALLET|A Digital wallet can be attached to the product|The name or brand of the wallet| -|DONATE_INTEREST|Indicates that interest generated from the product can be automatically donated to a charity or community group|NA| -|EXTRA_REPAYMENTS|Indicates that the product has the option to accept extra repayments without incurring additional charges (for example Buy Now, Pay Later (BNPL) or line of credit products may offer the facility to repay instalments on an adhoc basis).|NA| -|FRAUD_PROTECTION | The product includes fraud protection features. | NA | -|FREE_TXNS|A set number of free transactions available per month|The number of free transactions| -|FREE_TXNS_ALLOWANCE|A set amount of transaction fee value that is discounted per month|The amount of transaction fee discounted (in AUD)| -|GUARANTOR | Subject to terms and conditions, the customer may be able to nominate a guarantor during the origination process. | NA | -|INSURANCE|Insurance is provided as an additional feature of the product|Text description of the type of insurance (e.g. Travel Insurance)| -|INSTALMENT_PLAN | The product has the option to pay for eligible purchases over time with a set number of payments. | NA | -|INTEREST_FREE|Interest free period for purchases|Interest free period. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)| -|INTEREST_FREE_TRANSFERS|Interest free period for balance transfers|Interest free period. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)| -|LOYALTY_PROGRAM|A points based loyalty program is available|Name of the loyalty program| -|NOTIFICATIONS|Advanced notifications are available for the product|Description of the notification capability| -|NPP_ENABLED|An account of this product type can be used to receive funds as a result of a BSB/Number based NPP payment|NA| -|NPP_PAYID|An account of this product type can be used as the target of an NPP PayID|NA| -|OFFSET|An offset account can be connected to the product|NA| -|OTHER|Another feature that can not be included in any of the other categories. The additionalInfo field is mandatory for this type|NA| -|OVERDRAFT|An overdraft can be applied for|NA| -|REDRAW|Redraw of repaid principal above minimum required is available|NA| -|RELATIONSHIP_MANAGEMENT | Relationship management is available for eligible customers. | NA | -|UNLIMITED_TXNS|Unlimited free transactions available|NA| +```diff +Updated styling of text referring to field names and values and added links to common field types +``` + +Description of the usage of the _featureType_ field as it applies to products. + +| Value | Description | Use of _additionalValue_ Field | +| ----- | ----------- | ---------------------------- | +| ADDITIONAL_CARDS | Additional cards can be requested. | The maximum number of additional cards. If no maximum then should be set to `null`. | +| BALANCE_TRANSFERS | Balance transfers can be made to the account (e.g., for credit cards). | N/A | +| BILL_PAYMENT | The product can be attached to an automatic budgeting and bill payment service. | Optional name of the service. | +| BONUS_REWARDS | Bonus loyalty rewards points are available. | Number of points available. | +| CARD_ACCESS | A card is available for the product to access funds. | Text describing list of card types that this product can be linked to. | +| CASHBACK_OFFER | Subject to terms, conditions and eligibility criteria, the product has a cashback offer for opening an account or by spending at a certain retailer. | The amount of the cashback offer (in AUD). | +| COMPLEMENTARY_PRODUCT_DISCOUNTS | Indicates that complementary, discounted offerings (such as gift cards, or discounted travel) is available. | Description of the complementary offering. | +| DIGITAL_BANKING | Access is available to online banking features for the product. | N/A | +| DIGITAL_WALLET | A Digital wallet can be attached to the product. | The name or brand of the wallet. | +| DONATE_INTEREST | Indicates that interest generated from the product can be automatically donated to a charity or community group. | N/A | +| EXTRA_REPAYMENTS | Indicates that the product has the option to accept extra repayments without incurring additional charges (for example Buy Now, Pay Later (BNPL) or line of credit products may offer the facility to repay instalments on an adhoc basis). | N/A | +| FRAUD_PROTECTION | The product includes fraud protection features. | N/A | +| FREE_TXNS | A set number of free transactions available per month. | The number of free transactions. | +| FREE_TXNS_ALLOWANCE | A set amount of transaction fee value that is discounted per month. | The amount of transaction fee discounted (in AUD). | +| GUARANTOR | Subject to terms and conditions, the customer may be able to nominate a guarantor during the origination process. | N/A | +| INSURANCE | Insurance is provided as an additional feature of the product. | Text description of the type of insurance (e.g., Travel Insurance). | +| INSTALMENT_PLAN | The product has the option to pay for eligible purchases over time with a set number of payments. | N/A | +| INTEREST_FREE | Interest free period for purchases. | Interest free period. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations). | +| INTEREST_FREE_TRANSFERS | Interest free period for balance transfers. | Interest free period. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations). | +| LOYALTY_PROGRAM | A points based loyalty program is available. | Name of the loyalty program. | +| NOTIFICATIONS | Advanced notifications are available for the product. | Description of the notification capability. | +| NPP_ENABLED | An account of this product type can be used to receive funds as a result of a BSB/Number based NPP payment. | N/A | +| NPP_PAYID | An account of this product type can be used as the target of an NPP PayID. | N/A | +| OFFSET | An offset account can be connected to the product. | N/A | +| OTHER | Another feature that can not be included in any of the other categories. The _additionalInfo_ field is mandatory for this type. | N/A | +| OVERDRAFT | An overdraft can be applied for. | N/A | +| REDRAW | Redraw of repaid principal above minimum required is available. | N/A | +| RELATIONSHIP_MANAGEMENT | Relationship management is available for eligible customers. | N/A | +| UNLIMITED_TXNS | Unlimited free transactions available. | N/A |

Product Constraint Types

-Description of the usage of the constraintType field as it applies to products. +Description of the usage of the _constraintType_ field as it applies to products. -|Value|Description|Use of additionalValue Field| -|-----|-----------|----------------------------| -|MAX_BALANCE|A maximum balance is required for the product|The maximum balance in AmountString format| -|MAX_LIMIT|A maximum limit exists (such as a maximum loan balance denoting the borrowable amount or maximum allowable credit limit)|The maximum limit in AmountString format| -|MIN_BALANCE|A minimum balance is required for the product|The minimum balance in AmountString format| -|MIN_LIMIT|A minimum limit exists (such as a minimum loan balance denoting the borrowable amount or minimum credit limit)|The minimum limit in AmountString format| -|OPENING_BALANCE|An opening balance is required for the product|The minimum opening balance in AmountString format| +| Value | Description | Use of _additionalValue_ Field | +| ----- | ----------- | ---------------------------- | +| MAX_BALANCE | A maximum balance is required for the product. | The maximum balance in [AmountString](#common-field-types) format. | +| MAX_LIMIT | A maximum limit exists (such as a maximum loan balance denoting the borrowable amount or maximum allowable credit limit). | The maximum limit in [AmountString](#common-field-types) format. | +| MIN_BALANCE | A minimum balance is required for the product. | The minimum balance in [AmountString](#common-field-types) format. | +| MIN_LIMIT | A minimum limit exists (such as a minimum loan balance denoting the borrowable amount or minimum credit limit). | The minimum limit in [AmountString](#common-field-types) format. | +| OPENING_BALANCE | An opening balance is required for the product. | The minimum opening balance in [AmountString](#common-field-types) format. |

Product Eligibility Types

-Description of the usage of the eligibilityType field as it applies to products. +Description of the usage of the _eligibilityType_ field as it applies to products. -|Value|Description|Use of additionalValue Field| -|-----|-----------|----------------------------| -|BUSINESS|Only business may apply for the account|NA| -|EMPLOYMENT_STATUS|An eligibility constraint based on employment status applies|A description of the status required| -|MAX_AGE|Only customers younger than a maximum age may apply|The maximum age in years| -|MIN_AGE|Only customers older than a minimum age may apply|The minimum age in years| -|MIN_INCOME|The customer must have an income greater than a specified threshold to obtain the product|Minimum income in AmountString format| -|MIN_TURNOVER|Only a business with greater than a minimum turnover may apply|Minimum turnover in AmountString format| -|NATURAL_PERSON|The customer must be a natural person rather than another legal entity|NA| -|OTHER|Another eligibility criteria exists as described in the additionalInfo field (if this option is specified then the additionalInfo field is mandatory)|NA| -|PENSION_RECIPIENT|Only a recipient of a government pension may apply for the product|NA| -|RESIDENCY_STATUS|An eligibility constraint based on residency status applies|A description of the status required| -|STAFF|Only a staff member of the provider may apply|NA| -|STUDENT|Only students may apply for the product|NA| +| Value | Description | Use of _additionalValue_ Field | +| ----- | ----------- | ---------------------------- | +| BUSINESS | Only business may apply for the account. | N/A | +| EMPLOYMENT_STATUS | An eligibility constraint based on employment status applies. | A description of the status required. | +| MAX_AGE | Only customers younger than a maximum age may apply. | The maximum age in years. | +| MIN_AGE | Only customers older than a minimum age may apply. | The minimum age in years. | +| MIN_INCOME | The customer must have an income greater than a specified threshold to obtain the product. | Minimum income in [AmountString](#common-field-types) format. | +| MIN_TURNOVER | Only a business with greater than a minimum turnover may apply. | Minimum turnover in [AmountString](#common-field-types) format. | +| NATURAL_PERSON | The customer must be a natural person rather than another legal entity. | N/A | +| OTHER | Another eligibility criteria exists as described in the _additionalInfo_ field (if this option is specified then the _additionalInfo_ field is mandatory). | N/A | +| PENSION_RECIPIENT | Only a recipient of a government pension may apply for the product. | N/A | +| RESIDENCY_STATUS | An eligibility constraint based on residency status applies. | A description of the status required. | +| STAFF | Only a staff member of the provider may apply. | N/A | +| STUDENT | Only students may apply for the product. | N/A |

Product Fee Types

-Description of the usage of the feeType field as it applies to products. +Description of the usage of the _feeType_ field as it applies to products. -|Value|Description|Use of additionalValue Field| -|-----|-----------|----------------------------| -|DEPOSIT|A fee associated with making a deposit|NA| -|EVENT|A fee in relation to a particular event (e.g. ordering a new card, viewing a balance or stopping a cheque)|NA| -|EXIT|A fee for closing the product|NA| -|PAYMENT|A fee associated with making a payment|NA| -|PERIODIC|A periodic fee such as a monthly account servicing fee|The period of charge. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)| -|PURCHASE|A fee associated with making a purchase at a merchant|NA| -|TRANSACTION|A fee associated with any transaction (incorporates WITHDRAWAL, DEPOSIT, PAYMENT and PURCHASE)|NA| -|UPFRONT|A fee paid at the beginning of the product lifecycle, such as an establishment fee, loyalty program fee or application fee|NA| -|VARIABLE|An at-cost fee that is relevant to a customer's circumstances where the amount or rate may not be known until negotiated with the customer|NA| -|WITHDRAWAL|A fee associated with making a withdrawal|NA| +| Value | Description | Use of _additionalValue_ Field | +| ----- | ----------- | ---------------------------- | +| DEPOSIT | A fee associated with making a deposit. | N/A | +| EVENT | A fee in relation to a particular event (e.g., ordering a new card, viewing a balance or stopping a cheque). | N/A | +| EXIT | A fee for closing the product. | N/A | +| PAYMENT | A fee associated with making a payment. | N/A | +| PERIODIC | A periodic fee such as a monthly account servicing fee. | The period of charge. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations). | +| PURCHASE | A fee associated with making a purchase at a merchant. | N/A | +| TRANSACTION | A fee associated with any transaction (incorporates `WITHDRAWAL`, `DEPOSIT`, `PAYMENT` and `PURCHASE`). | N/A | +| UPFRONT | A fee paid at the beginning of the product lifecycle, such as an establishment fee, loyalty program fee or application fee. | N/A | +| VARIABLE | An at-cost fee that is relevant to a customer's circumstances where the amount or rate may not be known until negotiated with the customer. | N/A | +| WITHDRAWAL | A fee associated with making a withdrawal. | N/A |

Product Discount Types

-Description of the usage of the discountType field as it applies to products. +Description of the usage of the _discountType_ field as it applies to products. -|Value|Description|Use of additionalValue Field| -|-----|-----------|----------------------------| -|BALANCE|Discount on a fee for maintaining a set balance. As the discount applies to a fee the period is the same as for the fee|The minimum balance in AmountString format| -|DEPOSITS|Discount for depositing a certain amount of money in a period. As the discount applies to a fee the period is the same as for the fee|The minimum deposit amount in AmountString format| -|ELIGIBILITY_ONLY|Discount applies based on customer eligibility (eligibility array must be populated)|N/A| -|FEE_CAP|The amount, balanceRate, transactionRate, accruedRate or feeRate fields of the discount represent the maximum amount charged in a time period|The time period for which the fee cap applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)| -|PAYMENTS|Discount for outbound payments from the account under a certain amount of money in a period. As the discount applies to a fee the period is the same as for the fee|The payment threshold amount in AmountString format| +| Value | Description | Use of _additionalValue_ Field | +| ----- | ----------- | ---------------------------- | +| BALANCE | Discount on a fee for maintaining a set balance. As the discount applies to a fee the period is the same as for the fee. | The minimum balance in [AmountString](#common-field-types) format. | +| DEPOSITS | Discount for depositing a certain amount of money in a period. As the discount applies to a fee the period is the same as for the fee. | The minimum deposit amount in [AmountString](#common-field-types) format. | +| ELIGIBILITY_ONLY | Discount applies based on customer eligibility (_eligibility_ array must be populated). | N/A | +| FEE_CAP | The _amount_, _balanceRate_, _transactionRate_, _accruedRate_ or _feeRate_ fields of the discount represent the maximum amount charged in a time period. | The time period for which the fee cap applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations). | +| PAYMENTS | Discount for outbound payments from the account under a certain amount of money in a period. As the discount applies to a fee the period is the same as for the fee. | The payment threshold amount in [AmountString](#common-field-types) format. |

Product Discount Eligibility Types

-Description of the usage of the discountEligibilityType field as it applies to products. - -|Value|Description|Use of additionalValue Field| -|-----|-----------|----------------------------| -|BUSINESS|A business or other non-person legal entity|NA| -|EMPLOYMENT_STATUS|An eligibility constraint based on employment status applies|A description of the status required| -|INTRODUCTORY|The discount is only available during an introductory period|The period of time for the introductory discount. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)| -|MAX_AGE|Only customers younger than a maximum age receive the discount|The maximum age in years -|MIN_AGE|Only customers older than a minimum age receive the discount|The minimum age in years| -|MIN_INCOME|The customer must have an income greater than a specified threshold to obtain the discount|Minimum income in AmountString format| -|MIN_TURNOVER|Only a business with greater than a minimum turnover is eligible|Minimum turnover in AmountString format| -|NATURAL_PERSON|The customer must be a natural person rather than another legal entity|NA| -|OTHER|Another eligibility criteria exists as described in the additionalInfo field (if this option is specified then the additionalInfo field is mandatory)|NA| -|PENSION_RECIPIENT|Only a recipient of a government pension may receive the discount|Optional. Should contain a description of which pensions qualify| -|RESIDENCY_STATUS|An eligibility constraint based on residency status applies|A description of the status required| -|STAFF|Only a staff member of the provider may receive the discount|NA| -|STUDENT|Only students may receive the discount|Optional. Should contain a description of who qualifies as a student, e.g. do apprentices qualify?| +Description of the usage of the _discountEligibilityType_ field as it applies to products. +| Value | Description | Use of _additionalValue_ Field | +| ----- | ----------- | ---------------------------- | +| BUSINESS | A business or other non-person legal entity. | N/A | +| EMPLOYMENT_STATUS | An eligibility constraint based on employment status applies. | A description of the status required. | +| INTRODUCTORY | The discount is only available during an introductory period. | The period of time for the introductory discount. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations). | +| MAX_AGE | Only customers younger than a maximum age receive the discount. | The maximum age in years. | +| MIN_AGE | Only customers older than a minimum age receive the discount. | The minimum age in years. | +| MIN_INCOME | The customer must have an income greater than a specified threshold to obtain the discount. | Minimum income in [AmountString](#common-field-types) format. | +| MIN_TURNOVER | Only a business with greater than a minimum turnover is eligible. | Minimum turnover in [AmountString](#common-field-types) format. | +| NATURAL_PERSON | The customer must be a natural person rather than another legal entity. | N/A | +| OTHER | Another eligibility criteria exists as described in the _additionalInfo_ field (if this option is specified then the _additionalInfo_ field is mandatory). | N/A | +| PENSION_RECIPIENT | Only a recipient of a government pension may receive the discount. | Optional. Should contain a description of which pensions qualify. | +| RESIDENCY_STATUS | An eligibility constraint based on residency status applies. | A description of the status required. | +| STAFF | Only a staff member of the provider may receive the discount. | N/A | +| STUDENT | Only students may receive the discount. | Optional. Should contain a description of who qualifies as a student, e.g., do apprentices qualify? |

Product Deposit Rate Types

-Description of the usage of the depositRateType field as it applies to products. +Description of the usage of the _depositRateType_ field as it applies to products. -A deposit product is expected to present a single Base rate corresponding to relevant selection criteria including the rate `tiers` and `additionalValue`, where applicable. +A deposit product is expected to present a single Base rate corresponding to relevant selection criteria including the rate _tiers_ and _additionalValue_, where applicable. + +| Value | Description | Use of _additionalValue_ Field | +| ----- | ----------- | ---------------------------- | +| FIXED | Fixed rate for a period of time. | The period of time fixed. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations). | +| FLOATING | A floating rate is relatively fixed but still adjusts under specific circumstances. | Details of the float parameters. | +| MARKET_LINKED | A rate that is linked to a specific market, commodity or asset class. | Details of the market linkage. | +| VARIABLE | A variable base rate for the product. | N/A | -Value | Description | Use of additionalValue Field --- | -- | -- -FIXED | Fixed rate for a period of time | The period of time fixed. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) -FLOATING | A floating rate is relatively fixed but still adjusts under specific circumstances | Details of the float parameters -MARKET_LINKED | A rate that is linked to a specific market, commodity or asset class | Details of the market linkage -VARIABLE | A variable base rate for the product | NA +```diff +Clarified the format of deposit 'bonus' adjustment rate values +``` + A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate. -Value | Description | Use of additionalValue Field +| Value | Description | Use of _additionalValue_ Field | -- | -- | -- -BONUS | A bonus rate available by meeting a specific criteria | A description of the criteria to obtain the bonus -BUNDLE_BONUS | A bonus rate obtained by originating a bundle instead of a standalone product | The name of the bundle -INTRODUCTORY | An introductory bonus that will expire after a set period | The period of time for the introductory rate. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) - +BONUS | A bonus rate available by meeting a specific criteria. A deposit 'bonus' _rate_ value **MUST** be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base+Bonus). | A description of the criteria to obtain the bonus. +BUNDLE_BONUS | A bonus rate obtained by originating a bundle instead of a standalone product. A deposit 'bonus' _rate_ value **MUST** be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base+Bonus). | The name of the bundle. +INTRODUCTORY | An introductory bonus that will expire after a set period. A deposit 'bonus' _rate_ value **MUST** be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base+Bonus). | The period of time for the introductory rate. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations).

Product Lending Rate Types

-Description of the usage of the lendingRateType field as it applies to products. - +Description of the usage of the _lendingRateType_ field as it applies to products. -A lending product is expected to present a single Base rate corresponding to relevant selection criteria including the rate `tiers` and `additionalValue`, where applicable. +A lending product is expected to present a single Base rate corresponding to relevant selection criteria including the rate _tiers_ and _additionalValue_, where applicable. -Card products may have two or more base rates, including `CASH_ADVANCE` and `PURCHASE` as they may apply to different transaction types within an account. The `PURCHASE` lendingRateType is considered the rate commonly applicable to a card. +Card products may have two or more base rates, including `CASH_ADVANCE` and `PURCHASE` as they may apply to different transaction types within an account. The `PURCHASE` _lendingRateType_ is considered the rate commonly applicable to a card. -Value | Description | Use of additionalValue Field --- | -- | -- -CASH_ADVANCE | Specific rate applied to cash advances from the account. This is expected to apply to products in the `CRED_AND_CHRG_CARDS` category only | NA -FIXED | Fixed rate for a period of time | The period of time fixed. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) -FLOATING | A floating rate is relatively fixed but still adjusts under specific circumstances | Details of the float parameters -MARKET_LINKED | A rate that is linked to a specific market, commodity or asset class | Details of the market linkage -PURCHASE | Specific rate applied to purchases from the account. This is expected to apply to products in the `CRED_AND_CHRG_CARDS` category only | NA -VARIABLE | A variable base rate for the product | NA +| Value | Description | Use of _additionalValue_ Field | +| ----- | ----------- | ---------------------------- | +| CASH_ADVANCE | Specific rate applied to cash advances from the account. This is expected to apply to products in the `CRED_AND_CHRG_CARDS` category only. | N/A | +| FIXED | Fixed rate for a period of time. | The period of time fixed. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations). | +| FLOATING | A floating rate is relatively fixed but still adjusts under specific circumstances. | Details of the float parameters. | +| MARKET_LINKED | A rate that is linked to a specific market, commodity or asset class. | Details of the market linkage. | +| PURCHASE | Specific rate applied to purchases from the account. This is expected to apply to products in the `CRED_AND_CHRG_CARDS` category only. | N/A | +| VARIABLE | A variable base rate for the product. | N/A | +```diff +Clarified the format of lending 'discount' and 'penalty' adjustment rate values +``` + A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate. -Value | Description | Use of additionalValue Field +| Value | Description | Use of _additionalValue_ Field | -- | -- | -- -BUNDLE_DISCOUNT_FIXED | A discount rate off the fixed rate obtained by originating a bundle instead of a standalone product | The name of the bundle -BUNDLE_DISCOUNT_VARIABLE | A discount rate off the variable rate obtained by originating a bundle instead of a standalone product | The name of the bundle -DISCOUNT | A specific discount rate that may be applied. A discount rate reduces the interest payable | Description of the discount rate that is applicable -INTRODUCTORY | An introductory discount that will expire after a set period | The period of time for the introductory rate. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) -PENALTY | A specific penalty rate that may be applied. A penalty rate increases the interest payable | Description of the penalty rate that is applicable +BUNDLE_DISCOUNT_FIXED | A discount rate off the fixed rate obtained by originating a bundle instead of a standalone product. A lending 'discount' _rate_ value **MUST** be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base-Discount). | The name of the bundle. +BUNDLE_DISCOUNT_VARIABLE | A discount rate off the variable rate obtained by originating a bundle instead of a standalone product. A lending 'discount' _rate_ value **MUST** be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base-Discount). | The name of the bundle. +DISCOUNT | A specific discount rate that may be applied. A discount rate reduces the interest payable. A lending 'discount' _rate_ value **MUST** be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base-Discount). | Description of the discount rate that is applicable. +INTRODUCTORY | An introductory discount that will expire after a set period. A lending 'discount' _rate_ value **MUST** be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base-Discount). | The period of time for the introductory rate. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations). +PENALTY | A specific penalty rate that may be applied. A penalty rate increases the interest payable. A lending 'penalty' _rate_ value **MUST** be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base+Penalty). | Description of the penalty rate that is applicable.

Banking Term Deposit Account Types

-Description of the usage of the `maturityInstructions` field as it applies to accounts. - - +Description of the usage of the _maturityInstructions_ field as it applies to accounts. -|Value|Description|Use of additionalValue Field| -|-----|-----------|----------------------------| -|HOLD_ON_MATURITY|Funds are held in a facility or similar mechanism managed by the data holder for a period of time until the customer provides instructions or the maximum period of the hold has elapsed. Funds may be renewed or withdrawn upon instructions by the customer|NA| -|PAID_OUT_AT_MATURITY|Funds are to be paid out at maturity|NA| -|ROLLED_OVER|Funds are to be rolled over at maturity|NA| \ No newline at end of file +| Value | Description | Use of _additionalValue_ Field | +| ----- | ----------- | ---------------------------- | +| HOLD_ON_MATURITY | Funds are held in a facility or similar mechanism managed by the data holder for a period of time until the customer provides instructions or the maximum period of the hold has elapsed. Funds may be renewed or withdrawn upon instructions by the customer. | N/A | +| PAID_OUT_AT_MATURITY | Funds are to be paid out at maturity. | N/A | +| ROLLED_OVER | Funds are to be rolled over at maturity. | N/A | diff --git a/slate/source/includes/changelog.md b/slate/source/includes/changelog.md index 36ef2a967..1b37c8781 100644 --- a/slate/source/includes/changelog.md +++ b/slate/source/includes/changelog.md @@ -1,90 +1,100 @@ -# Change Log +# Changelog and archives +

+ + +

-The following table lists the changes made to these standards in reverse date order (most recent change is at the top). +```diff +Merged the Change Log and Archives sections. Archived versions are available through the links in the Version column. +``` -|Change Date|Version|Description|Detail of change| +The following table lists the changes made to these standards in reverse date order (most recent change and current version is at the top). Archived versions are prior versions of the standards that are available for reference only and not considered binding. + +| Date | Version | Description | Detail of change | |-----------|-------|-----------|----------------| -|TBC | 1.32.0 | Changes TBC | See [release notes](includes/releasenotes/releasenotes.1.32.0.html) and [Decision XXX](https://github.com/ConsumerDataStandardsAustralia/standards/issues/XXX) for details. | -|03/07/2024 | 1.31.0 | Changes from Maintenance Iteration 19 | See [release notes](includes/releasenotes/releasenotes.1.31.0.html) and [Decision 347](https://github.com/ConsumerDataStandardsAustralia/standards/issues/347) for details. | -|24/04/2024 | 1.30.0 | Changes from maintenance iteration 18 | See [release notes](includes/releasenotes/releasenotes.1.30.0.html) and [Decision 340](https://github.com/ConsumerDataStandardsAustralia/standards/issues/340) for details. | -|28/02/2024 | 1.29.1 | Patch release fixing minor issues | See [release notes](includes/releasenotes/releasenotes.1.29.1.html) for details. | -|21/12/2023 | 1.29.0 | Changes from maintenance iteration 17. Also includes CX Standards changes to uplift Data Holder Dashboards and accommodate Business Consumers | See [release notes](includes/releasenotes/releasenotes.1.29.0.html), [Decision 318](https://github.com/ConsumerDataStandardsAustralia/standards/issues/318), [Decision 328](https://github.com/ConsumerDataStandardsAustralia/standards/issues/328), [Decision 333](https://github.com/ConsumerDataStandardsAustralia/standards/issues/333) and [Decision 334](https://github.com/ConsumerDataStandardsAustralia/standards/issues/334) for details. | -|10/11/2023| 1.28.0 | Candidate standards arising from Decision 306 and updated draft non-bank lending standards | See [release notes](includes/releasenotes/releasenotes.1.28.0.html) and [Decision 306](https://github.com/ConsumerDataStandardsAustralia/standards/issues/306) for details. | -|10/10/2023| 1.27.0 | Changes arising from Decision 313 (Maintenance Iteration 16) | See [release notes](includes/releasenotes/releasenotes.1.27.0.html) and [Decision 313](https://github.com/ConsumerDataStandardsAustralia/standards/issues/313) for details. | -|24/08/2023| 1.26.0 | Changes to obligations for the implementation of Get Metrics | See [release notes](includes/releasenotes/releasenotes.1.26.0.html) and [Decision 322](https://github.com/ConsumerDataStandardsAustralia/standards/issues/322) for details. | -|08/07/2023| 1.25.0 | Changes arising from Decision 303 (Maintenance iteration 15) and Decision 288 (Metrics and NFRs) | See [release notes](includes/releasenotes/releasenotes.1.25.0.html), [Decision 303](https://github.com/ConsumerDataStandardsAustralia/standards/issues/303) and [Decision 288](https://github.com/ConsumerDataStandardsAustralia/standards/issues/288) for details. | -|07/05/2023| 1.24.0 | Changes arising from Decision 281 (Maintenance iteration 14) | See [release notes](includes/releasenotes/releasenotes.1.24.0.html) and [Decision 281](https://github.com/ConsumerDataStandardsAustralia/standards/issues/281) for details. | -|14/04/2023| 1.23.0 | Changes arising from Decision Proposal 298 | See [release notes](includes/releasenotes/releasenotes.1.23.0.html) and [Decision 298](https://github.com/ConsumerDataStandardsAustralia/standards/issues/298) for details. | -|22/03/2023| 1.22.1 | Patch release including updates to draft Telco standards | See [release notes](includes/releasenotes/releasenotes.1.22.1.html) for details. | -|22/12/2022| 1.22.0 | Changes arising from Decision 271 (Maintenance iteration 13) | See [release notes](includes/releasenotes/releasenotes.1.22.0.html) and [Decision 272](https://github.com/ConsumerDataStandardsAustralia/standards/issues/272) for details. | -|16/12/2022| 1.21.0 | Changes arising from Decision 282 | See [release notes](includes/releasenotes/releasenotes.1.21.0.html) and [Decision 282](https://github.com/ConsumerDataStandardsAustralia/standards/issues/282) for details. | -|03/11/2022| 1.20.0 | Changes arising from Decision 259 (Maintenance iteration 12) | See [release notes](includes/releasenotes/releasenotes.1.20.0.html) and [Decision 259](https://github.com/ConsumerDataStandardsAustralia/standards/issues/259) for details. Also includes first draft of Telco standards | -|13/09/2022| 1.19.0 | Changes arising from Decision 260 (Energy Closed Accounts) | See [release notes](includes/releasenotes/releasenotes.1.19.0.html) and [Decision 260](https://github.com/ConsumerDataStandardsAustralia/standards/issues/260) for details | -|11/08/2022| 1.18.0 | Changes arising from Decision 249 (Maintenance iteration 11) | See [release notes](includes/releasenotes/releasenotes.1.18.0.html) and [Decision 249](https://github.com/ConsumerDataStandardsAustralia/standards/issues/249) for details | -|23/05/2022| 1.17.0 | Changes arising from Decision 237 (Maintenance Iteration 10) | See [release notes](includes/releasenotes/releasenotes.1.17.0.html) and [Decision 237](https://github.com/ConsumerDataStandardsAustralia/standards/issues/237) for details | -|22/03/2022| 1.16.1 | Minor errata and documentation fixes. Update of swagger files to OAS3 | See [release notes](includes/releasenotes/releasenotes.1.16.1.html) for details | -|04/02/2022| 1.16.0 | Changes arising from Decision 222 (Insights and Trusted Adviser Disclosure Consents CX Standards) | See [release notes](includes/releasenotes/releasenotes.1.16.0.html), [Decision 222](https://github.com/ConsumerDataStandardsAustralia/standards/issues/222) for details | -|23/12/2021| 1.15.0 | Changes arising from Decision 199 (Binding Energy Standards), Decision 162 (Joint Account CX standards), Decision 209 (FAPI 1.0 migration), Decision 216 (OIDC Profile Scope) and Decision 212 (Maintenance Iteration 9 change requests) | See [release notes](includes/releasenotes/releasenotes.1.15.0.html), [Decision 199](https://github.com/ConsumerDataStandardsAustralia/standards/issues/199), [Decision 162](https://github.com/ConsumerDataStandardsAustralia/standards/issues/162), [Decision 209](https://github.com/ConsumerDataStandardsAustralia/standards/issues/209), [Decision 212](https://github.com/ConsumerDataStandardsAustralia/standards/issues/212), and [Decision 216](https://github.com/ConsumerDataStandardsAustralia/standards/issues/216) for details | -|29/10/2021| 1.14.0 | Inclusion of full candidate level standards for the energy sector | See [release notes](includes/releasenotes/releasenotes.1.14.0.html) for details | -|22/10/2021| 1.13.0 | Changes arising from Decisions 206 (Register Standards), 191 and 192 | See [release notes](includes/releasenotes/releasenotes.1.13.0.html), [Decision 206](https://github.com/ConsumerDataStandardsAustralia/standards/issues/206), [Decision 191](https://github.com/ConsumerDataStandardsAustralia/standards/issues/191) and [Decision 192](https://github.com/ConsumerDataStandardsAustralia/standards/issues/192) for details | -|14/10/2021|1.12.0| Inclusion of a series of decisions related to energy and non-functional requirements | See [release notes](includes/releasenotes/releasenotes.1.12.0.html) for details | -|05/10/2021|1.11.1| Minor errata and documentation fixes | See [release notes](includes/releasenotes/releasenotes.1.11.1.html) for details | -|30/06/2021|1.11.0| Changes arising from Decision Proposals 160, 187 and maintenance iteration 7 Decision Proposal 178 | See [release notes](includes/releasenotes/releasenotes.1.11.0.html), [Decision 160](https://github.com/ConsumerDataStandardsAustralia/standards/issues/160), [Decision 187](https://github.com/ConsumerDataStandardsAustralia/standards/issues/187) and [Decision 178](https://github.com/ConsumerDataStandardsAustralia/standards/issues/178) for details | -|01/06/2021|1.10.0| Changes arising from Enhanced Error Handling decision proposals | See [release notes](includes/releasenotes/releasenotes.1.10.0.html) and [Decision 154](https://github.com/ConsumerDataStandardsAustralia/standards/issues/154) for details | -|29/04/2021|1.9.0| Changes arising from the sixth Data Standards Maintenance Iteration | See [release notes](includes/releasenotes/releasenotes.1.9.0.html) and [Decision 161](https://github.com/ConsumerDataStandardsAustralia/standards/issues/161) for details| -|16/04/2021|1.8.0| CX Standards for Amending Consent | See [release notes](includes/releasenotes/releasenotes.1.8.0.html) and [Decision 144](https://github.com/ConsumerDataStandardsAustralia/standards/issues/144) for details| -|10/03/2021|1.7.0|Changes arising from the fifth Banking Maintenance Iteration|See [release notes](includes/releasenotes/releasenotes.1.7.0.html) and [Decision 159](https://github.com/ConsumerDataStandardsAustralia/standards/issues/159) for details| -|23/12/2020|1.6.0|DP325 to address urgent community request regarding audience claim for client authentication for data recipients calling data holders|See [release notes](includes/releasenotes/releasenotes.1.6.0.html) for details| -|25/9/2020|1.5.1|Revert 1.5.0 CRN update|See [release notes](includes/releasenotes/releasenotes.1.5.1.html) for details| -|16/9/2020|1.5.0|Second Banking Maintenance Iteration 4 Release|See [release notes](includes/releasenotes/releasenotes.1.5.0.html) for details| -|12/8/2020|1.4.0|Banking Maintenance Iteration 4 Release|See [release notes](includes/releasenotes/releasenotes.1.4.0.html) for details| -|22/5/2020|1.3.1|Maintenance updates|Error Fixes
See [release notes](includes/releasenotes/releasenotes.1.3.1.html) for detail -|17/4/2020|1.3.0|Minor Update Release|Incorporates maintenance iteration 2 changes along with a number other CX and technical changes
See [release notes](includes/releasenotes/releasenotes.1.3.0.html) for detail -|31/1/2020|1.2.0|Phase 2 Baseline|Baseline version for the Phase 2 implementation of the CDR regime
See [release notes](includes/releasenotes/releasenotes.1.2.0.html) for detail -|20/1/2020|1.1.1|Maintenance updates|Error Fixes
See [release notes](includes/releasenotes/releasenotes.1.1.1.html) for detail -|10/12/2019|1.1.0|Banking Maintenance Iteration 1 Changes|Changes arising from iteration 1 of the banking maintenance cadence.
See [release notes](includes/releasenotes/releasenotes.1.1.0.html) for detail -|12/11/2019|1.0.1|Patch update|Minor defect changes and clarifications.
See [release notes](includes/releasenotes/releasenotes.1.0.1.html) for detail -|30/9/2019|1.0.0|Baseline version 1|This release is the baseline release for the standards that are intended for implementation February 2020 and contains minor updates as well as changes to align to the locked down CDR Rules and the updated CDR Register design -|4/9/2019|0.9.6|Defect fix release|This release addresses a series of documentation issues and other clarifications as identified via GitHub feedback -|15/7/2019|0.9.5|Incorporated May 2019 Feedback|This version incorporates the decisions arising from the consultation feedback obtained on the May 2019 draft of the standards (v0.9.3) -|27/6/2019|0.9.4|Documentation and error fixes from May draft| -|29/5/2019|0.9.3|Final updates for May Draft|Addition of Discoverability, InfoSec Profile and minor corrections -|28/5/2019|0.9.2|Admin End Points|Added separate swagger/yaml as well as documentation for admin end points -|28/5/2019|0.9.1|Modified BankingProductRateTier.maximumValue to optional|Rebuild of docs -|28/5/2019|0.9.0|Incorporated Scheduled Payments Decision proposal 51|Swagger updates and Documentation changes -|13/5/2019|0.8.4|InfoSec Update|Imported the InfoSec content without update for recent proposals -|12/5/2019|0.8.3|Optionality Update|Clarified the meaning of a field declaration of optional -|7/5/2019|0.8.2|Minor fixes|Minor fixes for product category enum -|6/4/2019|0.8.1|Negative Rates|Modified RateString to allow for negative rates and not just positive or zero rates -|3/4/2019|0.8.0|Accounts and Balances v1 final|Applied changes to prepare for v1 version of Accounts and Balances end points and payloads documentation -|27/4/2019|0.7.0|April Feedback|Incorporated feedback from v1 draft decisions and feedback cycle 5 -|23/4/2019|0.6.0|Payees & Customer v1 draft|Applied changes to prepare for v1 version of Payees & Customer end points and payloads documentation -|16/4/2019|0.5.0|Transaction v1 draft|Applied changes to prepare for v1 version of Transaction end points and payloads documentation -|16/4/2019|0.4.0|Direct Debit Auth v1 draft|Applied changes to prepare for v1 version of Direct Debit Authorisations end points and payloads documentation -|9/4/2019|0.3.0|Product Reference v1 final|Synchronised standards documentation and swagger with final Decision 054 - Product Reference v1 -|11/3/2019|0.2.0|Product Reference v1 draft|Applied changes to prepare for v1 version of Product Reference end points and payloads| -|22/2/2019|0.2.0|Rate tier name|Addition of a name field for rate tiers| -|21/2/2019|0.2.0|Rate tiering|Added rate tiering and additional rate types based on community feedback| -|19/2/2019|0.2.0|Fees and Discounts|Updated product and account fees, discounts and elibilities based on community feedback| -|19/2/2019|0.2.0|Doc Sync|Synchronised the API documentation with the swagger files| -|11/2/2019|0.2.0|Consistency Fixes|Fixes to end points for consistency across the standard. Changes as follows:| -|4/2/2019|0.2.0|Object Model Names|Updated the swagger json and yaml files to make the object model names consistent| -|21/12/2018|0.2.0|Transaction payloads|Removed incorrect inclusion of accountId, displayName and nickname for transaction response payloads| -|20/12/2018|0.2.0|Version 0.20|Version updated formally to version 0.20 for Christmas Draft| -|20/12/2018|0.1.0|Updated documentation|Documentation has been automatically generated from the swagger for consistency| -|20/12/2018|0.1.0|Known issues|Added a section identifying known issues with the standards that are under review| -|20/12/2018|0.1.0|Cursor based pagination|Added commentary in pagination section on the potential use of cursors| -|20/12/2018|0.1.0|Minor amendments to response codes|Additional wording to support caching and inserted a cross reference to the error payload section| -|20/12/2018|0.1.0|Minor amendments to extensibility|Minor wording changes for clarity and included reference to addition of new query parameters| -|20/12/2018|0.1.0|Unauthenticated end points|Modified URI structure commentary to allow for a different provider path for unauthenticated end points| -|20/12/2018|0.1.0|Festive spirit|Critical update - added a Santa hat to the logo| -|20/12/2018|0.1.0|FAPI Headers|Added FAPI specific headers arising from the InfoSec work| -|19/12/2018|0.1.0|PAFAddress|Added detail for the PAFAddress model based on the Australia Post PAF file format definition| -|19/12/2018|0.1.0|RateString common type|Changed the RateString type to represent rates such that 100% is represented by the value 1.0| -|19/12/2018|0.1.0|URIString common type|Corrected the name of the URIString common type| -|19/12/2018|0.1.0|Updated swagger files|Swagger files were updated to address feedback. Documentation has not been changed to reflect these changes unless stated. Changes are as follows:| -|19/12/2018|0.1.0|Masking rules|Added specificity to the masking guidance for the masked string primitives| -|18/12/2018|0.1.0|Updated swagger files|Swagger files were updated to address feedback. Documentation has not been changed to reflect these changes unless stated. Changes are as follows:| -|18/12/2018|0.1.0|Addition of change log|This change log was added to the standards documentation| +| TBC | 1.32.0 | Changes TBC | See [release notes](includes/releasenotes/releasenotes.1.32.0.html) and [Decision XXX](https://github.com/ConsumerDataStandardsAustralia/standards/issues/XXX) for details. | +| 03/07/2024 | 1.31.0 | Changes from Maintenance Iteration 19 | See [release notes](includes/releasenotes/releasenotes.1.31.0.html) and [Decision 347](https://github.com/ConsumerDataStandardsAustralia/standards/issues/347) for details. | +| 24/04/2024 | 1.30.0 | Changes from maintenance iteration 18 | See [release notes](includes/releasenotes/releasenotes.1.30.0.html) and [Decision 340](https://github.com/ConsumerDataStandardsAustralia/standards/issues/340) for details. | +| 28/02/2024 | 1.29.1 | Patch release fixing minor issues | See [release notes](includes/releasenotes/releasenotes.1.29.1.html) for details. | +| 21/12/2023 | 1.29.0 | Changes from maintenance iteration 17. Also includes CX Standards changes to uplift Data Holder Dashboards and accommodate Business Consumers | See [release notes](includes/releasenotes/releasenotes.1.29.0.html), [Decision 318](https://github.com/ConsumerDataStandardsAustralia/standards/issues/318), [Decision 328](https://github.com/ConsumerDataStandardsAustralia/standards/issues/328), [Decision 333](https://github.com/ConsumerDataStandardsAustralia/standards/issues/333) and [Decision 334](https://github.com/ConsumerDataStandardsAustralia/standards/issues/334) for details. | +| 10/11/2023 | 1.28.0 | Candidate standards arising from Decision 306 and updated draft non-bank lending standards | See [release notes](includes/releasenotes/releasenotes.1.28.0.html) and [Decision 306](https://github.com/ConsumerDataStandardsAustralia/standards/issues/306) for details. | +| 10/10/2023 | 1.27.0 | Changes arising from Decision 313 (Maintenance Iteration 16) | See [release notes](includes/releasenotes/releasenotes.1.27.0.html) and [Decision 313](https://github.com/ConsumerDataStandardsAustralia/standards/issues/313) for details. | +| 24/08/2023 | 1.26.0 | Changes to obligations for the implementation of Get Metrics | See [release notes](includes/releasenotes/releasenotes.1.26.0.html) and [Decision 322](https://github.com/ConsumerDataStandardsAustralia/standards/issues/322) for details. | +| 08/07/2023 | 1.25.0 | Changes arising from Decision 303 (Maintenance iteration 15) and Decision 288 (Metrics and NFRs) | See [release notes](includes/releasenotes/releasenotes.1.25.0.html), [Decision 303](https://github.com/ConsumerDataStandardsAustralia/standards/issues/303) and [Decision 288](https://github.com/ConsumerDataStandardsAustralia/standards/issues/288) for details. | +| 07/05/2023 | 1.24.0 | Changes arising from Decision 281 (Maintenance iteration 14) | See [release notes](includes/releasenotes/releasenotes.1.24.0.html) and [Decision 281](https://github.com/ConsumerDataStandardsAustralia/standards/issues/281) for details. | +| 14/04/2023 | 1.23.0 | Changes arising from Decision Proposal 298 | See [release notes](includes/releasenotes/releasenotes.1.23.0.html) and [Decision 298](https://github.com/ConsumerDataStandardsAustralia/standards/issues/298) for details. | +| 22/03/2023 | 1.22.1 | Patch release including updates to draft Telco standards | See [release notes](includes/releasenotes/releasenotes.1.22.1.html) for details. | +| 22/12/2022 | 1.22.0 | Changes arising from Decision 271 (Maintenance iteration 13) | See [release notes](includes/releasenotes/releasenotes.1.22.0.html) and [Decision 272](https://github.com/ConsumerDataStandardsAustralia/standards/issues/272) for details. | +| 16/12/2022 | 1.21.0 | Changes arising from Decision 282 | See [release notes](includes/releasenotes/releasenotes.1.21.0.html) and [Decision 282](https://github.com/ConsumerDataStandardsAustralia/standards/issues/282) for details. | +| 03/11/2022 | 1.20.0 | Changes arising from Decision 259 (Maintenance iteration 12) | See [release notes](includes/releasenotes/releasenotes.1.20.0.html) and [Decision 259](https://github.com/ConsumerDataStandardsAustralia/standards/issues/259) for details. Also includes first draft of Telco standards | +| 13/09/2022 | 1.19.0 | Changes arising from Decision 260 (Energy Closed Accounts) | See [release notes](includes/releasenotes/releasenotes.1.19.0.html) and [Decision 260](https://github.com/ConsumerDataStandardsAustralia/standards/issues/260) for details | +| 11/08/2022 | 1.18.0 | Changes arising from Decision 249 (Maintenance iteration 11) | See [release notes](includes/releasenotes/releasenotes.1.18.0.html) and [Decision 249](https://github.com/ConsumerDataStandardsAustralia/standards/issues/249) for details | +| 23/05/2022 | 1.17.0 | Changes arising from Decision 237 (Maintenance Iteration 10) | See [release notes](includes/releasenotes/releasenotes.1.17.0.html) and [Decision 237](https://github.com/ConsumerDataStandardsAustralia/standards/issues/237) for details | +| 22/03/2022 | 1.16.1 | Minor errata and documentation fixes. Update of swagger files to OAS3 | See [release notes](includes/releasenotes/releasenotes.1.16.1.html) for details | +| 04/02/2022 | 1.16.0 | Changes arising from Decision 222 (Insights and Trusted Adviser Disclosure Consents CX Standards) | See [release notes](includes/releasenotes/releasenotes.1.16.0.html), [Decision 222](https://github.com/ConsumerDataStandardsAustralia/standards/issues/222) for details | +| 23/12/2021 | 1.15.0 | Changes arising from Decision 199 (Binding Energy Standards), Decision 162 (Joint Account CX standards), Decision 209 (FAPI 1.0 migration), Decision 216 (OIDC Profile Scope) and Decision 212 (Maintenance Iteration 9 change requests) | See [release notes](includes/releasenotes/releasenotes.1.15.0.html), [Decision 199](https://github.com/ConsumerDataStandardsAustralia/standards/issues/199), [Decision 162](https://github.com/ConsumerDataStandardsAustralia/standards/issues/162), [Decision 209](https://github.com/ConsumerDataStandardsAustralia/standards/issues/209), [Decision 212](https://github.com/ConsumerDataStandardsAustralia/standards/issues/212), and [Decision 216](https://github.com/ConsumerDataStandardsAustralia/standards/issues/216) for details | +| 29/10/2021 | 1.14.0 | Inclusion of full candidate level standards for the energy sector | See [release notes](includes/releasenotes/releasenotes.1.14.0.html) for details | +| 22/10/2021 | 1.13.0 | Changes arising from Decisions 206 (Register Standards), 191 and 192 | See [release notes](includes/releasenotes/releasenotes.1.13.0.html), [Decision 206](https://github.com/ConsumerDataStandardsAustralia/standards/issues/206), [Decision 191](https://github.com/ConsumerDataStandardsAustralia/standards/issues/191) and [Decision 192](https://github.com/ConsumerDataStandardsAustralia/standards/issues/192) for details | +| 14/10/2021 | 1.12.0 | Inclusion of a series of decisions related to energy and non-functional requirements. Changes arising from Decision Proposals 193 and 208. | See [release notes](includes/releasenotes/releasenotes.1.12.0.html) for details | +| 05/10/2021 | 1.11.1 | Minor errata and documentation fixes | See [release notes](includes/releasenotes/releasenotes.1.11.1.html) for details | +| 30/06/2021 | 1.11.0 | Changes arising from Decision Proposals 160, 187 and maintenance iteration 7 Decision Proposal 178 | See [release notes](includes/releasenotes/releasenotes.1.11.0.html), [Decision 160](https://github.com/ConsumerDataStandardsAustralia/standards/issues/160), [Decision 187](https://github.com/ConsumerDataStandardsAustralia/standards/issues/187) and [Decision 178](https://github.com/ConsumerDataStandardsAustralia/standards/issues/178) for details | +| 01/06/2021 | 1.10.0 | Changes arising from Enhanced Error Handling decision proposals | See [release notes](includes/releasenotes/releasenotes.1.10.0.html) and [Decision 154](https://github.com/ConsumerDataStandardsAustralia/standards/issues/154) for details | +| 29/04/2021 | 1.9.0 | Changes arising from the sixth Data Standards Maintenance Iteration | See [release notes](includes/releasenotes/releasenotes.1.9.0.html) and [Decision 161](https://github.com/ConsumerDataStandardsAustralia/standards/issues/161) for details| +| 16/04/2021 | 1.8.0 | CX Standards for Amending Consent | See [release notes](includes/releasenotes/releasenotes.1.8.0.html) and [Decision 144](https://github.com/ConsumerDataStandardsAustralia/standards/issues/144) for details| +| 10/03/2021 | 1.7.0 | Changes arising from the fifth Banking Maintenance Iteration | See [release notes](includes/releasenotes/releasenotes.1.7.0.html) and [Decision 159](https://github.com/ConsumerDataStandardsAustralia/standards/issues/159) for details| +| 23/12/2020 | 1.6.0 | DP325 to address urgent community request regarding audience claim for client authentication for data recipients calling data holders | See [release notes](includes/releasenotes/releasenotes.1.6.0.html) for details| +| 25/09/2020 | 1.5.1 | Revert 1.5.0 CRN update | See [release notes](includes/releasenotes/releasenotes.1.5.1.html) for details| +| 16/09/2020 | 1.5.0 | Second Banking Maintenance Iteration 4 Release (Banking Maintenance Iteration 4 Release) | See [release notes](includes/releasenotes/releasenotes.1.5.0.html) for details| +| 12/08/2020 | 1.4.0 | Banking Maintenance Iteration 4 Release (Banking Maintenance Iteration 3 Release) | See [release notes](includes/releasenotes/releasenotes.1.4.0.html) for details| +| 22/05/2020 | 1.3.1 | Maintenance updates (May Banking Maintenance Iteration 2 Release) | Error Fixes
See [release notes](includes/releasenotes/releasenotes.1.3.1.html) for detail +| 17/04/2020 | 1.3.0 | Minor Update Release (April 1.3.0 Release) | Incorporates maintenance iteration 2 changes along with a number other CX and technical changes
See [release notes](includes/releasenotes/releasenotes.1.3.0.html) for detail +| 31/01/2020 | 1.2.0 | Phase 2 Baseline (January 1.2.0 Release) | Baseline version for the Phase 2 implementation of the CDR regime
See [release notes](includes/releasenotes/releasenotes.1.2.0.html) for detail +| 20/01/2020 | 1.1.1 | Maintenance updates | Error Fixes
See [release notes](includes/releasenotes/releasenotes.1.1.1.html) for detail +| 10/12/2019 | 1.1.0 | Banking Maintenance Iteration 1 Changes | Changes arising from iteration 1 of the banking maintenance cadence.
See [release notes](includes/releasenotes/releasenotes.1.1.0.html) for detail +| 12/11/2019 | 1.0.1 | Patch update | Minor defect changes and clarifications.
See [release notes](includes/releasenotes/releasenotes.1.0.1.html) for detail +| 30/09/2019 | 1.0.0 | Baseline version 1 (September 1.0.0 Release) | This release is the baseline release for the standards that are intended for implementation February 2020 and contains minor updates as well as changes to align to the locked down CDR Rules and the updated CDR Register design +| 04/09/2019 | 0.9.6 | Defect fix release (September fixes update) | This release addresses a series of documentation issues and other clarifications as identified via GitHub feedback +| 15/07/2019 | 0.9.5 | Incorporated May 2019 Feedback (July 2019 Working Draft) | This version incorporates the decisions arising from the consultation feedback obtained on the May 2019 draft of the standards (v0.9.3) +| 27/06/2019 | 0.9.4 | Documentation and error fixes from May draft | +| 29/05/2019 | 0.9.3 | Final updates for May Draft (May 2019 Working Draft) | Addition of Discoverability, InfoSec Profile and minor corrections +| 28/05/2019 | 0.9.2 | Admin End Points | Added separate swagger/yaml as well as documentation for admin end points +| 28/05/2019 | 0.9.1 | Modified BankingProductRateTier.maximumValue to optional | Rebuild of docs +| 28/05/2019 | 0.9.0 | Incorporated Scheduled Payments Decision proposal 51 | Swagger updates and Documentation changes +| 13/05/2019 | 0.8.4 | InfoSec Update | Imported the InfoSec content without update for recent proposals +| 12/05/2019 | 0.8.3 | Optionality Update | Clarified the meaning of a field declaration of optional +| 07/05/2019 | 0.8.2 | Minor fixes | Minor fixes for product category enum +| 06/04/2019 | 0.8.1 | Negative Rates | Modified RateString to allow for negative rates and not just positive or zero rates +| 03/04/2019 | 0.8.0 | Accounts and Balances v1 final | Applied changes to prepare for v1 version of Accounts and Balances end points and payloads documentation +| 27/04/2019 | 0.7.0 | April Feedback | Incorporated feedback from v1 draft decisions and feedback cycle 5 +| 23/04/2019 | 0.6.0 | Payees & Customer v1 draft | Applied changes to prepare for v1 version of Payees & Customer end points and payloads documentation +| 16/04/2019 | 0.5.0 | Transaction v1 draft | Applied changes to prepare for v1 version of Transaction end points and payloads documentation +| 16/04/2019 | 0.4.0 | Direct Debit Auth v1 draft | Applied changes to prepare for v1 version of Direct Debit Authorisations end points and payloads documentation +| 09/04/2019 | 0.3.0 | Product Reference v1 final | Synchronised standards documentation and swagger with final Decision 054 - Product Reference v1 +| 11/03/2019 | 0.2.0 | Product Reference v1 draft | Applied changes to prepare for v1 version of Product Reference end points and payloads| +| 22/02/2019 | 0.2.0 | Rate tier name | Addition of a name field for rate tiers| +| 21/02/2019 | 0.2.0 | Rate tiering | Added rate tiering and additional rate types based on community feedback| +| 19/02/2019 | 0.2.0 | Fees and Discounts | Updated product and account fees, discounts and elibilities based on community feedback| +| 19/02/2019 | 0.2.0 | Doc Sync | Synchronised the API documentation with the swagger files| +| 11/02/2019 | 0.2.0 | Consistency Fixes | Fixes to end points for consistency across the standard. Changes as follows:| +| 04/02/2019 | 0.2.0 | Object Model Names | Updated the swagger json and yaml files to make the object model names consistent| +| 21/12/2018 | 0.2.0 | Transaction payloads | Removed incorrect inclusion of accountId, displayName and nickname for transaction response payloads| +| 20/12/2018 | 0.1.0 | Infosec version 0.1 (Christmas 2018 Working Draft - InfoSec Profile) | Infosec version 0.1 | +| 20/12/2018 | 0.2.0 | Version 0.20 (Christmas 2018 Working Draft - Standards) | Version updated formally to version 0.20 for Christmas Draft| +| 20/12/2018 | 0.1.0 | Updated documentation | Documentation has been automatically generated from the swagger for consistency| +| 20/12/2018 | 0.1.0 | Known issues | Added a section identifying known issues with the standards that are under review| +| 20/12/2018 | 0.1.0 | Cursor based pagination | Added commentary in pagination section on the potential use of cursors| +| 20/12/2018 | 0.1.0 | Minor amendments to response codes | Additional wording to support caching and inserted a cross reference to the error payload section| +| 20/12/2018 | 0.1.0 | Minor amendments to extensibility | Minor wording changes for clarity and included reference to addition of new query parameters| +| 20/12/2018 | 0.1.0 | Unauthenticated end points | Modified URI structure commentary to allow for a different provider path for unauthenticated end points| +| 20/12/2018 | 0.1.0 | Festive spirit | Critical update - added a Santa hat to the logo| +| 20/12/2018 | 0.1.0 | FAPI Headers | Added FAPI specific headers arising from the InfoSec work| +| 19/12/2018 | 0.1.0 | PAFAddress | Added detail for the PAFAddress model based on the Australia Post PAF file format definition| +| 19/12/2018 | 0.1.0 | RateString common type | Changed the RateString type to represent rates such that 100% is represented by the value 1.0| +| 19/12/2018 | 0.1.0 | URIString common type | Corrected the name of the URIString common type| +| 19/12/2018 | 0.1.0 | Updated swagger files | Swagger files were updated to address feedback. Documentation has not been changed to reflect these changes unless stated. Changes are as follows:| +| 19/12/2018 | 0.1.0 | Masking rules | Added specificity to the masking guidance for the masked string primitives| +| 18/12/2018 | 0.1.0 | Updated swagger files | Swagger files were updated to address feedback. Documentation has not been changed to reflect these changes unless stated. Changes are as follows:| +| 18/12/2018 | 0.1.0 | Addition of change log | This change log was added to the standards documentation| +| 02/11/2018 | 0.1.0 | (November 2018 Working Draft) | November 2018 Working Draft | diff --git a/slate/source/includes/introduction/_intro.md b/slate/source/includes/introduction/_intro.md index bf7c711ec..16905555b 100644 --- a/slate/source/includes/introduction/_intro.md +++ b/slate/source/includes/introduction/_intro.md @@ -1,6 +1,3 @@ - - - These standards have been developed as part of the Australian Government's introduction of the [Consumer Data Right](https://www.cdr.gov.au/) legislation to give Australians greater control over their data. The Consumer Data Right (CDR) is intended to be applied sector by sector across the whole economy, beginning in the banking, energy and telecommunications sectors. These standards have been developed to facilitate the Consumer Data Right by acting as a specific baseline for implementation. @@ -12,14 +9,15 @@ The standards are required to be published. The obligations on CDR participants - where the rules require compliance with the standards, non-compliance with the standards may constitute a breach of the rules. - where the standards are specified as binding standards as required by the Consumer Data Right rules for the purposes of s56FA of the legislation, they apply as under contract between a data holder and an accredited data recipient. The legal effect of binding standards as between data holders and accredited data recipients is fully set out in s56FD and s56FE of the legislation. - Some of these standards will be binding data standards under the Competition and Consumer (Consumer Data Right) Data Standards (No. 1) 2023. See that instrument [here](https://consumerdatastandards.gov.au/sites/consumerdatastandards.gov.au/files/2023-02/Competition%20and%20Consumer%20%28Consumer%20Data%20Right%29%20Data%20Standards%20%28No.%201%29%202023%20executed.pdf). In summary, provisions of these standards (as they exist from time to time) that impose obligations or prohibitions on CDR entities are binding data standards. Provisions included in these standards merely by way of guidance are not binding data standards. -## Version +```diff +Added CX Guidelines link to side/footer navigation +``` + +## Version These standards represent version 1.32.0 of the high level standards. See the [versioning section](#versioning) for more information on how versions are managed in the standard. ## Interpretation - Note that, in these standards, the key words **MUST**, **MUST NOT**, **REQUIRED**, **SHALL**, **SHALL NOT**, **SHOULD**, **SHOULD NOT**, **RECOMMENDED**, **MAY**, and **OPTIONAL** are to be interpreted as described in **[[RFC2119]](#nref-RFC2119)**. - diff --git a/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md b/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md index f999215d2..ca51926fd 100644 --- a/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md +++ b/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md @@ -17,11 +17,19 @@ Release notes for version v1.32.0 of the [CDR Standards](../../index.html). This release addresses the following minor defects raised on [Standards Staging](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues): +- [Standards Staging #410 - Clarify RateString description and examples](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/410) +- [Standards Staging #413 - Merge Change Log and Archives sections](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/413) +- [Standards Staging #417 - Non-existent property "amount" listed as required](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/417) +- [Standards Staging #418 - Add a link to CX Guidelines to the left menu pane of the Standards](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/418) +- [Standards Staging #419 - Field name styling](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/419) +- [Standards Staging #426 - Error in Telco OAS components](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/426) - [Standards Staging #438 - Improve code sample section styling](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/438) This release addresses the following change requests raised on [Standards Maintenance](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues): -- [Standards Maintenance #XXX - Title](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/XXX) +- [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 @@ -33,7 +41,12 @@ This release addresses the following Decision Proposals published on [Standards] ## General Changes |Change|Description|Link| |------|-----------|----| +| Change summary | [**Standards Maintenance #XXX**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/XXX): Change detail | [Standards section](../../#section) +| Change summary | [**Decision Proposal #XXX**](https://github.com/ConsumerDataStandardsAustralia/standards/issues/XXX): Change detail | [Standards section](../../#section) +| Changelog section | [**Standards Staging #413**](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/413): Merged the Change Log and Archives sections | [Changelog and archives](../../#changelog-and-archives) +| Add CX Guidelines link | [**Standards Staging #418**](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/418): Added CX Guidelines link to side/footer navigation | [Introduction](../../#introduction) | Improve Code sample styling | [**Standards Staging #438**](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/438): Improved styling of 'Code samples' displayed in the Non-Normative Examples tab and updated the Register server URL in the OpenAPI specification to refer to the actual Base URLs | [Code samples throughout](../../?examples)
[Register APIs](../../?diff#register-apis) +| Adjustment rate format clarification | [**Standards Maintenance #641**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/641): Clarified the format of 'bonus', 'discount' and 'penalty' adjustment rate values | [Deposit Adjustment Rate Types](../../#tocSproductdepositadjustmentratetypedoc)
[Lending Adjustment Rate Types](../../#tocSproductlendingadjustmentratetypedoc) ## Introduction @@ -44,11 +57,16 @@ This release addresses the following Decision Proposals published on [Standards] ## High Level Standards |Change|Description|Link| |------|-----------|----| +| Common Field Types examples | [**Standards Staging #410**](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/410): Clarified formatting of RateString type | [Common Field Types](../../#common-field-types) +| Updated AmountString description | [**Standards Maintenance #652**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/652): Updated the description of the AmountString field type, clarifying the currency format and noting it defaults to AUD. | [Common Field Types](../../#common-field-types) ## API Endpoints |Change|Description|Link| |------|-----------|----| +| 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 dailySupplyChargeType description | [**Standards Maintenance #653**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/653): Amended the description of the EnergyPlanTariffPeriodV2.dailySupplyChargeType 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 @@ -74,6 +92,7 @@ This release addresses the following Decision Proposals published on [Standards] ## Additional Standards |Change|Description|Link| |------|-----------|----| +| Correction to Telco specification | [**Standards Staging #426**](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/426): Corrected error in specification of response headers | [Candidate Standards](../../#candidate-standards) ## Known Issues diff --git a/slate/source/includes/standards/_types.md b/slate/source/includes/standards/_types.md index f9100d0af..f86d537ed 100644 --- a/slate/source/includes/standards/_types.md +++ b/slate/source/includes/standards/_types.md @@ -1,6 +1,10 @@ ## Common Field Types +```diff +Updated description of `AmountString` field clarifying the currency format and noting it defaults to AUD +Clarified formatting of RateString type +``` The following table outlines the common data types for fields used in the standard. @@ -20,8 +24,8 @@ DateTimeString | Combined Date and Time string as per **[[RFC3339]](#nref-RFC333 DateString | Date string as per **[[RFC3339]](#nref-RFC3339)** (labelled full-date in the RFC) | “2007-05-01”
“2012-12-25” TimeString | Time string as per **[[RFC3339]](#nref-RFC3339)** (labelled full-time in the RFC). As specified in **[[RFC3339]](#nref-RFC3339)** times MUST be offset relative to UTC | “15:43:00.12345Z”
“15:43:00-12:00” CurrencyString | Standard 3 character currency codes as per ISO-4217 | “AUD”
“USD”
“GBP” -RateString | A string representing a percentage (e.g. an interest rate). A rate of 100% would be represented by the value 1.0 and a rate of -100% by -1.0
- At least 1 and up to a total of 16 significant digits before decimal point
- Up to 16 digits following the decimal point
- No formatting, eg thousand separating commas | “0.05”`(=5%)`
“-0.05”`(=-5%)`
“12.3456789”`(=1234.56789%)`
“-99.123456789123”`(=9912.3456789123%)` -AmountString | A string representing an amount of currency.
- A positive, zero or negative number
- Negative numbers identified with a ‘-‘
- Currency symbols MUST NOT be supplied
- At least 1 and up to a total of 16 significant digits before decimal point
- Minimum 2 digits following a decimal point (more digits allowable but only if required)
- No additional formatting, eg thousand separating commas | “0.01”
“10.00”
“1234567.89”
“-1001.23”
“1.999” +RateString | A string representing a percentage (e.g., an interest rate). For example, a rate of 100% would be represented by the value `"1"` and a rate of -100% by `"-1"`
- At least 1 and up to a total of 16 significant digits before a decimal point
- Up to 16 digits following a decimal point if required
- No formatting, e.g., thousand-separating commas. | `"0"` or `"0.0"` (0%)
`"1"` or `"1.0"` (100%)
`"-1.234567"` (-123.4567%)
`"-0.056"` (-5.6%)
`"0.03456789"` (3.456789%)
`"0.2"` (20%)
`"23.456"` (2345.6%) +AmountString | A string representing a monetary amount in currency units with fractional units after a decimal point (e.g., if working with Australian dollars: "123.45" for one hundred and twenty-three dollars and forty-five cents).
- A positive, zero or negative number
- Negative numbers identified with a ‘-‘ prefix
- Currency symbols MUST NOT be supplied
- At least 1 and up to a total of 16 significant digits before decimal point
- Minimum 2 digits following a decimal point (more digits allowable but only if required)
- No additional formatting, eg thousand separating commas
- Assumed to be in AUD unless specified otherwise | “0.01”
“10.00”
“1234567.89”
“-1001.23”
“1.999” MaskedPANString | Masked credit card number. Lower case ‘x’ MUST be used to mask numbers and only the last four digits MUST be exposed to facilitate identification. This type is expected to be used for display so the format MUST be logical for this context | "xxxx xxxx xxxx 1234" MaskedAccountString | Masked bank account number genericised for a variety of account types. MUST be represented as the full account number would normally be represented for display (including formatting) but with all digits except the last four replaced with a lowercase x. This type is expected to be used for display so the format MUST be logical for this context | "xxxx xxxx xxxx 1234"
"xxx-xxx xxxxx1234" URIString | A valid URI | "http://www.google.com" diff --git a/slate/source/includes/standards/_versioning.md b/slate/source/includes/standards/_versioning.md index 10190cfea..52870b767 100644 --- a/slate/source/includes/standards/_versioning.md +++ b/slate/source/includes/standards/_versioning.md @@ -7,7 +7,7 @@ The standards have adopted a two level versioning strategy. The high level stan > Sample versioning of the standards documentation is as follows: `1.12.2 - meaning major version 1, minor version 12 and bugfix version 2 ` -The standards documentation will be versioned using three version parts `..`. This version will be used to describe updates in the [Change Log](#change-log). +The standards documentation will be versioned using three version parts `..`. This version will be used to describe updates in the [Changelog](#changelog-and-archives). Each of the three components will be independently incrementing integers and are described as follows: diff --git a/slate/source/index.html.md b/slate/source/index.html.md index 3b9d8c086..0b7fa3cd7 100644 --- a/slate/source/index.html.md +++ b/slate/source/index.html.md @@ -9,11 +9,11 @@ language_tabs: toc_footers: - Consumer Data Standards Home + - CX Guidelines - CDR Support Portal - CDR Standards on GitHub - CDR Maintenance on GitHub - Test Documentation - - includes: - intro @@ -42,7 +42,6 @@ includes: - separator - known-issues - changelog - - archives search: true --- diff --git a/swagger-gen/api/cds_banking.json b/swagger-gen/api/cds_banking.json index f35607cfb..33467eb02 100644 --- a/swagger-gen/api/cds_banking.json +++ b/swagger-gen/api/cds_banking.json @@ -547,7 +547,7 @@ } ], "requestBody": { - "description": "The list of account IDs to obtain balances for.", + "description": "The list of _accountId_ values to obtain balances for.", "content": { "application/json": { "schema": { @@ -1905,7 +1905,7 @@ } ], "requestBody": { - "description": "Array of specific accountIds to obtain authorisations for.", + "description": "Array of _accountId_ values to obtain authorisations for.", "content": { "application/json": { "schema": { @@ -2512,7 +2512,7 @@ } ], "requestBody": { - "description": "Array of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned.", + "description": "Array of _accountId_ values to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned.", "content": { "application/json": { "schema": { @@ -2622,7 +2622,7 @@ { "name": "type", "in": "query", - "description": "Filter on the payee type field. In addition to normal type field values, `ALL` can be specified to retrieve all payees. If absent the assumed value is `ALL`.", + "description": "Filter on the payee _type_ field. In addition to normal _type_ field values, `ALL` can be specified to retrieve all payees. If absent the assumed value is `ALL`.", "schema": { "type": "string", "default": "ALL", @@ -2993,7 +2993,7 @@ { "name": "effective", "in": "query", - "description": "Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are `CURRENT`, `FUTURE` and `ALL`. If absent defaults to `CURRENT`.", + "description": "Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the _effectiveFrom_ and _effectiveTo_ fields. Valid values are `CURRENT`, `FUTURE` and `ALL`. If absent defaults to `CURRENT`.", "schema": { "type": "string", "default": "CURRENT", @@ -3246,9 +3246,9 @@ "properties": { "accountIds": { "type": "array", + "description": "Array of _accountId_ values.", "items": { "type": "string", - "description": "Array of specific accountIds to obtain authorisations for.", "x-cds-type": "ASCIIString" } } @@ -4514,7 +4514,7 @@ }, "offsetAccountIds": { "type": "array", - "description": "The accountIDs of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that _offsetAccountEnabled_ is set to `true` but the _offsetAccountIds_ field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation.", + "description": "The _accountId_ values of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that _offsetAccountEnabled_ is set to `true` but the _offsetAccountIds_ field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation.", "items": { "type": "string", "x-cds-type": "ASCIIString" @@ -5524,11 +5524,11 @@ "properties": { "accountId": { "type": "string", - "description": "ID of the account that is the source of funds for the payment.", + "description": "_accountId_ of the account that is the source of funds for the payment.", "x-cds-type": "ASCIIString" } }, - "description": "Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the _to_ object." + "description": "Object containing details of the source of the payment. Currently only specifies an _accountId_ but provided as an object to facilitate future extensibility and consistency with the _to_ object." }, "BankingScheduledPaymentRecurrence": { "required": [ diff --git a/swagger-gen/api/cds_banking_dp306.json b/swagger-gen/api/cds_banking_dp306.json index 7c03b05ee..cab291e18 100644 --- a/swagger-gen/api/cds_banking_dp306.json +++ b/swagger-gen/api/cds_banking_dp306.json @@ -549,7 +549,7 @@ } ], "requestBody": { - "description": "The list of account IDs to obtain balances for.", + "description": "The list of _accountId_ values to obtain balances for.", "content": { "application/json": { "schema": { @@ -1908,7 +1908,7 @@ } ], "requestBody": { - "description": "Array of specific accountIds to obtain authorisations for.", + "description": "Array of _accountId_ values to obtain authorisations for.", "content": { "application/json": { "schema": { @@ -2516,7 +2516,7 @@ } ], "requestBody": { - "description": "Array of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned.", + "description": "Array of _accountId_ values to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned.", "content": { "application/json": { "schema": { @@ -2626,7 +2626,7 @@ { "name": "type", "in": "query", - "description": "Filter on the payee type field. In addition to normal type field values, `ALL` can be specified to retrieve all payees. If absent the assumed value is `ALL`.", + "description": "Filter on the payee _type_ field. In addition to normal _type_ field values, `ALL` can be specified to retrieve all payees. If absent the assumed value is `ALL`.", "schema": { "type": "string", "default": "ALL", @@ -2997,7 +2997,7 @@ { "name": "effective", "in": "query", - "description": "Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are `CURRENT`, `FUTURE` and `ALL`. If absent defaults to `CURRENT`.", + "description": "Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the _effectiveFrom_ and _effectiveTo_ fields. Valid values are `CURRENT`, `FUTURE` and `ALL`. If absent defaults to `CURRENT`.", "schema": { "type": "string", "default": "CURRENT", @@ -3251,9 +3251,9 @@ "properties": { "accountIds": { "type": "array", + "description": "Array of _accountId_ values.", "items": { "type": "string", - "description": "Array of specific accountIds to obtain authorisations for.", "x-cds-type": "ASCIIString" } } @@ -5231,7 +5231,7 @@ }, "offsetAccountIds": { "type": "array", - "description": "The accountIDs of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that _offsetAccountEnabled_ is set to `true` but the _offsetAccountIds_ field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation.", + "description": "The _accountId_ values of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that _offsetAccountEnabled_ is set to `true` but the _offsetAccountIds_ field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation.", "items": { "type": "string", "x-cds-type": "ASCIIString" @@ -6487,11 +6487,11 @@ "properties": { "accountId": { "type": "string", - "description": "ID of the account that is the source of funds for the payment.", + "description": "_accountId_ of the account that is the source of funds for the payment.", "x-cds-type": "ASCIIString" } }, - "description": "Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the _to_ object." + "description": "Object containing details of the source of the payment. Currently only specifies an _accountId_ but provided as an object to facilitate future extensibility and consistency with the _to_ object." }, "BankingScheduledPaymentRecurrence": { "required": [ @@ -6568,7 +6568,7 @@ }, "nonBusinessDayTreatment": { "type": "string", - "description": "Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be `ON`.
  • `AFTER` - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
  • `BEFORE` - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
  • `ON` - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
  • `ONLY` - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored
", + "description": "Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be `ON`.
  • `AFTER` - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
  • `BEFORE` - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
  • `ON` - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
  • `ONLY` - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored.
", "default": "ON", "enum": [ "AFTER", diff --git a/swagger-gen/api/cds_banking_non_bank_lending.json b/swagger-gen/api/cds_banking_non_bank_lending.json index bd21a0caa..ce73d8ee6 100644 --- a/swagger-gen/api/cds_banking_non_bank_lending.json +++ b/swagger-gen/api/cds_banking_non_bank_lending.json @@ -549,7 +549,7 @@ } ], "requestBody": { - "description": "The list of account IDs to obtain balances for.", + "description": "The list of _accountId_ values to obtain balances for.", "content": { "application/json": { "schema": { @@ -1908,7 +1908,7 @@ } ], "requestBody": { - "description": "Array of specific accountIds to obtain authorisations for.", + "description": "Array of _accountId_ values to obtain authorisations for.", "content": { "application/json": { "schema": { @@ -2516,7 +2516,7 @@ } ], "requestBody": { - "description": "Array of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned.", + "description": "Array of _accountId_ values to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned.", "content": { "application/json": { "schema": { @@ -2626,7 +2626,7 @@ { "name": "type", "in": "query", - "description": "Filter on the payee type field. In addition to normal type field values, `ALL` can be specified to retrieve all payees. If absent the assumed value is `ALL`.", + "description": "Filter on the payee _type_ field. In addition to normal _type_ field values, `ALL` can be specified to retrieve all payees. If absent the assumed value is `ALL`.", "schema": { "type": "string", "default": "ALL", @@ -2997,7 +2997,7 @@ { "name": "effective", "in": "query", - "description": "Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are `CURRENT`, `FUTURE` and `ALL`. If absent defaults to `CURRENT`.", + "description": "Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the _effectiveFrom_ and _effectiveTo_ fields. Valid values are `CURRENT`, `FUTURE` and `ALL`. If absent defaults to `CURRENT`.", "schema": { "type": "string", "default": "CURRENT", @@ -3251,9 +3251,9 @@ "properties": { "accountIds": { "type": "array", + "description": "Array of _accountId_ values.", "items": { "type": "string", - "description": "Array of specific accountIds to obtain authorisations for.", "x-cds-type": "ASCIIString" } } @@ -4658,7 +4658,7 @@ }, "offsetAccountIds": { "type": "array", - "description": "The accountIDs of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that _offsetAccountEnabled_ is set to `true` but the _offsetAccountIds_ field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation.", + "description": "The _accountId_ values of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that _offsetAccountEnabled_ is set to `true` but the _offsetAccountIds_ field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation.", "items": { "type": "string", "x-cds-type": "ASCIIString" @@ -5668,11 +5668,11 @@ "properties": { "accountId": { "type": "string", - "description": "ID of the account that is the source of funds for the payment.", + "description": "_accountId_ of the account that is the source of funds for the payment.", "x-cds-type": "ASCIIString" } }, - "description": "Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the _to_ object." + "description": "Object containing details of the source of the payment. Currently only specifies an _accountId_ but provided as an object to facilitate future extensibility and consistency with the _to_ object." }, "BankingScheduledPaymentRecurrence": { "required": [ diff --git a/swagger-gen/api/cds_energy.json b/swagger-gen/api/cds_energy.json index fc3a42068..f1670bae5 100644 --- a/swagger-gen/api/cds_energy.json +++ b/swagger-gen/api/cds_energy.json @@ -1432,7 +1432,7 @@ "description": "Represents a tariff based on time. Mandatory if tariffUType is set to timeVaryingTariffs", "items":{ "type": "object", - "required": ["amount", "timeVariations","displayName"], + "required": ["timeVariations","displayName"], "properties": { "type": { "type": "string", @@ -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 dailySupplyChargeType 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 dailySupplyChargeType 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" }, diff --git a/swagger-gen/api/cds_telco.json b/swagger-gen/api/cds_telco.json index f9df51ff0..9366f29fe 100644 --- a/swagger-gen/api/cds_telco.json +++ b/swagger-gen/api/cds_telco.json @@ -1761,14 +1761,14 @@ "components": { "headers": { "x-v": { + "description": "The [version](#response-headers) of the API end point that the data holder has responded with.", "schema": { - "description": "The [version](#response-headers) of the API end point that the data holder has responded with.", "type": "string" } }, "x-fapi-interaction-id": { + "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "schema": { - "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "type": "string" } } diff --git a/swagger-gen/oas_generate.sh b/swagger-gen/oas_generate.sh index fb2afb2c8..3a1daf47f 100755 --- a/swagger-gen/oas_generate.sh +++ b/swagger-gen/oas_generate.sh @@ -31,7 +31,7 @@ mkdir $SWAGGER_CODEGEN_OUTPUT #codegen validator echo "*** Checking OAS Validator ***" -VALID_OAS=$(java -jar $OAS_CODEGEN/openapi-generator-cli.jar validate -i $INPUT_SWAGGER) +VALID_OAS=$(java -jar $OAS_CODEGEN/openapi-generator-cli-6.6.0.jar validate -i $INPUT_SWAGGER) echo "*** OAS Validator: " $VALID_OAS # generate diff --git a/swagger-gen/widdershins-cdr/templates/openapi3/operation.dot b/swagger-gen/widdershins-cdr/templates/openapi3/operation.dot index ee2b37107..154044771 100644 --- a/swagger-gen/widdershins-cdr/templates/openapi3/operation.dot +++ b/swagger-gen/widdershins-cdr/templates/openapi3/operation.dot @@ -47,6 +47,11 @@ |---|--| |Version|**{{? data.operation["x-version"]}}{{= data.operation["x-version"]}}{{??}}Versioning is not supported for this endpoint{{?}}** +{{? data.operation["x-version-notes"]}} +

Version Notes

+{{= data.operation["x-version-notes"]}} +{{?}} + {{? data.parameters && data.parameters.length }} {{#def.parameters}} {{?}} diff --git a/utils/README.md b/utils/README.md index 95930079a..388b402d8 100644 --- a/utils/README.md +++ b/utils/README.md @@ -5,9 +5,8 @@ The new_version_setup.py script configures a new branch in preparation for stagi It does the following: * Change the version number of the standards in the intro markdown * Change the version number in each of the master swagger files in swagger-gen -* Add an entry to the change log table for the new version +* Add an entry to the Changelog and archives table for the new version * Create the release notes file for the new version with blank content and all of the references to the version updated -* Add an entry for the previous version in the archives table * Remove all of the diff statements except for the one in the intro section that outlines how the diff tab works (_version_delta_intro.md) ## Usage diff --git a/utils/new_version_setup.py b/utils/new_version_setup.py index 47647e1ec..439a86dba 100644 --- a/utils/new_version_setup.py +++ b/utils/new_version_setup.py @@ -9,12 +9,10 @@ new_version = "-1.-1.-1" current_version = "-2.-2.-2" exclude_list = ["_version_delta_intro.md"] # Define the exclude_list for diff block removal -changelog_table_header = "|Change Date|Version|Description|Detail of change|" -archives_table_header = "|Release Date|Version|Description|" +changelog_table_header = "| Date | Version | Description | Detail of change |" SWAGGERGENAPIPATH = '../swagger-gen/api' INTROMDPATH = '../slate/source/includes/introduction/_intro.md' CHANGEPATH = '../slate/source/includes/changelog.md' -ARCHIVESPATH = '../slate/source/includes/archives.md' RELEASENOTESPATH = "../slate/source/includes/releasenotes" def set_new_minor_version(content): @@ -150,37 +148,15 @@ def create_releasenotes(): print(f"Release notes file '{filename}' created successfully.") ########################################################### -# Add entry for previous version to the archives table -def add_archives_entry(): - # Get latest changelog entry - current_changelog_entry = get_first_entry(CHANGEPATH, changelog_table_header) - - # Create archive fields - archive_change_date, archive_version, archive_description, _ = map(str.strip, current_changelog_entry.split('|')[1:5]) - - # Add link to archive date - archive_change_date = f"{archive_change_date}" - - # Add link to archive description - archive_description = f"{archive_description}" - - # Create new archive entry - new_archive_entry = create_new_entry(archive_change_date, archive_version, archive_description) - - # Add new archive entry - add_new_entry(ARCHIVESPATH, archives_table_header, new_archive_entry) - print("Current version added to archives.") - -########################################################### -# Add an entry to the change log table for the new version +# Add an entry to the changelog table for the new version def add_changelog_entry(): - # Create new change log entry - new_changelog_entry = create_new_entry("TBC", new_version, "Changes TBC", f"See [release notes](includes/releasenotes/releasenotes.{new_version}.html) and [Decision XXX](https://github.com/ConsumerDataStandardsAustralia/standards/issues/XXX) for details.") + # Create new changelog entry + new_changelog_entry = create_new_entry("TBC", f"[{new_version}](https://consumerdatastandardsaustralia.github.io/standards-archives/standards-{new_version}/)", "Changes TBC", f"See [release notes](includes/releasenotes/releasenotes.{new_version}.html) and [Decision XXX](https://github.com/ConsumerDataStandardsAustralia/standards/issues/XXX) for details.") - # Add new change log entry + # Add new changelog entry add_new_entry(CHANGEPATH, changelog_table_header, new_changelog_entry) - print("New entry added to the change log.") + print("New entry added to the changelog.") ########################################################### @@ -255,7 +231,6 @@ def main(): update_version_in_intro() update_version_in_master_swagger() create_releasenotes() - add_archives_entry() add_changelog_entry() if "-ndiff" in sys.argv: print("'-ndiff' argument provided. diff blocks will not be removed")