Document the X-Opaque-Id header
#8820
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andrross
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
andrross
force-pushed
the
x-opaque-id
branch
from
ac889b5 to
1877fb0
Compare
A [bug][1] was recently identified related to this header that was partly exascerbated by a misuse of the field. We have some documentation related to the [Tasks][2] API for this field, but no general guidance on how to use it. [1]: opensearch-project/OpenSearch#16702 [2]: https://opensearch.org/docs/latest/api-reference/tasks/#attaching-headers-to-tasks Signed-off-by: Andrew Ross <[email protected]>
andrross
force-pushed
the
x-opaque-id
branch
from
1f674ec to
b8e95cb
Compare
kolchfa-aws
approved these changes
Dec 2, 2024
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Andrew Ross <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Andrew Ross <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Andrew Ross <[email protected]>
natebower
reviewed
Dec 3, 2024
There was a problem hiding this comment.
@kolchfa-aws @andrross Please see my changes and let me know if you have any questions. Thanks!
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Andrew Ross <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Andrew Ross <[email protected]>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Dec 4, 2024
* Document the `X-Opaque-Id` header A [bug][1] was recently identified related to this header that was partly exascerbated by a misuse of the field. We have some documentation related to the [Tasks][2] API for this field, but no general guidance on how to use it. [1]: opensearch-project/OpenSearch#16702 [2]: https://opensearch.org/docs/latest/api-reference/tasks/#attaching-headers-to-tasks Signed-off-by: Andrew Ross <[email protected]> * Update _api-reference/common-parameters.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Andrew Ross <[email protected]> * Update _api-reference/common-parameters.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Andrew Ross <[email protected]> * Update _api-reference/common-parameters.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Andrew Ross <[email protected]> * Update _api-reference/common-parameters.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Andrew Ross <[email protected]> * Update _api-reference/common-parameters.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Andrew Ross <[email protected]> --------- Signed-off-by: Andrew Ross <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit 1cd69cd) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A bug was recently identified related to this header that was partly exascerbated by a misuse of the field. We have some documentation related to the Tasks API for this field, but no general guidance on how to use it.
Version
All
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.