Update links to documentation in rest-api-spec (opensearch-project#13043

)

* Update links to documentation in rest-api-spec

Signed-off-by: Craig Perkins <craig5008@gmail.com>

* Remove changes in Debug_OpenSearch.xml

Signed-off-by: Craig Perkins <craig5008@gmail.com>

* Remove changes in Debug_OpenSearch.xml

Signed-off-by: Craig Perkins <craig5008@gmail.com>

* Add to CHANGELOG

Signed-off-by: Craig Perkins <craig5008@gmail.com>

---------

Signed-off-by: Craig Perkins <craig5008@gmail.com>
Signed-off-by: Shivansh Arora <hishiv@amazon.com>

CHANGELOG.md

@@ -124,6 +124,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ### Changed
 - [BWC and API enforcement] Enforcing the presence of API annotations at build time ([#12872](https://github.com/opensearch-project/OpenSearch/pull/12872))
 - Improve built-in secure transports support ([#12907](https://github.com/opensearch-project/OpenSearch/pull/12907))
+- Update links to documentation in rest-api-spec ([#13043](https://github.com/opensearch-project/OpenSearch/pull/13043))
 
 ### Deprecated
 

rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json

@@ -1,7 +1,7 @@
 {
   "cat.aliases":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/",
       "description":"Shows information about currently configured aliases to indices including filter and routing infos."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.allocation.json

@@ -1,7 +1,7 @@
 {
   "cat.allocation":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/",
       "description":"Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.cluster_manager.json

@@ -1,7 +1,7 @@
 {
   "cat.cluster_manager":{
     "documentation":{
-      "url":"https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-master/",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/",
       "description":"Returns information about the cluster-manager node."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.count.json

@@ -1,7 +1,7 @@
 {
   "cat.count":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-count/",
       "description":"Provides quick access to the document count of the entire cluster, or individual indices."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.fielddata.json

@@ -1,7 +1,7 @@
 {
   "cat.fielddata":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/",
       "description":"Shows how much heap memory is currently being used by fielddata on every data node in the cluster."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.help.json

@@ -1,7 +1,7 @@
 {
   "cat.help":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/index/",
       "description":"Returns help for the Cat APIs."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.indices.json

@@ -1,7 +1,7 @@
 {
   "cat.indices":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-indices/",
       "description":"Returns information about indices: number of primaries and replicas, document counts, disk size, ..."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodeattrs.json

@@ -1,7 +1,7 @@
 {
   "cat.nodeattrs":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/",
       "description":"Returns information about custom node attributes."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodes.json

@@ -1,7 +1,7 @@
 {
   "cat.nodes":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/",
       "description":"Returns basic statistics about performance of cluster nodes."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json

@@ -1,7 +1,7 @@
 {
   "cat.pending_tasks":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/",
       "description":"Returns a concise representation of the cluster pending tasks."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.plugins.json

@@ -1,7 +1,7 @@
 {
   "cat.plugins":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/",
       "description":"Returns information about installed plugins across nodes node."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json

@@ -1,7 +1,7 @@
 {
   "cat.recovery":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-recovery/",
       "description":"Returns information about index shard recoveries, both on-going completed."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.repositories.json

@@ -1,7 +1,7 @@
 {
   "cat.repositories":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/",
       "description":"Returns information about snapshot repositories registered in the cluster."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.segment_replication.json

@@ -1,7 +1,7 @@
 {
   "cat.segment_replication":{
     "documentation":{
-      "url":"https://github.com/opensearch-project/documentation-website/issues/2627",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/",
       "description":"Returns information about both on-going and latest completed Segment Replication events"
     },
     "stability":"experimental",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.segments.json

@@ -1,7 +1,7 @@
 {
   "cat.segments":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-segments/",
       "description":"Provides low-level information about the segments in the shards of an index."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.shards.json

@@ -1,7 +1,7 @@
 {
   "cat.shards":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-shards/",
       "description":"Provides a detailed view of shard allocation on nodes."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.snapshots.json

@@ -1,7 +1,7 @@
 {
   "cat.snapshots":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/",
       "description":"Returns all snapshots in a specific repository."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.tasks.json

@@ -1,7 +1,7 @@
 {
   "cat.tasks":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/",
       "description":"Returns information about the tasks currently executing on one or more nodes in the cluster."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.templates.json

@@ -1,7 +1,7 @@
 {
   "cat.templates":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-templates/",
       "description":"Returns information about existing templates."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cat.thread_pool.json

@@ -1,7 +1,7 @@
 {
   "cat.thread_pool":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/",
       "description":"Returns cluster-wide thread pool statistics per node.\nBy default the active, queue and rejected statistics are returned for all thread pools."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/clear_scroll.json

@@ -1,7 +1,7 @@
 {
   "clear_scroll":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/scroll/",
       "description":"Explicitly clears the search context for a scroll."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cluster.allocation_explain.json

@@ -1,7 +1,7 @@
 {
   "cluster.allocation_explain":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/",
       "description":"Provides explanations for shard allocations in the cluster."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cluster.delete_component_template.json

@@ -1,7 +1,7 @@
 {
   "cluster.delete_component_template":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html",
+      "url":"https://opensearch.org/docs/latest/im-plugin/index-templates/#create-a-component-template",
       "description":"Deletes a component template"
     },
     "stability":"experimental",

rest-api-spec/src/main/resources/rest-api-spec/api/cluster.delete_decommission_awareness.json

@@ -1,7 +1,7 @@
 {
   "cluster.delete_decommission_awareness": {
     "documentation": {
-      "url": "https://opensearch.org/docs/latest/opensearch/rest-api/decommission/",
+      "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/",
       "description": "Delete any existing decommission."
     },
     "stability": "experimental",

rest-api-spec/src/main/resources/rest-api-spec/api/cluster.delete_weighted_routing.json

@@ -1,7 +1,7 @@
 {
   "cluster.delete_weighted_routing": {
     "documentation": {
-      "url": "https://opensearch.org/docs/latest/opensearch/rest-api/weighted-routing/delete",
+      "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness",
       "description": "Delete weighted shard routing weights"
     },
     "stability": "stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cluster.get_decommission_awareness.json

@@ -1,7 +1,7 @@
 {
   "cluster.get_decommission_awareness": {
     "documentation": {
-      "url": "https://opensearch.org/docs/latest/opensearch/rest-api/decommission/",
+      "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/",
       "description": "Get details and status of decommissioned attribute"
     },
     "stability": "experimental",

rest-api-spec/src/main/resources/rest-api-spec/api/cluster.get_settings.json

@@ -1,7 +1,7 @@
 {
   "cluster.get_settings":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/",
       "description":"Returns cluster settings."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cluster.get_weighted_routing.json

@@ -1,7 +1,7 @@
 {
   "cluster.get_weighted_routing": {
     "documentation": {
-      "url": "https://opensearch.org/docs/latest/opensearch/rest-api/weighted-routing/get",
+      "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/",
       "description": "Fetches weighted shard routing weights"
     },
     "stability": "stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cluster.health.json

@@ -1,7 +1,7 @@
 {
   "cluster.health":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/",
       "description":"Returns basic information about the health of the cluster."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cluster.put_component_template.json

@@ -1,7 +1,7 @@
 {
   "cluster.put_component_template":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html",
+      "url":"https://opensearch.org/docs/latest/im-plugin/index-templates/#create-a-component-template",
       "description":"Creates or updates a component template"
     },
     "stability":"experimental",

rest-api-spec/src/main/resources/rest-api-spec/api/cluster.put_decommission_awareness.json

@@ -1,7 +1,7 @@
 {
   "cluster.put_decommission_awareness": {
     "documentation": {
-      "url": "https://opensearch.org/docs/latest/opensearch/rest-api/decommission/",
+      "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/",
       "description": "Decommissions an awareness attribute"
     },
     "stability": "experimental",

rest-api-spec/src/main/resources/rest-api-spec/api/cluster.put_settings.json

@@ -1,7 +1,7 @@
 {
   "cluster.put_settings":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/",
       "description":"Updates the cluster settings."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cluster.put_weighted_routing.json

@@ -1,7 +1,7 @@
 {
   "cluster.put_weighted_routing": {
     "documentation": {
-      "url": "https://opensearch.org/docs/latest/opensearch/rest-api/weighted-routing/put",
+      "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness",
       "description": "Updates weighted shard routing weights"
     },
     "stability": "stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cluster.remote_info.json

@@ -1,7 +1,7 @@
 {
   "cluster.remote_info":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/remote-info/",
       "description":"Returns the information about configured remote clusters."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cluster.state.json

@@ -1,7 +1,7 @@
 {
   "cluster.state":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/count/",
       "description":"Returns a comprehensive information about the state of the cluster."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/cluster.stats.json

@@ -1,7 +1,7 @@
 {
   "cluster.stats":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/",
       "description":"Returns high-level overview of cluster statistics."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/count.json

@@ -1,7 +1,7 @@
 {
   "count":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/count/",
       "description":"Returns number of documents matching a query."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/create.json

@@ -1,7 +1,7 @@
 {
   "create":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/document-apis/index-document/",
       "description":"Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/create_pit.json

@@ -2,7 +2,7 @@
 {
   "create_pit":{
     "documentation":{
-      "url":"https://opensearch.org/docs/latest/opensearch/rest-api/point_in_time/",
+      "url":"https://opensearch.org/docs/latest/search-plugins/searching-data/point-in-time-api",
       "description":"Creates point in time context."
     },
     "stability":"stable",

rest-api-spec/src/main/resources/rest-api-spec/api/dangling_indices.delete_dangling_index.json

@@ -1,7 +1,7 @@
 {
   "dangling_indices.delete_dangling_index": {
     "documentation": {
-      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html",
+      "url": "https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/",
       "description": "Deletes the specified dangling index"
     },
     "stability": "stable",

rest-api-spec/src/main/resources/rest-api-spec/api/dangling_indices.import_dangling_index.json

@@ -1,7 +1,7 @@
 {
   "dangling_indices.import_dangling_index": {
     "documentation": {
-      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html",
+      "url": "https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/",
       "description": "Imports the specified dangling index"
     },
     "stability": "stable",

rest-api-spec/src/main/resources/rest-api-spec/api/dangling_indices.list_dangling_indices.json

@@ -1,7 +1,7 @@
 {
   "dangling_indices.list_dangling_indices": {
     "documentation": {
-      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html",
+      "url": "https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/",
       "description": "Returns all dangling indices."
     },
     "stability": "stable",

rest-api-spec/src/main/resources/rest-api-spec/api/delete.json

@@ -1,7 +1,7 @@
 {
   "delete":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html",
+      "url":"https://opensearch.org/docs/latest/api-reference/document-apis/delete-document/",
       "description":"Removes a document from the index."
     },
     "stability":"stable",