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

Document the X-Opaque-Id header #8820

Merged
merged 7 commits into from
Dec 4, 2024
Merged

Document the X-Opaque-Id header #8820

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b8e95cb
Document the `X-Opaque-Id` header
andrross Nov 26, 2024
ed5806c
Update _api-reference/common-parameters.md
andrross Dec 3, 2024
aa75a8b
Update _api-reference/common-parameters.md
andrross Dec 3, 2024
4a31c84
Update _api-reference/common-parameters.md
andrross Dec 3, 2024
bad63af
Update _api-reference/common-parameters.md
andrross Dec 3, 2024
4c8f651
Update _api-reference/common-parameters.md
andrross Dec 3, 2024
7cb60e7
Merge branch 'main' into x-opaque-id
andrross Dec 3, 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
15 changes: 14 additions & 1 deletion _api-reference/common-parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,4 +123,17 @@
Meters | `m` or `meters`
Centimeters | `cm` or `centimeters`
Millimeters | `mm` or `millimeters`
Nautical miles | `NM`, `nmi`, or `nauticalmiles`
Nautical miles | `NM`, `nmi`, or `nauticalmiles`

## `X-Opaque-Id` header

Check failure on line 128 in _api-reference/common-parameters.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.HeadingCapitalization] 'header' is a heading and should be in sentence case.

Raw Output:
{"message": "[OpenSearch.HeadingCapitalization] 'header' is a heading and should be in sentence case.", "location": {"path": "_api-reference/common-parameters.md", "range": {"start": {"line": 128, "column": 18}}}, "severity": "ERROR"}

You can specify an opaque identifier for any request using the `X-Opaque-Id` header. This identifier is used to track tasks and deduplicate deprecation warnings in server-side logs. This identifier is used to differentiate between callers sending requests to your OpenSearch cluster. Do not specify a unique value per request.

#### Example request

The following request adds an opaque ID to the request:

```json
curl -H "X-Opaque-Id: my-curl-client-1" -XGET localhost:9200/_tasks
```
andrross marked this conversation as resolved.
Show resolved Hide resolved
{% include copy.html %}
Loading