Skip to content

X-Correlator Format Change#463

Merged
rartych merged 1 commit intocamaraproject:mainfrom
PedroDiez:x-correlator_format_change
Jun 3, 2025
Merged

X-Correlator Format Change#463
rartych merged 1 commit intocamaraproject:mainfrom
PedroDiez:x-correlator_format_change

Conversation

@PedroDiez
Copy link
Contributor

@PedroDiez PedroDiez commented May 16, 2025

What type of PR is this?

  • enhancement

What this PR does / why we need it:

Update x-correlator pattern, as commented by the rationale under Issue #436.
Also manages Issue #422, to have an aligned and documented behaviour from Fall25.

Documentation Impacted:

  • CAMARA-API-Design-Guide.md
  • CAMARA_common.yaml
  • event-subscription-template.yaml
  • notification-as-cloud-event.yaml (adding as well)

Which issue(s) this PR fixes:

Fixes #422, #436

Does this PR introduce a breaking change?

  • Yes
  • No

Special notes for reviewers:

N/A

Changelog input

 x-correlator format update

Additional documentation

N/A

@PedroDiez PedroDiez self-assigned this May 16, 2025
@PedroDiez PedroDiez added enhancement New feature or request Fall25 labels May 16, 2025
@PedroDiez PedroDiez requested a review from Kevsy May 16, 2025 16:59
Copy link
Contributor

@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

@Kevsy
Copy link
Collaborator

Kevsy commented May 19, 2025

LGTM - but do we need to document the behaviour when the client sends an x-correlator of zero length?

@patrice-conil
Copy link
Contributor

LGTM - but do we need to document the behaviour when the client sends an x-correlator of zero length?

In this case, I think that as we return the value provided by the client, we will send an empty string.

@Kevsy
Copy link
Collaborator

Kevsy commented May 19, 2025

In this case, I think that as we return the value provided by the client, we will send an empty string.

Yeah...just seems wasteful. I could understand if sending an empty string meant 'please can the network generate a correlator for me and send it back', but I can't see the rationale for sending an empty string if the network is just going to echo it back.

@PedroDiez
Copy link
Contributor Author

In this case, I think that as we return the value provided by the client, we will send an empty string.

Yeah...just seems wasteful. I could understand if sending an empty string meant 'please can the network generate a correlator for me and send it back', but I can't see the rationale for sending an empty string if the network is just going to echo it back.

This point is already covered Kevin, Patrice:
When the API Consumer includes non-empty "x-correlator" header in the request, the API Provider must include it in the response with the same value that was used in the request. Otherwise, it is optional to include the "x-correlator" header in the response with any valid value.

It can be an empty string or a valid value, up to the Telco Operator

Copy link

@cesrgzrz cesrgzrz 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
Contributor

@rartych rartych left a comment

Choose a reason for hiding this comment

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

LGTM

@Kevsy
Copy link
Collaborator

Kevsy commented May 20, 2025

Thanks, LGTM

@rartych rartych merged commit 6b8a29d into camaraproject:main Jun 3, 2025
1 check passed
@rartych rartych linked an issue Jun 3, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request Fall25

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Proposal for x-correlator format change Management of x-correlator header when value input by API consumer does not comply the pattern

5 participants