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

Allow zero-length strings in x-correlator header to avoid unnecessary breaking of API clients #383

Open
hdamker opened this issue Jan 17, 2025 · 0 comments · May be fixed by #387
Open

Allow zero-length strings in x-correlator header to avoid unnecessary breaking of API clients #383

hdamker opened this issue Jan 17, 2025 · 0 comments · May be fixed by #387
Labels
correction correction in documentation Spring25

Comments

@hdamker
Copy link
Collaborator

hdamker commented Jan 17, 2025

As discussed yesterday within the TSC I see a challenge with the introduction of the pattern in #373.

API Clients which have added the the x-correlator header (as it is listed in the API definitions) but intentionally or unintentionally left it empty or set it to an empty string ("") might break due to this change:

  • before the introduction of the pattern these requests were valid and could be treated as if the header was not present (see e.g. comment in the discussion: x-correlator with no value (empty / null) #366 (reply in thread))
  • with the introduction of the pattern these requests will (most?) probably rejected, at least the ones who have set it to an empty string, as the introduced restricting pattern requests a minimum length of 1

My view is that API Provider should be liberal and accept NULL (no value) or empty strings within the x-correlator and treat them as if the header was not present. Within the x-correlator pattern we need to accept also strings with zero-lengths for that.

Originally posted by @hdamker in #366 (comment)

@hdamker hdamker added the correction correction in documentation label Jan 17, 2025
@rartych rartych linked a pull request Jan 21, 2025 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
correction correction in documentation Spring25
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants