Skip to content

Commit 1a4b0ac

Browse files
cwperksshiv0408
cwperks
authored and
shiv0408
committed
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>
1 parent 16f79b7 commit 1a4b0ac

File tree

132 files changed

+132
-131
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

132 files changed

+132
-131
lines changed

‎CHANGELOG.md

+1

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cat.aliases":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/",
55
"description":"Shows information about currently configured aliases to indices including filter and routing infos."
66
},
77
"stability":"stable",

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

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

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cat.cluster_manager":{
33
"documentation":{
4-
"url":"https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-master/",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/",
55
"description":"Returns information about the cluster-manager node."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cat.count":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cat/cat-count/",
55
"description":"Provides quick access to the document count of the entire cluster, or individual indices."
66
},
77
"stability":"stable",

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

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

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cat.help":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cat/index/",
55
"description":"Returns help for the Cat APIs."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cat.indices":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cat/cat-indices/",
55
"description":"Returns information about indices: number of primaries and replicas, document counts, disk size, ..."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cat.nodeattrs":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/",
55
"description":"Returns information about custom node attributes."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cat.nodes":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/",
55
"description":"Returns basic statistics about performance of cluster nodes."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cat.pending_tasks":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/",
55
"description":"Returns a concise representation of the cluster pending tasks."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cat.plugins":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/",
55
"description":"Returns information about installed plugins across nodes node."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cat.recovery":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cat/cat-recovery/",
55
"description":"Returns information about index shard recoveries, both on-going completed."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cat.repositories":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/",
55
"description":"Returns information about snapshot repositories registered in the cluster."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cat.segment_replication":{
33
"documentation":{
4-
"url":"https://github.com/opensearch-project/documentation-website/issues/2627",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/",
55
"description":"Returns information about both on-going and latest completed Segment Replication events"
66
},
77
"stability":"experimental",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cat.segments":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cat/cat-segments/",
55
"description":"Provides low-level information about the segments in the shards of an index."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cat.shards":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cat/cat-shards/",
55
"description":"Provides a detailed view of shard allocation on nodes."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cat.snapshots":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/",
55
"description":"Returns all snapshots in a specific repository."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cat.tasks":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/",
55
"description":"Returns information about the tasks currently executing on one or more nodes in the cluster."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cat.templates":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cat/cat-templates/",
55
"description":"Returns information about existing templates."
66
},
77
"stability":"stable",

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

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

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"clear_scroll":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/scroll/",
55
"description":"Explicitly clears the search context for a scroll."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cluster.allocation_explain":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/",
55
"description":"Provides explanations for shard allocations in the cluster."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cluster.delete_component_template":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html",
4+
"url":"https://opensearch.org/docs/latest/im-plugin/index-templates/#create-a-component-template",
55
"description":"Deletes a component template"
66
},
77
"stability":"experimental",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cluster.delete_decommission_awareness": {
33
"documentation": {
4-
"url": "https://opensearch.org/docs/latest/opensearch/rest-api/decommission/",
4+
"url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/",
55
"description": "Delete any existing decommission."
66
},
77
"stability": "experimental",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cluster.delete_weighted_routing": {
33
"documentation": {
4-
"url": "https://opensearch.org/docs/latest/opensearch/rest-api/weighted-routing/delete",
4+
"url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness",
55
"description": "Delete weighted shard routing weights"
66
},
77
"stability": "stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cluster.get_decommission_awareness": {
33
"documentation": {
4-
"url": "https://opensearch.org/docs/latest/opensearch/rest-api/decommission/",
4+
"url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/",
55
"description": "Get details and status of decommissioned attribute"
66
},
77
"stability": "experimental",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cluster.get_settings":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/",
55
"description":"Returns cluster settings."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cluster.get_weighted_routing": {
33
"documentation": {
4-
"url": "https://opensearch.org/docs/latest/opensearch/rest-api/weighted-routing/get",
4+
"url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/",
55
"description": "Fetches weighted shard routing weights"
66
},
77
"stability": "stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cluster.health":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/",
55
"description":"Returns basic information about the health of the cluster."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cluster.put_component_template":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html",
4+
"url":"https://opensearch.org/docs/latest/im-plugin/index-templates/#create-a-component-template",
55
"description":"Creates or updates a component template"
66
},
77
"stability":"experimental",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cluster.put_decommission_awareness": {
33
"documentation": {
4-
"url": "https://opensearch.org/docs/latest/opensearch/rest-api/decommission/",
4+
"url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/",
55
"description": "Decommissions an awareness attribute"
66
},
77
"stability": "experimental",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cluster.put_settings":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/",
55
"description":"Updates the cluster settings."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cluster.put_weighted_routing": {
33
"documentation": {
4-
"url": "https://opensearch.org/docs/latest/opensearch/rest-api/weighted-routing/put",
4+
"url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness",
55
"description": "Updates weighted shard routing weights"
66
},
77
"stability": "stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cluster.remote_info":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/remote-info/",
55
"description":"Returns the information about configured remote clusters."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cluster.state":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/count/",
55
"description":"Returns a comprehensive information about the state of the cluster."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cluster.stats":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/",
55
"description":"Returns high-level overview of cluster statistics."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"count":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/count/",
55
"description":"Returns number of documents matching a query."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"create":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/document-apis/index-document/",
55
"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."
66
},
77
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
{
33
"create_pit":{
44
"documentation":{
5-
"url":"https://opensearch.org/docs/latest/opensearch/rest-api/point_in_time/",
5+
"url":"https://opensearch.org/docs/latest/search-plugins/searching-data/point-in-time-api",
66
"description":"Creates point in time context."
77
},
88
"stability":"stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"dangling_indices.delete_dangling_index": {
33
"documentation": {
4-
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html",
4+
"url": "https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/",
55
"description": "Deletes the specified dangling index"
66
},
77
"stability": "stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"dangling_indices.import_dangling_index": {
33
"documentation": {
4-
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html",
4+
"url": "https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/",
55
"description": "Imports the specified dangling index"
66
},
77
"stability": "stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"dangling_indices.list_dangling_indices": {
33
"documentation": {
4-
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html",
4+
"url": "https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/",
55
"description": "Returns all dangling indices."
66
},
77
"stability": "stable",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"delete":{
33
"documentation":{
4-
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html",
4+
"url":"https://opensearch.org/docs/latest/api-reference/document-apis/delete-document/",
55
"description":"Removes a document from the index."
66
},
77
"stability":"stable",

0 commit comments

Comments
 (0)