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.

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

[CDS Spec documentation bug- Is x-fapi-auth-date header mandatory or optional] #430

Closed
AnantVijay-Cuscal opened this issue Nov 10, 2021 · 3 comments
Labels
Documentation Improvements, additions or queries related to documentation

Comments

@AnantVijay-Cuscal
Copy link

Description

On CDS API specs x-fapi-auth-date is Optional for Banking and Common APIs. However, the description says "Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls." https://consumerdatastandardsaustralia.github.io/standards/#banking-apis
Could you please update the Required and Description column to align with each other.

Area Affected

Required column in Parameter section of CDS API specifications for Banking and Common APIs. Also the swaggers for these APIs

Change Proposed

On CDS API specs x-fapi-auth-date is Optional for Banking and Common APIs. However, the description says "Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls." https://consumerdatastan
x-fapi-auth-date
dardsaustralia.github.io/standards/#banking-apis
Could you please update the Required and Description column to align with each other.

@CDR-API-Stream CDR-API-Stream added Documentation Improvements, additions or queries related to documentation api labels Nov 25, 2021
@CDR-API-Stream
Copy link
Collaborator

Hi @AnantVijay-Cuscal,

This is a documentation error. "x-fapi-auth-date" is mandatory for all authenticated resource endpoints but not the unauthenticated endpoints as described in the HTTP Headers section.

In the resource endpoint descriptions, we have "Optional" in the required column (see Get Accounts). This is a documentation error and it should read "Mandatory".

This issue will be fixed in the next version of the standards.

@CDR-API-Stream
Copy link
Collaborator

These changes have been staged for review: ConsumerDataStandardsAustralia/standards-staging@release/1.15.0...maintenance/430

@CDR-API-Stream
Copy link
Collaborator

CDR-API-Stream commented Dec 23, 2021

This change was incorporated into release v1.15.0. Refer to Decision 212 for further details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements, additions or queries related to documentation
Projects
Archived in project
Development

No branches or pull requests

2 participants