Add deprecation warning for /_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.43%. Comparing base (af5835f) to head (cf77a81).
⚠️ Report is 779 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #16960      +/-   ##
============================================
- Coverage     72.44%   72.43%   -0.01%     
+ Complexity    65732    65690      -42     
============================================
  Files          5311     5311              
  Lines        305011   305013       +2     
  Branches      44232    44232              
============================================
- Hits         220969   220951      -18     
+ Misses        65967    65940      -27     
- Partials      18075    18122      +47     

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[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

[github-actions]

❕ Gradle check result for 37da999: 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.

[github-actions]

❌ Gradle check result for 96f95e9: 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?

[finnegancarroll]

testMixedModeRelocation_FailInFinalize is flaky

[github-actions]

❕ Gradle check result for 96f95e9: 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.

[github-actions]

❕ Gradle check result for cf77a81: UNSTABLE

• TEST FAILURES:

      2 org.opensearch.snapshots.DedicatedClusterSnapshotRestoreIT.testSnapshotWithStuckNode

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

[finnegancarroll]

I'm noticing the way yaml rest tests handle query parameters and paths is creating some issues for this specific case. The client appears to move all variable parameters of a request (regardless of origin) into a single Set<String>, at which point it tries to match these params to the longest possible path. Since the query param and the path param are both named "repository" the yaml client will always select the /_cat/snapshots/{repository} route.

https://github.com/opensearch-project/OpenSearch/blob/main/test/framework/src/main/java/org/opensearch/test/rest/yaml/restspec/ClientYamlSuiteRestApi.java#L151

[opensearch-trigger-bot]

This PR is stalled because it has been open for 30 days with no activity.