Remove _cat/snapshots to deprecate in favor of _cat/snapshots/<repository> #9345
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
…tory> in 3.0. Signed-off-by: Finn Carroll <[email protected]>
|
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. |
finnegancarroll
requested review from
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki,
natebower,
dlvenable and
epugh
as code owners
Naarcha-AWS
added
4 - Doc review
|
Blocked until development PR is merged. |
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.
Description
The documentation for
_cat/snapshotsdoes not list therepositoryquery param required for the endpoint and is redundant with the more clear_cat/snapshots/<repository>.This PR removes
_cat/snapshotsand additionally updates the example response which is a bit out of date.Issues Resolved
Documentation issue noted in related issue here: opensearch-project/OpenSearch#16648
Companion PR to deprecate the endpoint in OpenSearch: opensearch-project/OpenSearch#16960
Version
3.0.0
Frontend features
N/A
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.