Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

is UUID a must for x-correlator? #166

Closed
jlurien opened this issue Mar 13, 2024 · 7 comments · Fixed by #168
Closed

is UUID a must for x-correlator? #166

jlurien opened this issue Mar 13, 2024 · 7 comments · Fixed by #168
Labels
correction correction in documentation

Comments

@jlurien
Copy link
Contributor

jlurien commented Mar 13, 2024

Problem description
Guidelines indicate that pattern for x-correlator is UUID but when added to OAS, only type: string is indicated

Expected behavior
Clarify in Guidelines whether UUID format is just a recommendation, or remove pattern and leave ir completely free for clients to choose, or include pattern or format in OAS

@PedroDiez
Copy link
Collaborator

Understood the need of aligment. Probably there is no need of limiting the format of the x-correlator to be an UUID, so it could be admitted the use of a generic string, and align it accordingly in the guidelines.

@bigludo7
Copy link
Collaborator

Same view than @PedroDiez : we could remove the enforcement of uuid in the guideline and keep this only as a generic string.

@nickvenezia
Copy link

nickvenezia commented Mar 17, 2024

I vote to keep the string open.

@PedroDiez
Copy link
Collaborator

@shilpa-padgaonkar, @eric-murray, would be fine from your view to have x-correlator as open string?

@shilpa-padgaonkar
Copy link
Collaborator

@PedroDiez Fine from my view.

@jlurien
Copy link
Contributor Author

jlurien commented Mar 19, 2024

PR created to fix this: #168

@nickvenezia
Copy link

nickvenezia commented Apr 15, 2024 via email

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

Successfully merging a pull request may close this issue.

5 participants