Skip to content

Commit

Permalink
Merge pull request #168 from jlurien/patch-2
Browse files Browse the repository at this point in the history
Remove pattern UUID for x-correlator
  • Loading branch information
rartych authored Apr 15, 2024
2 parents 5354bce + 7ed1ae9 commit 7e9930b
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions documentation/API-design-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -844,11 +844,11 @@ Then the parameters can be included in the query:

With the aim of standardizing the request observability and traceability process, common headers that provide a follow-up of the E2E processes should be included. The table below captures these headers.

| Name | Description | Type | Pattern | Longitude | Location | Required by API Consumer | Required in OAS Definition | Example |
|---|---|---|---|---|---|---|---|---|
| `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 |
| Name | Description | Type | Location | Required by API Consumer | Required in OAS Definition | Example |
|---|---|---|---|---|---|---|
| `X-Correlator`| Service correlator to make E2E observability | String | 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.
When the API Consumer includes the "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. Recommendation is to use UUID for values.

## 10. Security

Expand Down

0 comments on commit 7e9930b

Please sign in to comment.