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

Set X-Correlator as Required in OAS Definition, X-Version removed #115

Merged
merged 1 commit into from
Feb 5, 2024

Conversation

jlurien
Copy link
Contributor

@jlurien jlurien commented Dec 20, 2023

What type of PR is this?

Add one of the following kinds:

  • documentation

What this PR does / why we need it:

  • Removed X-Version
  • X-Correlator is now set as "Required in OAS Definition"

Which issue(s) this PR fixes:

Fixes #101

- Removed X-Version
- X-Correlator is now set as "Required in OAS Definition"
@uwerauschenbach
Copy link
Collaborator

Hi, a question: https://spec.openapis.org/oas/v3.1.0 does not mention X-Correlator. Where is it stated in OAS that it is required?

@jlurien
Copy link
Contributor Author

jlurien commented Dec 22, 2023

Hi, a question: https://spec.openapis.org/oas/v3.1.0 does not mention X-Correlator. Where is it stated in OAS that it is required?

We are not meaning here that it is required by the OAS standard to be included, we mean that CAMARA requires that this header is documented in our OAS specs, so the resulting API specs are consistent.

Copy link
Collaborator

@patrice-conil patrice-conil left a comment

Choose a reason for hiding this comment

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

/LGTM

Copy link
Collaborator

@shilpa-padgaonkar shilpa-padgaonkar left a comment

Choose a reason for hiding this comment

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

/LGTM

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.

Should the headers like x-correlator be included in OAS definition?
6 participants