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

V1.1.0: Remove x-cds-subject header from OpenAPI specification #72

Closed
deboraelkin2 opened this issue Dec 16, 2019 · 5 comments
Closed

Comments

@deboraelkin2
Copy link

Description

The OpenAPI specification still includes x-cds-subject header in all operations even though it has been removed from the standards

Area Affected

Both JSON and YAML versions of OpenAPI spec

Change Proposed

Remove the header as parameter for operations

@CDR-API-Stream
Copy link
Collaborator

The retention of the x-cds-subject was an error and has been included in the errata section of the release notes for v1.1.0. This will be resolved in the next version of the standards.

@perlboy
Copy link

perlboy commented Dec 16, 2019

Based on the response in #61 (comment) whereby the OpenAPI specification is "non normative" it does not appear errata should have contained a note about an error in the OpenAPI specification.

Could guidelines be provided as to how a decision was reached to document one omission in errata but not document changes with additional direct developer impacts?

@deboraelkin2
Copy link
Author

The retention of the x-cds-subject was an error and has been included in the errata section of the release notes for v1.1.0. This will be resolved in the next version of the standards.

Thanks for the clarification

@CDR-API-Stream
Copy link
Collaborator

Based on the response in #61 (comment) whereby the OpenAPI specification is "non normative" it does not appear errata should have contained a note about an error in the OpenAPI specification.

Could guidelines be provided as to how a decision was reached to document one omission in errata but not document changes with additional direct developer impacts?

The incorrect specification of headers in end point documentation is obviously material to the standards whereas model names (the focus of the discussion in #61) are not material.

@CDR-API-Stream
Copy link
Collaborator

This change has been incorporated into v1.1.1 of the standards.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

3 participants