String pattern added to x-correlator scheme

[rartych]

What type of PR is this?

• correction

What this PR does / why we need it:

String pattern added to x-correlator scheme to improve security and inline with current recommendation for string parameters.
The proposed pattern covers recommended UUID strings and the length of 55 allows to use strings similar to traceparent from Trace Context.

CAMARA_common.yaml was updated accordingly.

Which issue(s) this PR fixes:

Fixes #352

Does this PR introduce a breaking change?

• Yes
• No

Special notes for reviewers:

The change should not be breaking for current implementations using UUID in x-correlator.

Changelog input

String pattern added to x-correlator scheme

Additional documentation

[PedroDiez]

LGTM

[patrice-conil]

LGTM

[hdamker]

Does this PR introduce a breaking change?

x Yes
No

I'm not sure that we should introduce this as a "breaking change" ... if we do so then all 1.0.0 API versions from Fall24 will go to automatically to 2.x.x in Spring25.

I formulated my proposal along the vendor opaque value in Trace Context, to avoid that we exclude any valid vendor specific correlator by this change and therefore don't need to declare it as breaking change. But maybe too late here ...

[rartych]

Formally it is a breaking change (modifying mandatory parameter).
API Design Guidelines recommend using UUID (if API Client implements "UUID-like" correlator then there is no breaking change) , however this recommendation is not included in API definitions - Possibly it can be added in x-correlator description field in CAMARA_common.yaml