documentation-website icon indicating copy to clipboard operation
documentation-website copied to clipboard

Remove _cat/snapshots to deprecate in favor of _cat/snapshots/<repository>

Open finnegancarroll opened this issue 9 months ago • 2 comments

Description

The documentation for _cat/snapshots does not list the repository query param required for the endpoint and is redundant with the more clear _cat/snapshots/<repository>.

This PR removes _cat/snapshots and additionally updates the example response which is a bit out of date.

Issues Resolved

Documentation issue noted in related issue here: https://github.com/opensearch-project/OpenSearch/issues/16648 Companion PR to deprecate the endpoint in OpenSearch: https://github.com/opensearch-project/OpenSearch/pull/16960

Version

3.0.0

Frontend features

N/A

Checklist

  • [x] By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin. For more information on following Developer Certificate of Origin and signing off your commits, please check here.

finnegancarroll avatar Mar 04 '25 19:03 finnegancarroll

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.

github-actions[bot] avatar Mar 04 '25 19:03 github-actions[bot]

Blocked until development PR is merged.

Naarcha-AWS avatar Mar 05 '25 23:03 Naarcha-AWS

The development PR for this one has stalled out. Therefore, this remains blocked.

Naarcha-AWS avatar Jul 08 '25 13:07 Naarcha-AWS

@finnegancarroll Checking in on this PR. Do you yet know what release you're targeting for this?

kolchfa-aws avatar Jul 15 '25 18:07 kolchfa-aws

Hi @kolchfa-aws, sorry I lost track of this PR. Will re-open when I revisit this change in core. Thanks.

finnegancarroll avatar Jul 22 '25 15:07 finnegancarroll