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

X-Correlator or x-correlator #191

Closed
jlurien opened this issue Apr 25, 2024 · 4 comments · Fixed by #194
Closed

X-Correlator or x-correlator #191

jlurien opened this issue Apr 25, 2024 · 4 comments · Fixed by #194
Labels
correction correction in documentation

Comments

@jlurien
Copy link
Contributor

jlurien commented Apr 25, 2024

Problem description
Guidelines in Commonalities specifies "X-Correlator" but almost all API specs define already "x-correlator"

Expected behavior
Even if header name is case insensitive and both options are interoperable, we should define a common behaviour for coherence, aligned with Guidelines.

As de facto API specs are using "x-correlator", it would be less effort to reflect this in the Guidelines.

It would be convenient to set a new linting rule to check that the header is included in the requests and responses, following the agreed format.

Alternative solution
Adjust all APIs using "x-correlator"

@rartych
Copy link
Collaborator

rartych commented Apr 26, 2024

Agree - to be considered in #188
We have also pending action : "X-Correlator header definition to be added to CAMARA_common.yaml" in minutes - we should define a common format in https://github.com/camaraproject/Commonalities/blob/main/artifacts/CAMARA_common.yaml

@PedroDiez
Copy link
Collaborator

Agree to align

@bigludo7
Copy link
Collaborator

Agree to align for me also.

@PedroDiez
Copy link
Collaborator

If no comments in different direction, a PR will be generated this week to align naming to "x-correlator" in design guidelines and also CloudEvent artifact

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

Successfully merging a pull request may close this issue.

4 participants