diff --git a/docs/reference/cluster/stats.asciidoc b/docs/reference/cluster/stats.asciidoc index f084ab7576f1e..0bc30a27f50ea 100644 --- a/docs/reference/cluster/stats.asciidoc +++ b/docs/reference/cluster/stats.asciidoc @@ -34,7 +34,12 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-filter] [[cluster-stats-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout] +`timeout`:: +(Optional, <>) +Period to wait for each node to respond. If a node does not respond before its +timeout expires, the response does not include its stats. However, timed out +nodes are included in the response's `_nodes.failed` property. Defaults to no +timeout. [role="child_attributes"] [[cluster-stats-api-response-body]] diff --git a/docs/reference/docs/bulk.asciidoc b/docs/reference/docs/bulk.asciidoc index af14045df181e..e4192350f7e97 100644 --- a/docs/reference/docs/bulk.asciidoc +++ b/docs/reference/docs/bulk.asciidoc @@ -224,7 +224,20 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_includes] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout] +`timeout`:: ++ +-- +(Optional, <>) +Period each action waits for the following operations: + +* <> +* <> updates +* <> + +Defaults to `1m` (one minute). This guarantees {es} waits for at least the +timeout before failing. The actual wait time could be longer, particularly when +multiple waits occur. +-- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] diff --git a/docs/reference/docs/delete-by-query.asciidoc b/docs/reference/docs/delete-by-query.asciidoc index 103e8d63e5ee4..aa58e600d972e 100644 --- a/docs/reference/docs/delete-by-query.asciidoc +++ b/docs/reference/docs/delete-by-query.asciidoc @@ -232,7 +232,10 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=stats] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout] +`timeout`:: +(Optional, <>) +Period each deletion request <>. Defaults to `1m` (one minute). include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version] diff --git a/docs/reference/docs/delete.asciidoc b/docs/reference/docs/delete.asciidoc index eb2169fbb34cf..b866e662f5ad9 100644 --- a/docs/reference/docs/delete.asciidoc +++ b/docs/reference/docs/delete.asciidoc @@ -155,7 +155,10 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout] +`timeout`:: +(Optional, <>) +Period to <>. Defaults to +`1m` (one minute). include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=doc-version] diff --git a/docs/reference/docs/index_.asciidoc b/docs/reference/docs/index_.asciidoc index 35e0b463a82df..107adb4d76073 100644 --- a/docs/reference/docs/index_.asciidoc +++ b/docs/reference/docs/index_.asciidoc @@ -86,7 +86,20 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +`timeout`:: ++ +-- +(Optional, <>) +Period the request waits for the following operations: + +* <> +* <> updates +* <> + +Defaults to `1m` (one minute). This guarantees {es} waits for at least the +timeout before failing. The actual wait time could be longer, particularly when +multiple waits occur. +-- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=doc-version] diff --git a/docs/reference/docs/reindex.asciidoc b/docs/reference/docs/reindex.asciidoc index 0dca3a6115fd0..8d2ea91d381ac 100644 --- a/docs/reference/docs/reindex.asciidoc +++ b/docs/reference/docs/reindex.asciidoc @@ -436,7 +436,20 @@ POST _reindex include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout] +`timeout`:: ++ +-- +(Optional, <>) +Period each indexing waits for the following operations: + +* <> +* <> updates +* <> + +Defaults to `1m` (one minute). This guarantees {es} waits for at least the +timeout before failing. The actual wait time could be longer, particularly when +multiple waits occur. +-- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] diff --git a/docs/reference/docs/update-by-query.asciidoc b/docs/reference/docs/update-by-query.asciidoc index 4a410c7c42bf5..8167fa5fa14e6 100644 --- a/docs/reference/docs/update-by-query.asciidoc +++ b/docs/reference/docs/update-by-query.asciidoc @@ -232,7 +232,19 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=stats] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout] +`timeout`:: ++ +-- +(Optional, <>) +Period each update request waits for the following operations: + +* Dynamic mapping updates +* <> + +Defaults to `1m` (one minute). This guarantees {es} waits for at least the +timeout before failing. The actual wait time could be longer, particularly when +multiple waits occur. +-- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version] diff --git a/docs/reference/docs/update.asciidoc b/docs/reference/docs/update.asciidoc index 6c5b6ef92f8e9..f511748c83886 100644 --- a/docs/reference/docs/update.asciidoc +++ b/docs/reference/docs/update.asciidoc @@ -73,7 +73,19 @@ You can also specify a comma-separated list of the fields you want to retrieve. `_source_includes`:: (Optional, list) Specify the source fields you want to retrieve. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +`timeout`:: ++ +-- +(Optional, <>) +Period to wait for the following operations: + +* <> updates +* <> + +Defaults to `1m` (one minute). This guarantees {es} waits for at least the +timeout before failing. The actual wait time could be longer, particularly when +multiple waits occur. +-- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] diff --git a/docs/reference/indices/dangling-index-delete.asciidoc b/docs/reference/indices/dangling-index-delete.asciidoc index 45080566f640a..59d4d62bfb49b 100644 --- a/docs/reference/indices/dangling-index-delete.asciidoc +++ b/docs/reference/indices/dangling-index-delete.asciidoc @@ -41,4 +41,4 @@ UUID of the index to delete. You can find this using the This field must be set to `true` in order to carry out the import, since it will no longer be possible to recover the data from the dangling index. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/indices/dangling-index-import.asciidoc b/docs/reference/indices/dangling-index-import.asciidoc index 21ee0b5629738..11ab92b415213 100644 --- a/docs/reference/indices/dangling-index-import.asciidoc +++ b/docs/reference/indices/dangling-index-import.asciidoc @@ -42,7 +42,7 @@ cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[dangling-index-import-api-example]] ==== {api-examples-title} diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index 048ba15c13ae1..61d4ef4eaa10a 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -1040,19 +1040,19 @@ Unit used to display time values. end::time[] tag::timeoutparms[] - -tag::timeout[] tag::master-timeout[] `master_timeout`:: -(Optional, <>) Specifies the period of time to wait for -a connection to the master node. If no response is received before the timeout -expires, the request fails and returns an error. Defaults to `30s`. +(Optional, <>) +Period to wait for a connection to the master node. If no response is received +before the timeout expires, the request fails and returns an error. Defaults to +`30s`. end::master-timeout[] +tag::timeout[] `timeout`:: -(Optional, <>) Specifies the period of time to wait for -a response. If no response is received before the timeout expires, the request -fails and returns an error. Defaults to `30s`. +(Optional, <>) +Period to wait for a response. If no response is received before the timeout +expires, the request fails and returns an error. Defaults to `30s`. end::timeout[] end::timeoutparms[]