diff --git a/docs/reference/cat/alias.asciidoc b/docs/reference/cat/alias.asciidoc index 60f2d8ed9cb..f795b38e686 100644 --- a/docs/reference/cat/alias.asciidoc +++ b/docs/reference/cat/alias.asciidoc @@ -11,12 +11,16 @@ filter and routing information. [[cat-alias-api-request]] ==== {api-request-title} -`GET /_cat/aliases/` +`GET /_cat/aliases/` + +`GET /_cat/aliases` [[cat-alias-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=name] +``:: +(Optional, string) +include::{docdir}/rest-api/common-parms.asciidoc[tag=index-alias] [[cat-alias-api-query-params]] diff --git a/docs/reference/cat/allocation.asciidoc b/docs/reference/cat/allocation.asciidoc index c089d3a855f..5407d13ee37 100644 --- a/docs/reference/cat/allocation.asciidoc +++ b/docs/reference/cat/allocation.asciidoc @@ -14,6 +14,8 @@ and their disk space. `GET /_cat/allocation/` +`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 e38151ce4b5..3b126545064 100644 --- a/docs/reference/cat/count.asciidoc +++ b/docs/reference/cat/count.asciidoc @@ -16,6 +16,8 @@ which have not yet been removed by the merge process. `GET /_cat/count/` +`GET /_cat/count` + [[cat-count-api-path-params]] ==== {api-path-parms-title} diff --git a/docs/reference/cat/fielddata.asciidoc b/docs/reference/cat/fielddata.asciidoc index f63462f8e04..3882848f703 100644 --- a/docs/reference/cat/fielddata.asciidoc +++ b/docs/reference/cat/fielddata.asciidoc @@ -13,6 +13,8 @@ in the cluster. `GET /_cat/fielddata/` +`GET /_cat/fielddata` + [[cat-fielddata-api-path-params]] ==== {api-path-parms-title} diff --git a/docs/reference/cat/health.asciidoc b/docs/reference/cat/health.asciidoc index 803f564d2c6..667df47963a 100644 --- a/docs/reference/cat/health.asciidoc +++ b/docs/reference/cat/health.asciidoc @@ -51,6 +51,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{docdir}/rest-api/common-parms.asciidoc[tag=time] + `ts` (timestamps):: (Optional, boolean) If `true`, returns `HH:MM:SS` and https://en.wikipedia.org/wiki/Unix_time[Unix `epoch`] timestamps. Defaults to diff --git a/docs/reference/cat/indices.asciidoc b/docs/reference/cat/indices.asciidoc index 083f8738430..b88dfb45fb2 100644 --- a/docs/reference/cat/indices.asciidoc +++ b/docs/reference/cat/indices.asciidoc @@ -12,6 +12,8 @@ Returns high-level information about indices in a cluster. `GET /_cat/indices/` +`GET /_cat/indices` + [[cat-indices-api-desc]] ==== {api-description-title} @@ -77,6 +79,8 @@ primary shards. Defaults to `false`. include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{docdir}/rest-api/common-parms.asciidoc[tag=time] + include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] diff --git a/docs/reference/cat/nodes.asciidoc b/docs/reference/cat/nodes.asciidoc index adcf94f0ca7..ecbb116bd00 100644 --- a/docs/reference/cat/nodes.asciidoc +++ b/docs/reference/cat/nodes.asciidoc @@ -14,6 +14,8 @@ Returns information about a cluster's nodes. [[cat-nodes-api-query-params]] ==== {api-query-parms-title} +include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes] + include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] `full_id`:: @@ -287,6 +289,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{docdir}/rest-api/common-parms.asciidoc[tag=time] + include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] diff --git a/docs/reference/cat/pending_tasks.asciidoc b/docs/reference/cat/pending_tasks.asciidoc index d6c0cfefdde..7eb405a6e2b 100644 --- a/docs/reference/cat/pending_tasks.asciidoc +++ b/docs/reference/cat/pending_tasks.asciidoc @@ -27,6 +27,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{docdir}/rest-api/common-parms.asciidoc[tag=time] + include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] diff --git a/docs/reference/cat/recovery.asciidoc b/docs/reference/cat/recovery.asciidoc index 7ec59a5b278..fedb77a1099 100644 --- a/docs/reference/cat/recovery.asciidoc +++ b/docs/reference/cat/recovery.asciidoc @@ -56,6 +56,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{docdir}/rest-api/common-parms.asciidoc[tag=time] + include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] diff --git a/docs/reference/cat/segments.asciidoc b/docs/reference/cat/segments.asciidoc index 4ed14082392..de360153e2d 100644 --- a/docs/reference/cat/segments.asciidoc +++ b/docs/reference/cat/segments.asciidoc @@ -13,6 +13,8 @@ API. `GET /_cat/segments/` +`GET /_cat/segments` + [[cat-segments-path-params]] ==== {api-path-parms-title} diff --git a/docs/reference/cat/shards.asciidoc b/docs/reference/cat/shards.asciidoc index ee6a5637402..61b1c869f04 100644 --- a/docs/reference/cat/shards.asciidoc +++ b/docs/reference/cat/shards.asciidoc @@ -14,6 +14,8 @@ docs, the bytes it takes on disk, and the node where it's located. `GET /_cat/shards/` +`GET /_cat/shards` + [[cat-shards-path-params]] ==== {api-path-parms-title} @@ -269,6 +271,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{docdir}/rest-api/common-parms.asciidoc[tag=time] + include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] diff --git a/docs/reference/cat/snapshots.asciidoc b/docs/reference/cat/snapshots.asciidoc index e66b1b66127..b5bf30edb3f 100644 --- a/docs/reference/cat/snapshots.asciidoc +++ b/docs/reference/cat/snapshots.asciidoc @@ -13,6 +13,8 @@ more repositories. A snapshot is a backup of an index or running {es} cluster. `GET /_cat/snapshots/` +`GET /_cat/snapshots` + [[cat-snapshots-path-params]] ==== {api-path-parms-title} @@ -103,6 +105,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{docdir}/rest-api/common-parms.asciidoc[tag=time] + include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] diff --git a/docs/reference/cat/tasks.asciidoc b/docs/reference/cat/tasks.asciidoc index 5f7630fd967..af208ef20cb 100644 --- a/docs/reference/cat/tasks.asciidoc +++ b/docs/reference/cat/tasks.asciidoc @@ -57,6 +57,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=parent-task-id] include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{docdir}/rest-api/common-parms.asciidoc[tag=time] + include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_completion] include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] diff --git a/docs/reference/cat/templates.asciidoc b/docs/reference/cat/templates.asciidoc index d9a552c9f85..c0127296703 100644 --- a/docs/reference/cat/templates.asciidoc +++ b/docs/reference/cat/templates.asciidoc @@ -14,6 +14,8 @@ and <> to new indices at creation. `GET /_cat/templates/` +`GET /_cat/templates` + [[cat-templates-path-params]] ==== {api-path-parms-title} diff --git a/docs/reference/cat/thread_pool.asciidoc b/docs/reference/cat/thread_pool.asciidoc index 7b49874536e..95978c8cf01 100644 --- a/docs/reference/cat/thread_pool.asciidoc +++ b/docs/reference/cat/thread_pool.asciidoc @@ -14,6 +14,9 @@ pools. `GET /_cat/thread_pool/` +`GET /_cat/thread_pool` + + [[cat-thread-pool-path-params]] ==== {api-path-parms-title} diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index a001e275d21..3a021b7e1ee 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -446,11 +446,6 @@ such as `1264`. A value of `-1` indicates {es} was unable to compute this number. end::memory[] -tag::name[] -``:: -(Optional, string) Comma-separated list of alias names to return. -end::name[] - tag::node-id[] ``:: (Optional, string) Comma-separated list of node IDs or names used to limit @@ -696,6 +691,12 @@ tag::terminate_after[] upon reaching which the query execution will terminate early. end::terminate_after[] +tag::time[] +`time`:: +(Optional, <>) +Unit used to display time values. +end::time[] + tag::timeoutparms[] tag::timeout[] diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json index e7989ef5f96..50e2cf8c72a 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json @@ -41,6 +41,19 @@ "type":"list", "description":"Comma-separated list of column names or column aliases to sort by" }, + "time":{ + "type":"enum", + "description":"The unit in which to display time values", + "options":[ + "d (Days)", + "h (Hours)", + "m (Minutes)", + "s (Seconds)", + "ms (Milliseconds)", + "micros (Microseconds)", + "nanos (Nanoseconds)" + ] + }, "ts":{ "type":"boolean", "description":"Set to false to disable timestamping", diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.indices.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.indices.json index f4aa15344c5..60a98412c31 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.indices.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.indices.json @@ -78,6 +78,19 @@ "type":"list", "description":"Comma-separated list of column names or column aliases to sort by" }, + "time":{ + "type":"enum", + "description":"The unit in which to display time values", + "options":[ + "d (Days)", + "h (Hours)", + "m (Minutes)", + "s (Seconds)", + "ms (Milliseconds)", + "micros (Microseconds)", + "nanos (Nanoseconds)" + ] + }, "v":{ "type":"boolean", "description":"Verbose mode. Display column headers", diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodes.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodes.json index 10e9aea80fa..7fd96f8b387 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodes.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodes.json @@ -16,6 +16,23 @@ ] }, "params":{ + "bytes":{ + "type":"enum", + "description":"The unit in which to display byte values", + "options":[ + "b", + "k", + "kb", + "m", + "mb", + "g", + "gb", + "t", + "tb", + "p", + "pb" + ] + }, "format":{ "type":"string", "description":"a short version of the Accept header, e.g. json, yaml" @@ -45,6 +62,19 @@ "type":"list", "description":"Comma-separated list of column names or column aliases to sort by" }, + "time":{ + "type":"enum", + "description":"The unit in which to display time values", + "options":[ + "d (Days)", + "h (Hours)", + "m (Minutes)", + "s (Seconds)", + "ms (Milliseconds)", + "micros (Microseconds)", + "nanos (Nanoseconds)" + ] + }, "v":{ "type":"boolean", "description":"Verbose mode. Display column headers", diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json index 31de2e00569..3ea0896ccf3 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json @@ -41,6 +41,19 @@ "type":"list", "description":"Comma-separated list of column names or column aliases to sort by" }, + "time":{ + "type":"enum", + "description":"The unit in which to display time values", + "options":[ + "d (Days)", + "h (Hours)", + "m (Minutes)", + "s (Seconds)", + "ms (Milliseconds)", + "micros (Microseconds)", + "nanos (Nanoseconds)" + ] + }, "v":{ "type":"boolean", "description":"Verbose mode. Display column headers", diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json index 7459e9e3b82..c24e8854a72 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json @@ -80,6 +80,19 @@ "type":"list", "description":"Comma-separated list of column names or column aliases to sort by" }, + "time":{ + "type":"enum", + "description":"The unit in which to display time values", + "options":[ + "d (Days)", + "h (Hours)", + "m (Minutes)", + "s (Seconds)", + "ms (Milliseconds)", + "micros (Microseconds)", + "nanos (Nanoseconds)" + ] + }, "v":{ "type":"boolean", "description":"Verbose mode. Display column headers", diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.shards.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.shards.json index 6315570e4e9..6eb170ac4a7 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.shards.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.shards.json @@ -70,6 +70,19 @@ "type":"list", "description":"Comma-separated list of column names or column aliases to sort by" }, + "time":{ + "type":"enum", + "description":"The unit in which to display time values", + "options":[ + "d (Days)", + "h (Hours)", + "m (Minutes)", + "s (Seconds)", + "ms (Milliseconds)", + "micros (Microseconds)", + "nanos (Nanoseconds)" + ] + }, "v":{ "type":"boolean", "description":"Verbose mode. Display column headers", diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.snapshots.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.snapshots.json index e720f53d430..9bca1038726 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.snapshots.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.snapshots.json @@ -54,6 +54,19 @@ "type":"list", "description":"Comma-separated list of column names or column aliases to sort by" }, + "time":{ + "type":"enum", + "description":"The unit in which to display time values", + "options":[ + "d (Days)", + "h (Hours)", + "m (Minutes)", + "s (Seconds)", + "ms (Milliseconds)", + "micros (Microseconds)", + "nanos (Nanoseconds)" + ] + }, "v":{ "type":"boolean", "description":"Verbose mode. Display column headers", diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.tasks.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.tasks.json index 20e846ce651..1c04b05c985 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.tasks.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.tasks.json @@ -49,6 +49,19 @@ "type":"list", "description":"Comma-separated list of column names or column aliases to sort by" }, + "time":{ + "type":"enum", + "description":"The unit in which to display time values", + "options":[ + "d (Days)", + "h (Hours)", + "m (Minutes)", + "s (Seconds)", + "ms (Milliseconds)", + "micros (Microseconds)", + "nanos (Nanoseconds)" + ] + }, "v":{ "type":"boolean", "description":"Verbose mode. Display column headers",