diff --git a/docs/reference/cat/alias.asciidoc b/docs/reference/cat/alias.asciidoc index dc385a91e03..ffb6341a565 100644 --- a/docs/reference/cat/alias.asciidoc +++ b/docs/reference/cat/alias.asciidoc @@ -11,7 +11,7 @@ filter and routing information. [[cat-alias-api-request]] ==== {api-request-title} -`GET /_cat/aliases/{name}` +`GET /_cat/aliases/` [[cat-alias-api-path-params]] ==== {api-path-parms-title} diff --git a/docs/reference/cat/allocation.asciidoc b/docs/reference/cat/allocation.asciidoc index 0e35c0cf9e4..a02e4ba24d5 100644 --- a/docs/reference/cat/allocation.asciidoc +++ b/docs/reference/cat/allocation.asciidoc @@ -12,7 +12,7 @@ and their disk space. [[cat-allocation-api-request]] ==== {api-request-title} -`GET /_cat/allocation/{node_id}` +`GET /_cat/allocation/` [[cat-allocation-api-path-params]] ==== {api-path-parms-title} diff --git a/docs/reference/cat/count.asciidoc b/docs/reference/cat/count.asciidoc index b1ed483838a..f10e758a4c8 100644 --- a/docs/reference/cat/count.asciidoc +++ b/docs/reference/cat/count.asciidoc @@ -14,7 +14,7 @@ which have not yet been removed by the merge process. [[cat-count-api-request]] ==== {api-request-title} -`GET /_cat/count/{index}` +`GET /_cat/count/` [[cat-count-api-path-params]] diff --git a/docs/reference/cat/fielddata.asciidoc b/docs/reference/cat/fielddata.asciidoc index d0cb315d77d..e261e6919eb 100644 --- a/docs/reference/cat/fielddata.asciidoc +++ b/docs/reference/cat/fielddata.asciidoc @@ -11,13 +11,13 @@ in the cluster. [[cat-fielddata-api-request]] ==== {api-request-title} -`GET /_cat/fielddata/{fields}` +`GET /_cat/fielddata/` [[cat-fielddata-api-path-params]] ==== {api-path-parms-title} -`{fields}`:: +``:: (Optional, string) Comma-separated list of fields used to limit returned information. diff --git a/docs/reference/cat/indices.asciidoc b/docs/reference/cat/indices.asciidoc index 84eef8615b5..9a228fd3254 100644 --- a/docs/reference/cat/indices.asciidoc +++ b/docs/reference/cat/indices.asciidoc @@ -10,7 +10,7 @@ Returns high-level information about indices in a cluster. [[cat-indices-api-request]] ==== {api-request-title} -`GET /_cat/indices/{index}` +`GET /_cat/indices/` [[cat-indices-api-desc]] diff --git a/docs/reference/cat/recovery.asciidoc b/docs/reference/cat/recovery.asciidoc index f888561e8c5..374cb4cd3bf 100644 --- a/docs/reference/cat/recovery.asciidoc +++ b/docs/reference/cat/recovery.asciidoc @@ -11,7 +11,7 @@ to the <> API. [[cat-recovery-api-request]] ==== {api-request-title} -`GET /_cat/recovery/{index}` +`GET /_cat/recovery/` [[cat-recovery-api-desc]] diff --git a/docs/reference/cat/segments.asciidoc b/docs/reference/cat/segments.asciidoc index 8fec2749b63..e67f48440ab 100644 --- a/docs/reference/cat/segments.asciidoc +++ b/docs/reference/cat/segments.asciidoc @@ -11,7 +11,7 @@ API. [[cat-segments-api-request]] ==== {api-request-title} -`GET /_cat/segments/{index}` +`GET /_cat/segments/` [[cat-segments-path-params]] diff --git a/docs/reference/cat/shards.asciidoc b/docs/reference/cat/shards.asciidoc index cfd30b67802..f4418b80779 100644 --- a/docs/reference/cat/shards.asciidoc +++ b/docs/reference/cat/shards.asciidoc @@ -12,7 +12,7 @@ docs, the bytes it takes on disk, and the node where it's located. [[cat-shards-api-request]] ==== {api-request-title} -`GET /_cat/shards/{index}` +`GET /_cat/shards/` [[cat-shards-path-params]] diff --git a/docs/reference/cat/snapshots.asciidoc b/docs/reference/cat/snapshots.asciidoc index fd9bd6a2275..70a0a4d082b 100644 --- a/docs/reference/cat/snapshots.asciidoc +++ b/docs/reference/cat/snapshots.asciidoc @@ -11,13 +11,13 @@ more repositories. A snapshot is a backup of an index or running {es} cluster. [[cat-snapshots-api-request]] ==== {api-request-title} -`GET /_cat/snapshots/{repository}` +`GET /_cat/snapshots/` [[cat-snapshots-path-params]] ==== {api-path-parms-title} -`{repository}`:: +``:: + -- (Optional, string) Comma-separated list of snapshot repositories used to limit diff --git a/docs/reference/cat/templates.asciidoc b/docs/reference/cat/templates.asciidoc index 7fa71d46c1b..96c28aae438 100644 --- a/docs/reference/cat/templates.asciidoc +++ b/docs/reference/cat/templates.asciidoc @@ -12,13 +12,13 @@ and <> to new indices at creation. [[cat-templates-api-request]] ==== {api-request-title} -`GET /_cat/templates/{template_name}` +`GET /_cat/templates/` [[cat-templates-path-params]] ==== {api-path-parms-title} -`{template_name}`:: +``:: (Optional, string) Comma-separated list of index template names used to limit the request. Accepts wildcard expressions. diff --git a/docs/reference/cat/thread_pool.asciidoc b/docs/reference/cat/thread_pool.asciidoc index a62993df532..cd7dae666be 100644 --- a/docs/reference/cat/thread_pool.asciidoc +++ b/docs/reference/cat/thread_pool.asciidoc @@ -12,12 +12,12 @@ pools. [[cat-thread-pool-api-request]] ==== {api-request-title} -`GET /_cat/thread_pool/{thread_pool}` +`GET /_cat/thread_pool/` [[cat-thread-pool-path-params]] ==== {api-path-parms-title} -`{thread_pool}`:: +``:: (Optional, string) Comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions. diff --git a/docs/reference/cluster/health.asciidoc b/docs/reference/cluster/health.asciidoc index ebb4fb1fe22..d43bc51ee5e 100644 --- a/docs/reference/cluster/health.asciidoc +++ b/docs/reference/cluster/health.asciidoc @@ -6,7 +6,7 @@ Returns the health status of a cluster. [[cluster-health-api-request]] ==== {api-request-title} -`GET _cluster/health/{index}` +`GET _cluster/health/` [[cluster-health-api-desc]] ==== {api-description-title} diff --git a/docs/reference/cluster/nodes-hot-threads.asciidoc b/docs/reference/cluster/nodes-hot-threads.asciidoc index 635e943926a..4b1d4948df9 100644 --- a/docs/reference/cluster/nodes-hot-threads.asciidoc +++ b/docs/reference/cluster/nodes-hot-threads.asciidoc @@ -9,7 +9,7 @@ Returns the hot threads on each selected node in the cluster. `GET /_nodes/hot_threads` + -`GET /_nodes/{node_id}/hot_threads` +`GET /_nodes//hot_threads` [[cluster-nodes-hot-threads-api-desc]] diff --git a/docs/reference/cluster/nodes-info.asciidoc b/docs/reference/cluster/nodes-info.asciidoc index 823a81e1156..2c7a74719e0 100644 --- a/docs/reference/cluster/nodes-info.asciidoc +++ b/docs/reference/cluster/nodes-info.asciidoc @@ -9,11 +9,11 @@ Returns cluster nodes information. `GET /_nodes` + -`GET /_nodes/{node_id}` + +`GET /_nodes/` + -`GET /_nodes/{metric}` + +`GET /_nodes/` + -`GET /_nodes/{node_id}/{metric}` +`GET /_nodes//` [[cluster-nodes-info-api-desc]] @@ -29,7 +29,7 @@ By default, it returns all attributes and core settings for a node. [[cluster-nodes-info-api-path-params]] ==== {api-path-parms-title} -`{metric}`:: +``:: (Optional, string) Limits the information returned to the specific metrics. A comma-separated list of the following options: + diff --git a/docs/reference/cluster/nodes-stats.asciidoc b/docs/reference/cluster/nodes-stats.asciidoc index 3ce78cabcd3..b5f3c3bb2d4 100644 --- a/docs/reference/cluster/nodes-stats.asciidoc +++ b/docs/reference/cluster/nodes-stats.asciidoc @@ -9,15 +9,15 @@ Returns cluster nodes statistics. `GET /_nodes/stats` + -`GET /_nodes/{node_id}/stats` + +`GET /_nodes//stats` + -`GET/_nodes/stats/{metric}` + +`GET/_nodes/stats/` + -`GET/_nodes/{node_id}/stats/{metric}` + +`GET/_nodes//stats/` + -`GET /_nodes/stats/{metric}/{index_metric}` + +`GET /_nodes/stats//` + -`GET /_nodes/{node_id}/stats/{metric}/{index_metric}` +`GET /_nodes//stats//` [[cluster-nodes-stats-api-desc]] @@ -35,7 +35,7 @@ using metrics. ==== {api-path-parms-title} -`{metric}`:: +``:: (Optional, string) Limits the information returned to the specific metrics. A comma-separated list of the following options: + @@ -83,7 +83,7 @@ using metrics. communication. -- -`{index_metric}`:: +``:: (Optional, string) Limit the information returned for `indices` metric to the specific index metrics. It can be used only if `indices` (or `all`) metric is specified. Supported metrics are: diff --git a/docs/reference/cluster/nodes-usage.asciidoc b/docs/reference/cluster/nodes-usage.asciidoc index dad18afc05f..2a0b9f7b613 100644 --- a/docs/reference/cluster/nodes-usage.asciidoc +++ b/docs/reference/cluster/nodes-usage.asciidoc @@ -9,11 +9,11 @@ Returns information on the usage of features. `GET /_nodes/usage` + -`GET /_nodes/{node_id}/usage` + +`GET /_nodes//usage` + -`GET /_nodes/usage/{metric}` + +`GET /_nodes/usage/` + -`GET /_nodes/{node_id}/usage/{metric}` +`GET /_nodes//usage/` [[cluster-nodes-usage-api-desc]] @@ -27,7 +27,7 @@ of features for each node. All the nodes selective options are explained [[cluster-nodes-usage-api-path-params]] ==== {api-path-parms-title} -`{metric}`:: +``:: (Optional, string) Limits the information returned to the specific metrics. A comma-separated list of the following options: + diff --git a/docs/reference/cluster/state.asciidoc b/docs/reference/cluster/state.asciidoc index 0f8e208981f..8c09d31de2c 100644 --- a/docs/reference/cluster/state.asciidoc +++ b/docs/reference/cluster/state.asciidoc @@ -6,7 +6,7 @@ Returns metadata about the state of the cluster. [[cluster-state-api-request]] ==== {api-request-title} -`GET /_cluster/state/{metrics}/{index}` +`GET /_cluster/state//` [[cluster-state-api-desc]] ==== {api-description-title} @@ -50,7 +50,7 @@ including their mappings, as well as templates and other metadata. This means it can sometimes be quite large. To avoid the need to process all this information you can request only the part of the cluster state that you need: -`{metrics}`:: +``:: (Optional, string) A comma-separated list of the following options: + -- diff --git a/docs/reference/cluster/stats.asciidoc b/docs/reference/cluster/stats.asciidoc index 42fa6af398e..d35d832eaf0 100644 --- a/docs/reference/cluster/stats.asciidoc +++ b/docs/reference/cluster/stats.asciidoc @@ -9,7 +9,7 @@ Returns cluster statistics. `GET /_cluster/stats` + -`GET /_cluster/stats/nodes/{node_id}` +`GET /_cluster/stats/nodes/` [[cluster-stats-api-desc]] diff --git a/docs/reference/cluster/tasks.asciidoc b/docs/reference/cluster/tasks.asciidoc index c19d769672d..7db58055f20 100644 --- a/docs/reference/cluster/tasks.asciidoc +++ b/docs/reference/cluster/tasks.asciidoc @@ -10,7 +10,7 @@ Returns information about the tasks currently executing in the cluster. `GET /_tasks` + -`GET /_tasks/{task_id}` +`GET /_tasks/` [[tasks-api-desc]] @@ -23,7 +23,7 @@ executing on one or more nodes in the cluster. [[tasks-api-path-params]] ==== {api-path-parms-title} -{task_id} +``:: (Optional, string) The ID of the task to return (`node_id:task_number`). diff --git a/docs/reference/cluster/voting-exclusions.asciidoc b/docs/reference/cluster/voting-exclusions.asciidoc index ab48a89a5fb..ee4389aec29 100644 --- a/docs/reference/cluster/voting-exclusions.asciidoc +++ b/docs/reference/cluster/voting-exclusions.asciidoc @@ -11,7 +11,7 @@ Adds or removes master-eligible nodes from the [[voting-config-exclusions-api-request]] ==== {api-request-title} -`POST _cluster/voting_config_exclusions/{node_name}` + +`POST _cluster/voting_config_exclusions/` + `DELETE _cluster/voting_config_exclusions` @@ -46,7 +46,7 @@ For more information, see <>. [[voting-config-exclusions-api-path-params]] ==== {api-path-parms-title} -`{node_name}`:: +``:: A <> that identifies {es} nodes. diff --git a/docs/reference/indices/get-mapping.asciidoc b/docs/reference/indices/get-mapping.asciidoc index ea96327bb3a..45c608cd28d 100644 --- a/docs/reference/indices/get-mapping.asciidoc +++ b/docs/reference/indices/get-mapping.asciidoc @@ -23,7 +23,7 @@ through the parameter `include_type_name`. For more details, please see </_mapping` [[get-mapping-api-path-params]] diff --git a/docs/reference/indices/put-mapping.asciidoc b/docs/reference/indices/put-mapping.asciidoc index a47f417d6a2..46b33f04264 100644 --- a/docs/reference/indices/put-mapping.asciidoc +++ b/docs/reference/indices/put-mapping.asciidoc @@ -30,7 +30,7 @@ please see <>. [[put-mapping-api-request]] ==== {api-request-title} -`PUT /{index}/_mapping` +`PUT //_mapping` `PUT /_mapping` diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index 2886fa2ea74..dbd975f8d6c 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -77,7 +77,7 @@ that are **not** loaded into memory. Defaults to `false`. end::include-unloaded-segments[] tag::index[] -`{index}`:: +``:: (Optional, string) Comma-separated list or wildcard expression of index names used to limit the request. end::index[] @@ -90,12 +90,12 @@ the master node. end::local[] tag::name[] -`{name}`:: +``:: (Optional, string) Comma-separated list of alias names to return. end::name[] tag::node-id[] -`{node_id}`:: +``:: (Optional, string) Comma-separated list of node IDs or names used to limit returned information. end::node-id[] diff --git a/docs/reference/search/search.asciidoc b/docs/reference/search/search.asciidoc index 66286cb47a0..9e396485e2f 100644 --- a/docs/reference/search/search.asciidoc +++ b/docs/reference/search/search.asciidoc @@ -14,7 +14,7 @@ GET /twitter/_search?q=user:kimchy [[search-search-api-request]] ==== {api-request-title} -`GET /{index}/_search` + +`GET //_search` + `GET /all/_search`