diff --git a/documentation/API-design-guidelines.md b/documentation/API-design-guidelines.md index d4f14cff..e29b72af 100644 --- a/documentation/API-design-guidelines.md +++ b/documentation/API-design-guidelines.md @@ -769,11 +769,13 @@ Next, it is specified how it should be used according to the filtering based on 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 Caller | Required in OAS Definition | Example | +| 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 | +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. + ## 10. Security One of the key points in the API definition process is to specify and validate the security needs that will be maintained to guarantee data integrity and access control. There are multiple ways to secure a RESTful API, e.g. basic authentication, OAuth, etc., but one thing is for sure: RESTful APIs should be stateless, so authentication/authorization requests should not rely on cookies or sessions. Instead, each API request must come with some form of authentication credentials that must be validated on the server for each request.