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

PROVISIONAL : CDS alignment - top level members for canonical business information resources #75

Merged
merged 10 commits into from
Dec 2, 2021

Conversation

TimGoodwill
Copy link

PROVISIONAL on a decision to align with CDS
Provides guidance on the use of 'data' and 'meta' headers, and when they should apply.

Additional updates:

‘Etag’ header does not apply to requests, replaced with client-side 'If-None-Match'
addition of optional 'Request-Id' header for tracability
replaced status code definitions with a reference to https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
replaced voluminous response code tables with a more readable matrix

Update to api-versioning.md to provide both camelCase and snake_case version payload to align with updated definitions.md case consistency reqirement.
Change MUST to SHOULD - this is a significant requirement will not be implementable in some cases.
Updates to api-request.md to provide direction on the use of a data top level member
Updates to api-response.md to provide direction on the use of a data top level member
Updates to api-request.md to provide direction on the use of a data top level member
Copy link
Collaborator

@nb46kd nb46kd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good Tim

@cj7hawk cj7hawk merged commit 9650a50 into apigovau:master Dec 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants