Skip to content

Commit

Permalink
Create 1.33.0 branch base
Browse files Browse the repository at this point in the history
  • Loading branch information
nils-work committed Oct 28, 2024
1 parent 2a69040 commit aa73afe
Show file tree
Hide file tree
Showing 29 changed files with 116 additions and 108 deletions.
6 changes: 1 addition & 5 deletions slate/source/includes/_admin.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,7 @@

This specification defines the Admin APIs that apply to Data Holders.

```diff
Updated the description of the Admin APIs section
- This provides an overview of CDS Administration Endpoints. Please note this API is intended for Data Holders/ Recipients only.
+ This specification defines the Admin APIs that apply to Data Holders.
```


<table>
<tr><td><a href='./includes/swagger/cds_admin.json'>Admin OpenAPI Specification (JSON)</a></td></tr>
Expand Down
4 changes: 1 addition & 3 deletions slate/source/includes/_banking_apis.md.erb
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# 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.

Expand Down
6 changes: 1 addition & 5 deletions slate/source/includes/_common_apis.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,7 @@

This specification defines the Common APIs that apply to Data Holders in all sectors.

```diff
Updated the description of the Common APIs section
- This specification defines the Common APIs that apply to Data Holders multiple sectors.
+ This specification defines the Common APIs that apply to Data Holders in all sectors.
```


<table>
<tr><td><a href='./includes/swagger/cds_common.json'>Common OpenAPI Specification (JSON)</a></td></tr>
Expand Down
4 changes: 1 addition & 3 deletions slate/source/includes/_dcr_apis.md.erb
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# DCR APIs

```diff
Fixed typos and formatting in multiple specification files (documentation)
```


This specification defines the APIs for Data Holders exposing Dynamic Client Registration endpoints.

Expand Down
17 changes: 3 additions & 14 deletions slate/source/includes/_energy_apis.md.erb
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@

# 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.

Expand All @@ -15,14 +10,8 @@ This specification defines the APIs for Data Holders exposing Energy endpoints.
<tr><td><a href='./includes/swagger/cds_energy.yaml'>Energy OpenAPI Specification (YAML)</a></td></tr>
</table>

```diff
For tariffUType the in EnergyPlanSolarFeedInTariffV3, the following change has been made:
- The type of the payer
+ Reference to the applicable tariff structure
```

```diff
Corrected mistake in the timeVaryingTariffs schema which specified amount as a required property
```



<%= partial "includes/cds_energy.md" %>
9 changes: 0 additions & 9 deletions slate/source/includes/_register.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,7 @@ These endpoints are exposed by the Register and consumed by Data Holders and Dat
These statuses are provided authoritatively by the Register to allow participants to determine whether a connecting third-party is permitted to perform registration requests or data sharing requests.
</aside>

```diff
Updated the server URL placeholder in the Register spec to refer to the actual Base URLs
- "url": "https://<register-base-url>/"

+ "url": "https://api.cdr.gov.au"
+ "description": "Production TLS"

+ "url": "https://secure.api.cdr.gov.au"
+ "description": "Production MTLS"
```

<table>
<tr><td><a href='./includes/swagger/cds_register.json'>Register OpenAPI Specification (JSON)</a></td></tr>
Expand Down
4 changes: 1 addition & 3 deletions slate/source/includes/additional.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ 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:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
This specification defines the APIs for Data Holders exposing Telecommunications endpoints.

```diff
Updated Telco specification to ensure response header details are displayed correctly
```


<table>
<tr><td><a href='../../../../includes/swagger/cds_telco.json'>Telco OpenAPI Specification (JSON)</a></td></tr>
Expand Down
6 changes: 1 addition & 5 deletions slate/source/includes/banking/_product_categories.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
## Product Categories

```diff
Updated the description of the Product Categories section
- The Product Category enumeration lists the available product categories for categorising products and accounts.
+ The productCategory enumeration provides the values for categorising products and accounts.
```


The [_productCategory_ enumeration](#cdr-banking-api_schemas_tocSbankingproductcategory) provides the values for categorising products and accounts. These are explained in the following tables:

Expand Down
12 changes: 3 additions & 9 deletions slate/source/includes/banking/_product_components.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
<a id="productfeaturetypedoc"></a>
<h3 id="tocSproductfeaturetypedoc">Product Feature Types</h3>

```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.

Expand Down Expand Up @@ -160,9 +158,7 @@ A deposit product is expected to present a single Base rate corresponding to rel
<a id="productdepositadjustmentratetypedoc"></a>
<ul><li id="tocSproductdepositadjustmentratetypedoc"><b>Deposit Adjustment Rate Types</b></li></ul>

```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.

Expand Down Expand Up @@ -199,9 +195,7 @@ Card products may have two or more base rates, including `CASH_ADVANCE` and `PUR
<a id="productlendingadjustmentratetypedoc"></a>
<ul><li id="tocSproductlendingadjustmentratetypedoc"><b>Lending Adjustment Rate Types</b></li></ul>

```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.

Expand Down
5 changes: 2 additions & 3 deletions slate/source/includes/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,13 @@
</p>


```diff
Merged the Change Log and Archives sections. Archived versions are available through the links in the Version column.
```


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.33.0](https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.33.0/) | Changes TBC | See [release notes](includes/releasenotes/releasenotes.1.33.0.html) and [Decision XXX](https://github.com/ConsumerDataStandardsAustralia/standards/issues/XXX) for details. |
| 21/10/2024 | <a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.32.0/'>1.32.0</a> | Changes from Maintenance Iteration 20. | See [release notes](includes/releasenotes/releasenotes.1.32.0.html) and [Decision 353](https://github.com/ConsumerDataStandardsAustralia/standards/issues/353) for details. |
| 03/07/2024 | <a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.31.0/'>1.31.0</a> | 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 | <a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.30.0/'>1.30.0</a> | 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. |
Expand Down
6 changes: 2 additions & 4 deletions slate/source/includes/introduction/_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,10 @@ The standards are required to be published. The obligations on CDR participants
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.


```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.
These standards represent version 1.33.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)**.
9 changes: 2 additions & 7 deletions slate/source/includes/introduction/_references.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
## Normative References

```diff
+ Added BCP195 to the list of normative references
- Removed BCP195 from the list of informative references
```


| **Reference** | **Description** | **Version** |
|-|-|-|
Expand Down Expand Up @@ -42,9 +39,7 @@

## Informative References

```diff
Improved styling of 'Code samples' displayed in the Non-Normative Examples tab
```


| **Reference** | **Description** |
|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand Down
4 changes: 1 addition & 3 deletions slate/source/includes/known-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

There are certain aspects of the standards that are actively under review. These known issues are articulated in the following table.

```diff
Removed three known issues related to Register endpoint specfications that are resolved
```


Issue | Description
:---- | :----------
Expand Down
83 changes: 83 additions & 0 deletions slate/source/includes/releasenotes/releasenotes.1.33.0.html.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
title: Consumer Data Standards - v1.33.0 Release Notes

#language_tabs: # must be one of https://git.io/vQNgJ

toc_footers:
- <a href='../../index.html'>Consumer Data Standards</a>

search: false
---

# V1.33.0 Release Notes
Release notes for version v1.33.0 of the [CDR Standards](../../index.html).

## Changes Made
### Change Requests

This release addresses the following minor defects raised on [Standards Staging](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues):

- [Standards Staging #XXX - Title](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/XXX)

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)


### Decision Proposals
This release addresses the following Decision Proposals published on [Standards](https://github.com/ConsumerDataStandardsAustralia/standards/issues):

- [Decision Proposal #XXX - Title](https://github.com/ConsumerDataStandardsAustralia/standards/issues/XXX)


## General Changes
|Change|Description|Link|
|------|-----------|----|
| Change summary | [**Standards Staging #XXX**](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/XXX): Change detail | [Standards section](../../#section)
| 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)


## Introduction
|Change|Description|Link|
|------|-----------|----|


## High Level Standards
|Change|Description|Link|
|------|-----------|----|


## API Endpoints
|Change|Description|Link|
|------|-----------|----|


## Information Security Profile
|Change|Description|Link|
|------|-----------|----|


## Register Standards
|Change|Description|Link|
|------|-----------|----|


## Consumer Experience
|Change|Description|Link|
|------|-----------|----|


## Non-Functional Requirements
|Change|Description|Link|
|------|-----------|----|


## Additional Standards
|Change|Description|Link|
|------|-----------|----|


## Known Issues
|Change|Description|Link|
|------|-----------|----|
7 changes: 0 additions & 7 deletions slate/source/includes/security/_client_authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,14 +205,7 @@ In addition to the requirements for [Self-signed JWT Client Authentication](#sel

In addition to the requirements for [Private Key JWT Client Authentication](#private-key-jwt-client-authentication) the following requirements **MUST** be supported:

```diff
- authorisation_code
+ authorization_code

Changed the statements regarding client ID issuance due to redundant statement. Removes:
- The client ID represents the ID issued to the Data Recipient Software Product by the Data Holder upon successful dynamic client registration.

```

* The authorisation grant's `client_id` parameter value **MUST** represent the ID issued to the Data Recipient Software Product by the Data Holder upon successful dynamic client registration.
* The authorisation grant's `grant_type` parameter value **MUST** only be included when invoking the Token End point and **MUST** be set to `authorization_code` or `client_credentials`. The value `refresh_token` is also valid when refreshing an access token.
Expand Down
6 changes: 1 addition & 5 deletions slate/source/includes/security/_transport_security.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,7 @@ OAUTB SHALL NOT be supported due to a lack industry support.
### Ciphers


```diff
Obligation change from March 17th 2025:
- Removed specific named ciphers
+ Adopted BCP195
```


**Until March 17th 2025, the following SHALL requirements apply:**

Expand Down
10 changes: 1 addition & 9 deletions slate/source/includes/standards/_types.md
Original file line number Diff line number Diff line change
@@ -1,18 +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.

```diff
Change to URIString example:
- "http://www.google.com"
+ "https://www.example.com"
```


Type | Description | Valid Examples
-----|-------------|---------------
Expand Down
2 changes: 1 addition & 1 deletion swagger-gen/api/cds_admin.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"name": "MIT License",
"url": "https://opensource.org/licenses/MIT"
},
"version": "1.32.0"
"version": "1.33.0"
},
"servers": [
{
Expand Down
2 changes: 1 addition & 1 deletion swagger-gen/api/cds_banking.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"name": "MIT License",
"url": "https://opensource.org/licenses/MIT"
},
"version": "1.32.0"
"version": "1.33.0"
},
"servers": [
{
Expand Down
2 changes: 1 addition & 1 deletion swagger-gen/api/cds_banking_dp306.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"name": "MIT License",
"url": "https://opensource.org/licenses/MIT"
},
"version": "1.32.0"
"version": "1.33.0"
},
"servers": [
{
Expand Down
2 changes: 1 addition & 1 deletion swagger-gen/api/cds_banking_non_bank_lending.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"name": "MIT License",
"url": "https://opensource.org/licenses/MIT"
},
"version": "1.32.0"
"version": "1.33.0"
},
"servers": [
{
Expand Down
Loading

0 comments on commit aa73afe

Please sign in to comment.