From 84e4ab158e2c7f63d697028b44dee39b6915e3ee Mon Sep 17 00:00:00 2001 From: MUHAMMAD SAMIULLAH Date: Mon, 23 Oct 2023 19:53:52 +0500 Subject: [PATCH] [DOC] Format all API pages according to the API template (#5169) * Fix APIs File Signed-off-by: samipak458 * Update API files according to API template Signed-off-by: samipak458 * Update exec-stored-script.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update cat-aliases.md Signed-off-by: MUHAMMAD SAMIULLAH * Update cat-allocation.md Signed-off-by: MUHAMMAD SAMIULLAH * Update cat-cluster_manager.md Signed-off-by: MUHAMMAD SAMIULLAH * Update cat-count.md Signed-off-by: MUHAMMAD SAMIULLAH * Update cat-field-data.md Signed-off-by: MUHAMMAD SAMIULLAH * Update cat-health.md Signed-off-by: MUHAMMAD SAMIULLAH * updated * updated * updated --------- Signed-off-by: samipak458 Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: MUHAMMAD SAMIULLAH Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- _api-reference/analyze-apis.md | 2 ++ _api-reference/cat/cat-aliases.md | 2 +- _api-reference/cat/cat-allocation.md | 2 +- _api-reference/cat/cat-cluster_manager.md | 3 +- _api-reference/cat/cat-count.md | 2 +- _api-reference/cat/cat-field-data.md | 2 +- _api-reference/cat/cat-health.md | 2 +- _api-reference/cat/cat-indices.md | 2 +- _api-reference/cat/cat-nodeattrs.md | 2 +- _api-reference/cat/cat-nodes.md | 2 +- _api-reference/cat/cat-pending-tasks.md | 2 +- _api-reference/cat/cat-plugins.md | 2 +- _api-reference/cat/cat-recovery.md | 2 +- _api-reference/cat/cat-repositories.md | 2 +- _api-reference/cat/cat-segment-replication.md | 4 +-- _api-reference/cat/cat-segments.md | 2 +- _api-reference/cat/cat-shards.md | 2 +- _api-reference/cat/cat-snapshots.md | 2 +- _api-reference/cat/cat-tasks.md | 2 +- _api-reference/cat/cat-templates.md | 2 +- _api-reference/cat/cat-thread-pool.md | 2 +- _api-reference/cat/index.md | 3 +- .../cluster-api/cluster-allocation.md | 2 +- .../cluster-api/cluster-awareness.md | 14 ++++---- .../cluster-api/cluster-decommission.md | 10 +++--- _api-reference/cluster-api/cluster-health.md | 2 +- .../cluster-api/cluster-settings.md | 8 ++--- _api-reference/cluster-api/cluster-stats.md | 5 ++- _api-reference/cluster-api/index.md | 2 ++ _api-reference/common-parameters.md | 14 ++++---- _api-reference/count.md | 3 +- _api-reference/document-apis/bulk.md | 2 +- .../document-apis/delete-by-query.md | 2 +- .../document-apis/delete-document.md | 2 +- _api-reference/document-apis/get-documents.md | 2 +- .../document-apis/index-document.md | 2 +- _api-reference/document-apis/index.md | 2 ++ _api-reference/document-apis/multi-get.md | 2 +- _api-reference/document-apis/reindex.md | 2 +- .../document-apis/update-by-query.md | 2 +- .../document-apis/update-document.md | 2 +- _api-reference/explain.md | 2 +- _api-reference/index-apis/alias.md | 2 +- .../index-apis/clear-index-cache.md | 16 +++++---- _api-reference/index-apis/clone.md | 2 ++ _api-reference/index-apis/close-index.md | 4 +-- _api-reference/index-apis/create-index.md | 2 +- _api-reference/index-apis/dangling-index.md | 2 ++ _api-reference/index-apis/delete-index.md | 2 +- _api-reference/index-apis/exists.md | 2 +- _api-reference/index-apis/get-index.md | 2 +- _api-reference/index-apis/get-settings.md | 2 +- _api-reference/index-apis/index.md | 2 ++ _api-reference/index-apis/open-index.md | 2 +- _api-reference/index-apis/put-mapping.md | 2 +- _api-reference/index-apis/shrink-index.md | 2 ++ _api-reference/index-apis/split.md | 2 ++ _api-reference/index-apis/stats.md | 2 ++ _api-reference/index-apis/update-settings.md | 2 +- _api-reference/index.md | 2 ++ _api-reference/ingest-apis/index.md | 2 ++ _api-reference/multi-search.md | 3 +- _api-reference/nodes-apis/index.md | 2 ++ .../nodes-apis/nodes-hot-threads.md | 4 ++- _api-reference/nodes-apis/nodes-info.md | 2 ++ .../nodes-apis/nodes-reload-secure.md | 2 ++ _api-reference/nodes-apis/nodes-stats.md | 2 ++ _api-reference/nodes-apis/nodes-usage.md | 2 ++ _api-reference/popular-api.md | 2 ++ _api-reference/profile.md | 2 ++ _api-reference/rank-eval.md | 2 ++ _api-reference/remote-info.md | 2 +- .../script-apis/create-stored-script.md | 12 ++++--- _api-reference/script-apis/delete-script.md | 10 +++--- _api-reference/script-apis/exec-script.md | 16 +++++---- .../script-apis/exec-stored-script.md | 33 ++++++++++--------- .../script-apis/get-script-contexts.md | 6 ++-- .../script-apis/get-script-language.md | 6 ++-- .../script-apis/get-stored-script.md | 10 +++--- _api-reference/script-apis/index.md | 2 ++ _api-reference/scroll.md | 2 +- _api-reference/search.md | 2 +- _api-reference/snapshots/create-repository.md | 4 ++- _api-reference/snapshots/create-snapshot.md | 12 ++++--- .../snapshots/delete-snapshot-repository.md | 6 ++-- _api-reference/snapshots/delete-snapshot.md | 4 ++- .../snapshots/get-snapshot-repository.md | 10 +++--- .../snapshots/get-snapshot-status.md | 10 +++--- _api-reference/snapshots/get-snapshot.md | 10 +++--- _api-reference/snapshots/index.md | 2 ++ _api-reference/snapshots/restore-snapshot.md | 10 +++--- .../snapshots/verify-snapshot-repository.md | 10 +++--- _api-reference/tasks.md | 2 +- _api-reference/units.md | 2 ++ _ingest-pipelines/create-ingest.md | 2 ++ _ingest-pipelines/delete-ingest.md | 2 ++ _ingest-pipelines/get-ingest.md | 2 ++ _ingest-pipelines/index.md | 4 ++- _ingest-pipelines/pipeline-failures.md | 2 ++ _ingest-pipelines/processors/append.md | 3 ++ _ingest-pipelines/processors/bytes.md | 3 ++ _ingest-pipelines/processors/convert.md | 7 +++- _ingest-pipelines/processors/csv.md | 7 +++- _ingest-pipelines/processors/date.md | 7 +++- .../processors/index-processors.md | 2 ++ _ingest-pipelines/processors/ip2geo.md | 12 +++---- _ingest-pipelines/processors/lowercase.md | 7 +++- _ingest-pipelines/processors/remove.md | 7 +++- _ingest-pipelines/processors/uppercase.md | 7 +++- _ingest-pipelines/simulate-ingest.md | 6 ++-- 110 files changed, 303 insertions(+), 167 deletions(-) diff --git a/_api-reference/analyze-apis.md b/_api-reference/analyze-apis.md index a820dd281e..a8d89bda27 100644 --- a/_api-reference/analyze-apis.md +++ b/_api-reference/analyze-apis.md @@ -9,6 +9,8 @@ redirect_from: --- # Analyze API +**Introduced 1.0** +{: .label .label-purple } The Analyze API allows you to perform [text analysis]({{site.url}}{{site.baseurl}}/api-reference/analyze-apis/), which is the process of converting unstructured text into individual tokens (usually words) that are optimized for search. diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md index 2932dc3b9c..6dcf3ddcf9 100644 --- a/_api-reference/cat/cat-aliases.md +++ b/_api-reference/cat/cat-aliases.md @@ -10,7 +10,7 @@ has_children: false --- # CAT aliases -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT aliases operation lists the mapping of aliases to indexes, plus routing and filtering information. diff --git a/_api-reference/cat/cat-allocation.md b/_api-reference/cat/cat-allocation.md index 52f8ede913..9598c8f3b5 100644 --- a/_api-reference/cat/cat-allocation.md +++ b/_api-reference/cat/cat-allocation.md @@ -9,7 +9,7 @@ has_children: false --- # CAT allocation -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT allocation operation lists the allocation of disk space for indexes and the number of shards on each node. diff --git a/_api-reference/cat/cat-cluster_manager.md b/_api-reference/cat/cat-cluster_manager.md index 152584dd57..abf204ce16 100644 --- a/_api-reference/cat/cat-cluster_manager.md +++ b/_api-reference/cat/cat-cluster_manager.md @@ -9,7 +9,7 @@ has_children: false --- # CAT cluster_manager -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT cluster manager operation lists information that helps identify the elected cluster manager node. @@ -36,6 +36,7 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-refe Parameter | Type | Description :--- | :--- | :--- cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. + ## Response ```json diff --git a/_api-reference/cat/cat-count.md b/_api-reference/cat/cat-count.md index 7896037780..34baa04dd4 100644 --- a/_api-reference/cat/cat-count.md +++ b/_api-reference/cat/cat-count.md @@ -10,7 +10,7 @@ redirect_from: --- # CAT count -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT count operation lists the number of documents in your cluster. diff --git a/_api-reference/cat/cat-field-data.md b/_api-reference/cat/cat-field-data.md index f20d2eaf20..6481e5cea1 100644 --- a/_api-reference/cat/cat-field-data.md +++ b/_api-reference/cat/cat-field-data.md @@ -9,7 +9,7 @@ redirect_from: --- # CAT fielddata -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT fielddata operation lists the memory size used by each field per node. diff --git a/_api-reference/cat/cat-health.md b/_api-reference/cat/cat-health.md index 6d733435a9..6077c77e43 100644 --- a/_api-reference/cat/cat-health.md +++ b/_api-reference/cat/cat-health.md @@ -10,7 +10,7 @@ redirect_from: --- # CAT health -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT health operation lists the status of the cluster, how long the cluster has been up, the number of nodes, and other useful information that helps you analyze the health of your cluster. diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md index 06da384986..daab13938c 100644 --- a/_api-reference/cat/cat-indices.md +++ b/_api-reference/cat/cat-indices.md @@ -9,7 +9,7 @@ redirect_from: --- # CAT indices -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT indices operation lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on. diff --git a/_api-reference/cat/cat-nodeattrs.md b/_api-reference/cat/cat-nodeattrs.md index 72128c391d..95c1e50afc 100644 --- a/_api-reference/cat/cat-nodeattrs.md +++ b/_api-reference/cat/cat-nodeattrs.md @@ -9,7 +9,7 @@ redirect_from: --- # CAT nodeattrs -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT nodeattrs operation lists the attributes of custom nodes. diff --git a/_api-reference/cat/cat-nodes.md b/_api-reference/cat/cat-nodes.md index 188b2938ac..fa0261a4ed 100644 --- a/_api-reference/cat/cat-nodes.md +++ b/_api-reference/cat/cat-nodes.md @@ -10,7 +10,7 @@ redirect_from: --- # CAT nodes -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT nodes operation lists node-level information, including node roles and load metrics. diff --git a/_api-reference/cat/cat-pending-tasks.md b/_api-reference/cat/cat-pending-tasks.md index 370d624013..c8e1b744e8 100644 --- a/_api-reference/cat/cat-pending-tasks.md +++ b/_api-reference/cat/cat-pending-tasks.md @@ -10,7 +10,7 @@ redirect_from: --- # CAT pending tasks -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT pending tasks operation lists the progress of all pending tasks, including task priority and time in queue. diff --git a/_api-reference/cat/cat-plugins.md b/_api-reference/cat/cat-plugins.md index dd7eb292cd..3498462236 100644 --- a/_api-reference/cat/cat-plugins.md +++ b/_api-reference/cat/cat-plugins.md @@ -10,7 +10,7 @@ redirect_from: --- # CAT plugins -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT plugins operation lists the names, components, and versions of the installed plugins. diff --git a/_api-reference/cat/cat-recovery.md b/_api-reference/cat/cat-recovery.md index 5fe83f9268..54abac6d99 100644 --- a/_api-reference/cat/cat-recovery.md +++ b/_api-reference/cat/cat-recovery.md @@ -10,7 +10,7 @@ redirect_from: --- # CAT recovery -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT recovery operation lists all completed and ongoing index and shard recoveries. diff --git a/_api-reference/cat/cat-repositories.md b/_api-reference/cat/cat-repositories.md index adafa4c633..06d754438f 100644 --- a/_api-reference/cat/cat-repositories.md +++ b/_api-reference/cat/cat-repositories.md @@ -10,7 +10,7 @@ redirect_from: --- # CAT repositories -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT repositories operation lists all completed and ongoing index and shard recoveries. diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index 2b5b5d2e0d..e22012ea66 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -7,7 +7,7 @@ has_children: false --- # CAT segment replication -Introduced 2.7 +**Introduced 2.7** {: .label .label-purple } The CAT segment replication operation returns information about active and last completed [segment replication]({{site.url}}{{site.baseurl}}/opensearch/segment-replication/index) events on each replica shard, including related shard-level metrics. These metrics provide information about how far behind the primary shard the replicas are lagging. @@ -47,7 +47,7 @@ Parameter | Data type | Description `v` | Boolean | If `true`, the response includes column headings. Defaults to `false`. `s` | String | Specifies to sort the results. For example, `s=shardId:desc` sorts by shardId in descending order. -## Examples +## Example The following examples illustrate various segment replication responses. diff --git a/_api-reference/cat/cat-segments.md b/_api-reference/cat/cat-segments.md index 0fb56d7e26..b860486692 100644 --- a/_api-reference/cat/cat-segments.md +++ b/_api-reference/cat/cat-segments.md @@ -10,7 +10,7 @@ redirect_from: --- # CAT segments -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The cat segments operation lists Lucene segment-level information for each index. diff --git a/_api-reference/cat/cat-shards.md b/_api-reference/cat/cat-shards.md index 5caf07f7af..e74667b5ac 100644 --- a/_api-reference/cat/cat-shards.md +++ b/_api-reference/cat/cat-shards.md @@ -10,7 +10,7 @@ redirect_from: --- # CAT shards -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT shards operation lists the state of all primary and replica shards and how they are distributed. diff --git a/_api-reference/cat/cat-snapshots.md b/_api-reference/cat/cat-snapshots.md index ff45623ab2..82cb5c1b1f 100644 --- a/_api-reference/cat/cat-snapshots.md +++ b/_api-reference/cat/cat-snapshots.md @@ -10,7 +10,7 @@ redirect_from: --- # CAT snapshots -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT snapshots operation lists all snapshots for a repository. diff --git a/_api-reference/cat/cat-tasks.md b/_api-reference/cat/cat-tasks.md index 07a353390b..4d2a06cced 100644 --- a/_api-reference/cat/cat-tasks.md +++ b/_api-reference/cat/cat-tasks.md @@ -10,7 +10,7 @@ redirect_from: --- # CAT tasks -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT tasks operation lists the progress of all tasks currently running on your cluster. diff --git a/_api-reference/cat/cat-templates.md b/_api-reference/cat/cat-templates.md index 0884cda639..d2aed7b0b8 100644 --- a/_api-reference/cat/cat-templates.md +++ b/_api-reference/cat/cat-templates.md @@ -10,7 +10,7 @@ redirect_from: --- # CAT templates -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT templates operation lists the names, patterns, order numbers, and version numbers of index templates. diff --git a/_api-reference/cat/cat-thread-pool.md b/_api-reference/cat/cat-thread-pool.md index 6fc110bb9b..5d3e341b74 100644 --- a/_api-reference/cat/cat-thread-pool.md +++ b/_api-reference/cat/cat-thread-pool.md @@ -9,7 +9,7 @@ redirect_from: --- # CAT thread pool -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The CAT thread pool operation lists the active, queued, and rejected threads of different thread pools on each node. diff --git a/_api-reference/cat/index.md b/_api-reference/cat/index.md index 7f4396f450..0ddaf1e0a7 100644 --- a/_api-reference/cat/index.md +++ b/_api-reference/cat/index.md @@ -9,7 +9,8 @@ redirect_from: --- # CAT API - +**Introduced 1.0** +{: .label .label-purple } You can get essential statistics about your cluster in an easy-to-understand, tabular format using the compact and aligned text (CAT) API. The CAT API is a human-readable interface that returns plain text instead of traditional JSON. Using the CAT API, you can answer questions like which node is the elected master, what state is the cluster in, how many documents are in each index, and so on. diff --git a/_api-reference/cluster-api/cluster-allocation.md b/_api-reference/cluster-api/cluster-allocation.md index edcd3ebacf..da6e3aab05 100644 --- a/_api-reference/cluster-api/cluster-allocation.md +++ b/_api-reference/cluster-api/cluster-allocation.md @@ -9,7 +9,7 @@ redirect_from: --- # Cluster allocation explain -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The most basic cluster allocation explain request finds an unassigned shard and explains why it can't be allocated to a node. diff --git a/_api-reference/cluster-api/cluster-awareness.md b/_api-reference/cluster-api/cluster-awareness.md index cb9f6c4a86..18259b9a98 100644 --- a/_api-reference/cluster-api/cluster-awareness.md +++ b/_api-reference/cluster-api/cluster-awareness.md @@ -10,6 +10,8 @@ redirect_from: --- # Cluster routing and awareness +**Introduced 1.0** +{: .label .label-purple } To control the distribution of search or HTTP traffic, you can use the weights per awareness attribute to control the distribution of search or HTTP traffic across zones. This is commonly used for zonal deployments, heterogeneous instances, and routing traffic away from zones during zonal failure. @@ -53,7 +55,7 @@ In the following example request body, `zone_1` and `zone_2` receive 50 requests The following example request creates a round robin shard allocation for search traffic by using an undefined ratio: -### Request +#### Request ```json PUT /_cluster/routing/awareness/zone/weights @@ -69,7 +71,7 @@ PUT /_cluster/routing/awareness/zone/weights ``` {% include copy-curl.html %} -### Response +#### Response ``` { @@ -82,14 +84,14 @@ PUT /_cluster/routing/awareness/zone/weights The following example request gets weights for all zones. -### Request +#### Request ```json GET /_cluster/routing/awareness/zone/weights ``` {% include copy-curl.html %} -### Response +#### Response OpenSearch responds with the weight of each zone: @@ -110,14 +112,14 @@ OpenSearch responds with the weight of each zone: You can remove your weight ratio for each zone using the `DELETE` method. -### Request +#### Request ```json DELETE /_cluster/routing/awareness/zone/weights ``` {% include copy-curl.html %} -### Response +#### Response ```json { diff --git a/_api-reference/cluster-api/cluster-decommission.md b/_api-reference/cluster-api/cluster-decommission.md index b63720be02..867f58eda0 100644 --- a/_api-reference/cluster-api/cluster-decommission.md +++ b/_api-reference/cluster-api/cluster-decommission.md @@ -10,6 +10,8 @@ redirect_from: --- # Cluster decommission +**Introduced 1.0** +{: .label .label-purple } The cluster decommission operation adds support decommissioning based on awareness. It greatly benefits multi-zone deployments, where awareness attributes, such as `zones`, can aid in applying new upgrades to a cluster in a controlled fashion. This is especially useful during outages, in which case, you can decommission the unhealthy zone to prevent replication requests from stalling and prevent your request backlog from becoming too large. @@ -36,7 +38,7 @@ awareness_attribute_value | String | The value of the awareness attribute. For e You can use the following example requests to decommission and recommission a zone: -### Request +#### Request The following example request decommissions `zone-a`: @@ -52,7 +54,7 @@ DELETE /_cluster/decommission/awareness ``` {% include copy-curl.html %} -### Response +#### Response ```json @@ -65,14 +67,14 @@ DELETE /_cluster/decommission/awareness The following example requests returns the decommission status of all zones. -### Request +#### Request ```json GET /_cluster/decommission/awareness/zone/_status ``` {% include copy-curl.html %} -### Response +#### Response ```json { diff --git a/_api-reference/cluster-api/cluster-health.md b/_api-reference/cluster-api/cluster-health.md index b341f31070..e9e2bb0e47 100644 --- a/_api-reference/cluster-api/cluster-health.md +++ b/_api-reference/cluster-api/cluster-health.md @@ -10,7 +10,7 @@ redirect_from: --- # Cluster health -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The most basic cluster health request returns a simple status of the health of your cluster. OpenSearch expresses cluster health in three colors: green, yellow, and red. A green status means all primary shards and their replicas are allocated to nodes. A yellow status means all primary shards are allocated to nodes, but some replicas aren't. A red status means at least one primary shard is not allocated to any node. diff --git a/_api-reference/cluster-api/cluster-settings.md b/_api-reference/cluster-api/cluster-settings.md index d433d1e322..9d54eb0b93 100644 --- a/_api-reference/cluster-api/cluster-settings.md +++ b/_api-reference/cluster-api/cluster-settings.md @@ -9,19 +9,19 @@ redirect_from: --- # Cluster settings -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The cluster settings operation lets you check the current settings for your cluster, review default settings, and change settings. When you update a setting using the API, OpenSearch applies it to all nodes in the cluster. -### Path and HTTP methods +## Path and HTTP methods ``` GET _cluster/settings PUT _cluster/settings ``` -### Path parameters +## Path parameters All cluster setting parameters are optional. @@ -51,7 +51,7 @@ PUT _cluster/settings } ``` -### Request fields +## Request fields The GET operation has no request body options. All cluster setting field parameters are optional. diff --git a/_api-reference/cluster-api/cluster-stats.md b/_api-reference/cluster-api/cluster-stats.md index 1083ff1dc5..bbfaacc284 100644 --- a/_api-reference/cluster-api/cluster-stats.md +++ b/_api-reference/cluster-api/cluster-stats.md @@ -10,12 +10,12 @@ redirect_from: --- # Cluster stats -Introduced 1.0 +**Introduced 1.0** {: .label .label-purple } The cluster stats API operation returns statistics about your cluster. -## Examples +## Example ```json GET _cluster/stats/nodes/_cluster_manager @@ -29,7 +29,6 @@ GET _cluster/stats GET _cluster/stats/nodes/ ``` - ## URL parameters All cluster stats parameters are optional. diff --git a/_api-reference/cluster-api/index.md b/_api-reference/cluster-api/index.md index 9ce04695f6..5a67c783ea 100644 --- a/_api-reference/cluster-api/index.md +++ b/_api-reference/cluster-api/index.md @@ -8,5 +8,7 @@ redirect_from: --- # Cluster APIs +**Introduced 1.0** +{: .label .label-purple }| The cluster APIs allow you to manage your cluster. You can use them to check cluster health, modify settings, retrieve statistics, and more. diff --git a/_api-reference/common-parameters.md b/_api-reference/common-parameters.md index eb0fae8cf7..347d38a0de 100644 --- a/_api-reference/common-parameters.md +++ b/_api-reference/common-parameters.md @@ -7,6 +7,8 @@ redirect_from: --- # Common REST parameters +**Introduced 1.0** +{: .label .label-purple } OpenSearch supports the following parameters for all REST operations: @@ -14,7 +16,7 @@ OpenSearch supports the following parameters for all REST operations: To convert output units to human-readable values (for example, `1h` for 1 hour and `1kb` for 1,024 bytes), add `?human=true` to the request URL. -### Example request +#### Example request The following request requires response values to be in human-readable format: @@ -27,7 +29,7 @@ GET /_search?human=true To get back JSON responses in a readable format, add `?pretty=true` to the request URL. -### Example request +#### Example request The following request requires the response to be displayed in pretty JSON format: @@ -40,7 +42,7 @@ GET /_search?pretty=true To specify the type of content in the request body, use the `Content-Type` key name in the request header. Most operations support JSON, YAML, and CBOR formats. -### Example request +#### Example request The following request specifies JSON format for the request body: @@ -54,7 +56,7 @@ curl -H "Content-type: application/json" -XGET localhost:9200/_scripts/