search

camaraproject / Commonalities

Repository to describe, develop, document and test the common guidelines and assets for CAMARA APIs
Apache License 2.0
9 stars 24 forks source link

is UUID a must for x-correlator? #166

Closed jlurien closed 3 months ago

jlurien commented 4 months ago

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 commented 4 months ago

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 commented 4 months ago

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

nickvenezia commented 4 months ago

I vote to keep the string open.

PedroDiez commented 3 months ago

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

shilpa-padgaonkar commented 3 months ago

@PedroDiez Fine from my view.

jlurien commented 3 months ago

PR created to fix this: https://github.com/camaraproject/Commonalities/pull/168

nickvenezia commented 3 months ago

I believe it is an acronym for a unique identifier and is a field where multiple identifiers can be plugged into. Sent from my iPhone

On Apr 15, 2024, at 10:12 AM, Rafal Artych @.***> wrote:



Closed #166https://github.com/camaraproject/Commonalities/issues/166 as completed via #168https://github.com/camaraproject/Commonalities/pull/168.

— Reply to this email directly, view it on GitHubhttps://github.com/camaraproject/Commonalities/issues/166#event-12472155798, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A2QCWCJNEAEFLEIWIUGSVILY5PU43AVCNFSM6AAAAABEUAZSJWVHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMJSGQ3TEMJVGU3TSOA. You are receiving this because you commented.Message ID: @.***>