Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[7.x] [DOCS] Fix timeout parameter defaults (#66111) #66690

Merged
merged 1 commit into from
Dec 21, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/reference/cluster/stats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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, <<time-units, time units>>)
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]]
Expand Down
15 changes: 14 additions & 1 deletion docs/reference/docs/bulk.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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, <<time-units, time units>>)
Period each action waits for the following operations:

* <<index-creation,Automatic index creation>>
* <<dynamic-mapping,Dynamic mapping>> updates
* <<index-wait-for-active-shards,Waiting for active shards>>

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]

Expand Down
5 changes: 4 additions & 1 deletion docs/reference/docs/delete-by-query.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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, <<time-units, time units>>)
Period each deletion request <<index-wait-for-active-shards,waits for active
shards>>. Defaults to `1m` (one minute).

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version]

Expand Down
5 changes: 4 additions & 1 deletion docs/reference/docs/delete.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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, <<time-units, time units>>)
Period to <<index-wait-for-active-shards,wait for active shards>>. Defaults to
`1m` (one minute).

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=doc-version]

Expand Down
15 changes: 14 additions & 1 deletion docs/reference/docs/index_.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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, <<time-units, time units>>)
Period the request waits for the following operations:

* <<index-creation,Automatic index creation>>
* <<dynamic-mapping,Dynamic mapping>> updates
* <<index-wait-for-active-shards,Waiting for active shards>>

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]

Expand Down
15 changes: 14 additions & 1 deletion docs/reference/docs/reindex.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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, <<time-units, time units>>)
Period each indexing waits for the following operations:

* <<index-creation,Automatic index creation>>
* <<dynamic-mapping,Dynamic mapping>> updates
* <<index-wait-for-active-shards,Waiting for active shards>>

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]

Expand Down
14 changes: 13 additions & 1 deletion docs/reference/docs/update-by-query.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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, <<time-units, time units>>)
Period each update request waits for the following operations:

* Dynamic mapping updates
* <<index-wait-for-active-shards,Waiting for active shards>>

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]

Expand Down
14 changes: 13 additions & 1 deletion docs/reference/docs/update.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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, <<time-units, time units>>)
Period to wait for the following operations:

* <<dynamic-mapping,Dynamic mapping>> updates
* <<index-wait-for-active-shards,Waiting for active shards>>

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]

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/indices/dangling-index-delete.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
2 changes: 1 addition & 1 deletion docs/reference/indices/dangling-index-import.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
16 changes: 8 additions & 8 deletions docs/reference/rest-api/common-parms.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -1040,19 +1040,19 @@ Unit used to display time values.
end::time[]

tag::timeoutparms[]

tag::timeout[]
tag::master-timeout[]
`master_timeout`::
(Optional, <<time-units, time units>>) 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, <<time-units, time units>>)
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, <<time-units, time units>>) 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, <<time-units, time units>>)
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[]

Expand Down