Deprecate /_cat/snapshots in favor of /_cat/snapshots/{repository}

[finnegancarroll]

Description

Per #16648 mark /_cat/snapshots as deprecated. Redundant with the more explicit /_cat/snapshots/{repository}.

Adds deprecation log for this route:

~/fdev curl -i -H "Accept: application/json" -H "X-Opaque-Id: 123" "localhost:9200/_cat/snapshots"
HTTP/1.1 400 Bad Request
X-Opaque-Id: 123
Warning: 299 OpenSearch-3.0.0-SNAPSHOT-4a53ff24adbec1d5aeb3d73548171870a3de925d "[/_cat/snapshots] is a deprecated endpoint. Please use [/_cat/snapshots/{repository}] instead."
X-OpenSearch-Version: OpenSearch/3.0.0-SNAPSHOT (opensearch)
content-type: application/json; charset=UTF-8
content-length: 243

Related Issues

Resolves #16648

Check List

• Functionality includes testing.
• API changes companion pull request created, if applicable.
• Public documentation issue/PR created, if applicable.

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

[github-actions]

❕ Gradle check result for bfa304e: UNSTABLE

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.27%. Comparing base (4a53ff2) to head (bfa304e).
Report is 3 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #16960      +/-   ##
============================================
- Coverage     72.32%   72.27%   -0.06%     
  Complexity    65310    65310              
============================================
  Files          5299     5299              
  Lines        303534   303536       +2     
  Branches      43941    43941              
============================================
- Hits         219527   219376     -151     
- Misses        66021    66173     +152     
- Partials      17986    17987       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[reta]

Could you please add test case to rest-api-spec/test/cat.snapshots/10_basic.yml and check for deprecation message, thank you.

[reta]

Also please add CHANGELOG entry (for 3.x?), thank you

[finnegancarroll]

I think this change needs to wait on the associated api spec fix to make its way into the core yml rest tests. Currently the definition in main does not allow for the additional "repository" param needed by /_cat/snapshots. I'll plan on adding what the test will look like here and then leave the pr as draft to revisit on next release.

[github-actions]

❌ Gradle check result for 541896e: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?