Update links to documentation in rest-api-spec

[cwperks]

Description

Removes references to elastic documentation in rest-api-spec where documentation exists. I ran into issues updating all links because there are many undocumented APIs. Some of the undocumented APIs are not useful and there are comments in the specs mentioning that they are deprecated.

Missing Documentation:

• Delete Component Template
• Cluster Delete Voting Config Exclusions
• Exists Component Template
• Cluster Pending Tasks
• Cluster Post Voting Config Exclusions
• Cluster Reroute
• Cluster State
• Field Capabilities
• Index Add Block
• Index Flush
• Index Get Mapping
• Index Get Field Mapping
• Index Recovery
• Index Refresh
• Resolve Index API
• Index Rollover
• Index Segments
• Index Shard Stores
• Simulate Index Template
• Index Validate Query
• Ingest Processor Grok
• Multi-Get (MGET)
• M Term Vector
• Ping
• Search Shards
• Cleanup Snapshot Repository
• Snapshot Clone
• Term Vectors

Documentation exists, but not for specific API:

• Clear Scroll
• Delete Alias

Documentation for PITs exists at https://opensearch.org/docs/latest/search-plugins/searching-data/point-in-time-api/, but could be organized in the broader API docs

Index Template APIs are under a route including im-plugin: https://opensearch.org/docs/latest/im-plugin/index-templates. Are these native APIs or are they provided by the ISM plugin?

Related Issues

Resolves #1339

Check List

• New functionality includes testing.
  • All tests pass
• New functionality has been documented.
  • New functionality has javadoc added
• Failing checks are inspected and point to the corresponding known issue(s) (See: Troubleshooting Failing Builds)
• Commits are signed per the DCO using --signoff
• Commit changes are listed out in CHANGELOG.md file (See: Changelog)
• Public documentation issue/PR created

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 ca2fc23: 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?

[github-actions]

Compatibility status:

Checks if related components are compatible with change c60746c

Incompatible components

Skipped components

Compatible components

Compatible components: [https://github.com/opensearch-project/custom-codecs.git, https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/flow-framework.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/reporting.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/opensearch-oci-object-storage.git, https://github.com/opensearch-project/geospatial.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/neural-search.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/security-analytics.git, https://github.com/opensearch-project/sql.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/performance-analyzer-rca.git, https://github.com/opensearch-project/alerting.git, https://github.com/opensearch-project/security.git, https://github.com/opensearch-project/performance-analyzer.git]

[github-actions]

❕ Gradle check result for 00552fa: UNSTABLE

• TEST FAILURES:

      2 org.opensearch.common.util.concurrent.QueueResizableOpenSearchThreadPoolExecutorTests.classMethod
      1 org.opensearch.common.util.concurrent.QueueResizableOpenSearchThreadPoolExecutorTests.testResizeQueueDown
      1 org.opensearch.action.admin.cluster.node.tasks.ResourceAwareTasksTests.testTaskResourceTrackingDuringTaskCancellation

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 71.34%. Comparing base (b15cb0c) to head (c60746c).
Report is 123 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #13043      +/-   ##
============================================
- Coverage     71.42%   71.34%   -0.08%     
- Complexity    59978    60391     +413     
============================================
  Files          4985     5025      +40     
  Lines        282275   284381    +2106     
  Branches      40946    41188     +242     
============================================
+ Hits         201603   202890    +1287     
- Misses        63999    64738     +739     
- Partials      16673    16753      +80     

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

[github-actions]

❕ Gradle check result for 9468cf2: UNSTABLE

• TEST FAILURES:

      1 org.opensearch.index.shard.RemoteIndexShardTests.testBeforeIndexShardClosedWhileCopyingFiles
      1 org.opensearch.gateway.RecoveryFromGatewayIT.testShardStoreFetchMultiNodeMultiIndexesUsingBatchAction

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 7f52e2e: UNSTABLE

• TEST FAILURES:

      1 org.opensearch.cluster.coordination.AwarenessAttributeDecommissionIT.testConcurrentDecommissionAction

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 c60746c: UNSTABLE

• TEST FAILURES:

      1 org.opensearch.cluster.allocation.ClusterRerouteIT.testDelayWithALargeAmountOfShards

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 00552fa: UNSTABLE

• TEST FAILURES:

      1 org.opensearch.search.SearchTimeoutIT.testSimpleTimeout {p0={"search.concurrent_segment_search.enabled":"true"}}

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

[reta]

Thanks a lot @cwperks !

[opensearch-trigger-bot]

The backport to 1.3 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-1.3 1.3
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-1.3
# Create a new branch
git switch --create backport/backport-13043-to-1.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 d1239c3e41bb6974690602a7a783144f18993667
# Push it to GitHub
git push --set-upstream origin backport/backport-13043-to-1.3
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-1.3

Then, create a pull request where the base branch is 1.3 and the compare/head branch is backport/backport-13043-to-1.3.

[opensearch-trigger-bot]

The backport to 1.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-1.x 1.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-1.x
# Create a new branch
git switch --create backport/backport-13043-to-1.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 d1239c3e41bb6974690602a7a783144f18993667
# Push it to GitHub
git push --set-upstream origin backport/backport-13043-to-1.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-1.x

Then, create a pull request where the base branch is 1.x and the compare/head branch is backport/backport-13043-to-1.x.

[reta]

@cwperks may I ask you please to backport this great change to 1.x and 1.3 ? thank you

[cwperks]

@reta Sure, no problem!

FYI @hdhalter, see the PR description of this PR. I went through the rest-api-spec tests yesterday and found gaps in documentation. I will check the documentation-website issue list to see if some of these are existing issues or file a new issue if one doesn't exist.

[cwperks]

@reta Here's the backport to 1.x: #13059

[dblock]

Does anyone know where we're still using this? I believe https://github.com/opensearch-project/opensearch-api-specification should now be at par.