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.

Sign up for GitHub

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

Jump to bottom

Set X-Correlator as Required in OAS Definition, X-Version removed #115

Merged
merged 1 commit into from
Feb 5, 2024
Merged

Set X-Correlator as Required in OAS Definition, X-Version removed #115

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions documentation/API-design-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -814,8 +814,7 @@ With the aim of standardizing the request observability and traceability process

| Name | Description | Type | Pattern | Longitude | Location | Required by API Consumer | Required in OAS Definition | Example |
|---|---|---|---|---|---|---|---|---|
| `X-Version` | Service version description to help observability process | String| N/A | | Request | No | No | |
| `X-Correlator`| Service correlator to make E2E observability | String | UUID (8-4-4-4-12) | Max 36 | Request/Response | No | No | b4333c46-49c0-4f62-80d7-f0ef930f1c46 |
| `X-Correlator`| Service correlator to make E2E observability | String | UUID (8-4-4-4-12) | Max 36 | Request/Response | No | Yes | b4333c46-49c0-4f62-80d7-f0ef930f1c46 |

When the API Consumer includes the "X-Correlator" header in the request, the API provider must include it in the response with the same UUID as was used in the request. Otherwise, it is optional to include the "X-Correlator" header in the response with any valid (preferably randomly chosen) UUID.

Expand Down