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

Update API-design-guidelines for subscription #198

Merged
merged 32 commits into from
Jun 4, 2024
Merged
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
e6d4d94
Update API-design-guidelines for subscription
bigludo7 May 10, 2024
4bd0513
Merge branch 'main' into patch-1
rartych May 17, 2024
6331c7e
Update documentation/API-design-guidelines.md
bigludo7 May 26, 2024
9796896
Update documentation/API-design-guidelines.md
bigludo7 May 26, 2024
7b712de
Update documentation/API-design-guidelines.md
bigludo7 May 26, 2024
a849984
Update documentation/API-design-guidelines.md
bigludo7 May 26, 2024
7e6a98e
Update API-design-guidelines.md
bigludo7 May 26, 2024
3558093
Update API-design-guidelines.md
bigludo7 May 26, 2024
b0af7af
Update documentation/API-design-guidelines.md
bigludo7 May 27, 2024
4ee34eb
Update documentation/API-design-guidelines.md
bigludo7 May 27, 2024
80dc505
Update documentation/API-design-guidelines.md
bigludo7 May 27, 2024
8a73678
Update documentation/API-design-guidelines.md
bigludo7 May 29, 2024
b092091
Update documentation/API-design-guidelines.md
bigludo7 May 29, 2024
2c9de4e
Update documentation/API-design-guidelines.md
bigludo7 May 29, 2024
a8b0145
Update documentation/API-design-guidelines.md
bigludo7 May 29, 2024
2d996c1
Update documentation/API-design-guidelines.md
bigludo7 May 29, 2024
56043fd
Update documentation/API-design-guidelines.md
bigludo7 May 29, 2024
dd0ffd8
Update documentation/API-design-guidelines.md
bigludo7 May 29, 2024
c16e6c9
Update documentation/API-design-guidelines.md
bigludo7 May 29, 2024
8f65c65
Update documentation/API-design-guidelines.md
bigludo7 May 29, 2024
acb21f1
Update documentation/API-design-guidelines.md
bigludo7 May 29, 2024
d5da262
Update API-design-guidelines.md
bigludo7 May 29, 2024
f015852
Update API-design-guidelines.md
bigludo7 May 31, 2024
df0676b
Update documentation/API-design-guidelines.md
bigludo7 May 31, 2024
a56c0ca
Update documentation/API-design-guidelines.md
bigludo7 May 31, 2024
29b6bc1
Update documentation/API-design-guidelines.md
bigludo7 May 31, 2024
71023b3
Update documentation/API-design-guidelines.md
bigludo7 Jun 3, 2024
a05d62f
Update API-design-guidelines.md
bigludo7 Jun 3, 2024
59ced62
Update documentation/API-design-guidelines.md
bigludo7 Jun 3, 2024
cd3863f
Merge branch 'main' into patch-1
bigludo7 Jun 4, 2024
a8981d2
Update documentation/API-design-guidelines.md
bigludo7 Jun 4, 2024
f55bfd3
Update documentation/API-design-guidelines.md
bigludo7 Jun 4, 2024
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
6 changes: 5 additions & 1 deletion documentation/API-design-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -852,7 +852,11 @@ With the aim of standardizing the request observability and traceability process

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.

In notification scenarios (i.e. POST request sent towards the listener to the `sink` indicated), the use of the "x-correlator" is supported for the same aim as well. When the API request includes the "x-correlator" header, it is recommended for the listener to include it in the response with the same value as was used in the request. Otherwise, it is optional to include the "x-correlator" header in the response with any valid value.

In notification scenarios (i.e. POST request sent towards the listener to the `webhook.notificationUrl` indicated), the use of the "x-correlator" is supported for the same aim as well. When the API request includes the "x-correlator" header, it is recommended for the listener to include it in the response with the same value as was used in the request. Otherwise, it is optional to include the "x-correlator" header in the response with any valid value.
bigludo7 marked this conversation as resolved.
Show resolved Hide resolved

NOTE: HTTP headers are case insensitive. The use of the naming `x-correlator` is a guideline to align the format across CAMARA APIs.


## 10. Security

Expand Down
You are viewing a condensed version of this merge commit. You can view the full changes here.