Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add RFC8174 to list of normative references and update the use of Requirements Levels #473

Closed
CDR-API-Stream opened this issue Feb 15, 2022 · 2 comments
Closed

Add RFC8174 to list of normative references and update the use of Requirements Levels #473

CDR-API-Stream opened this issue Feb 15, 2022 · 2 comments
Labels
Documentation Improvements, additions or queries related to documentation Non-breaking change A change that is not expected to result in a new endpoint version. Proposal made The DSB has proposed a specific change to the standards to address the change request
Milestone
v1.33.0

Comments

@CDR-API-Stream
Copy link
Collaborator

CDR-API-Stream commented Feb 15, 2022 •
edited by nils-work
Loading

Description

RFC8174 - Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words provides an update to normative reference RFC 2119 - Key words for use in RFCs to Indicate Requirement Levels for Requirement Levels such that requirement levels must be capitalised. This change considers the options for inclusion of RFC8174 as a normative reference and standardisation of requirements level usage in the Data Standards to be capitalised.

Area Affected

Normative References - Requirements Levels and non-capitalised usage of requirement levels.

Change Proposed

A) Update all usage of requirements levels to adopt the capitalised form.
B) Update normative references with [RFC8174] in addition to [RFC2119]
C) Update the Data Standards introduction with respect to requirements levels as appropriate with reference to [RFC8174]

Optionally:
Community feedback has also identified BCP14 - Key words for use in RFCs to Indicate Requirement Levels as an option for best practice usage of requirements levels and usage within the Data Standards. This best practice document communicates the appropriate use of words and capitalisation similar to RFC8174.

Further analysis:
Analysis of the update are published here: https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/blob/master/reviews/2021-05/analysis/analysis-rfc2119-rfc8174-20210519.md

DSB Proposed Solution

The current DSB proposal for this issue is in #473 (comment).
The other changes noted in this issue will be carried forward to a new issue.
@CDR-API-Stream CDR-API-Stream added Documentation Improvements, additions or queries related to documentation change request labels Feb 15, 2022
@nils-work nils-work mentioned this issue Sep 14, 2023
Open
@nils-work nils-work moved this from Full Backlog to Iteration Candidates in Data Standards Maintenance Oct 3, 2023
@ElizabethArnold-DSB ElizabethArnold-DSB moved this from Iteration Candidates to Full Backlog in Data Standards Maintenance Nov 13, 2023
@nils-work
Copy link
Member

nils-work commented May 30, 2024 •
edited
Loading

As a starting point, proposing the following changes to be made:

  • Replace 'must' with 'MUST' in the following sentence:

    An [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] UUID value is required to be provided in the response header to track the interaction.

  • Replace 'must' with 'MUST' in the following sentence:

    If all versions requested are not supported then the data holder MUST respond with a 406 Not Acceptable.

    • This change will also update the text:

    If all versions requested are not supported then the Register MUST respond with a 406 Not Acceptable.

@nils-work nils-work added this to the v1.33.0 milestone Oct 22, 2024
nils-work added a commit to ConsumerDataStandardsAustralia/standards-staging that referenced this issue Nov 1, 2024
@nils-work
Replaced 'must' with 'MUST' in some headers
87036d0 
Addresses: ConsumerDataStandardsAustralia/standards-maintenance#473 (comment)
@nils-work nils-work mentioned this issue Nov 1, 2024
Merged
@nils-work
Copy link
Member

This initial update has been staged - https://github.com/ConsumerDataStandardsAustralia/standards-staging/pull/450/files

@nils-work nils-work added Proposal made The DSB has proposed a specific change to the standards to address the change request Non-breaking change A change that is not expected to result in a new endpoint version. labels Nov 19, 2024
nils-work added a commit to ConsumerDataStandardsAustralia/standards that referenced this issue Dec 18, 2024
@nils-work @markverstege
Release/1.33.0 (#362)
2588beb 
* Created 1.32.0 branch base

* Staging #429 - Refactor Banking API spec

Addresses: ConsumerDataStandardsAustralia/standards-staging#429

* Create 1.33.0 branch base

* Updated refresh token expiry requirements related to Standards Maintenance issue #667

* Made links relative to avoid page refresh

Addresses: ConsumerDataStandardsAustralia/standards-staging#435 (comment)

* Added and updated servers in specs and examples

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#663 (comment)

* Link to specific comment

* Remove scheme from host field

* Clarified 'CDR Arrangement JWT method' details

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#663 (comment)

* Updated Reporting Requirements section

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#663 (comment)

* Replaced 'must' with 'MUST' in some headers

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#473 (comment)

* Applied consistent styling

Addresses: ConsumerDataStandardsAustralia/standards-staging#442

* Key word styling

Addresses: ConsumerDataStandardsAustralia/standards-staging#443

* Move note to correct section

* Corrected typos, updated styling

Addresses: ConsumerDataStandardsAustralia/standards-staging#431

* Staging #429 - Refactor Banking API spec

Addresses: ConsumerDataStandardsAustralia/standards-staging#429

* Update MTLS section 3 link

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#663 (comment)

* Clarify retirement date statements

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#663 (comment)

* Updated Obligation Date Schedule

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#661

* Clarified transaction security requirements

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#654

* Updated field descriptions

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#655

* Updated CX Standards

Addresses: #350

* Updated Normative References

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#675

* Tidied table formatting

* Get Product Detail v5 with LVR constraints

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#657

* Rename file to prevent generated version

Addresses: ConsumerDataStandardsAustralia/standards-staging#463

* Adjusted values to align format

* Corrected Date Schedule

* Standards Maintenance 664: Support for additional NPP service overlays and all versions

* Added diff for FDO table

* Change CDS links to DSB

Addresses: ConsumerDataStandardsAustralia/standards-staging#468

* Closed list items in unordered list

* Minor corrections

* Updates

* Minor updates

- customer > consumer
- obligation sequence

* Deprecated OiDC Hybrid Flow with retirement date set for May 12th 2025

* Add condition

* Updated diff comment for OIDC hybrid flow to indicate it is deprecated

* Update get-transaction-detail-v1.html.md

* Apply dates, logo and correct merge differences

* Rebuild

* Rebuild specs

* Minor corrections

* Update obligation table

---------

Co-authored-by: Mark Verstege <[email protected]>
@github-project-automation github-project-automation bot moved this from In Progress: Staging to Done in Data Standards Maintenance Dec 20, 2024
@nils-work nils-work mentioned this issue Jan 15, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Improvements, additions or queries related to documentation Non-breaking change A change that is not expected to result in a new endpoint version. Proposal made The DSB has proposed a specific change to the standards to address the change request
Projects
Data Standards Maintenance
Status: Done
Milestone
v1.33.0
Development

No branches or pull requests
2 participants
@CDR-API-Stream @nils-work