瀏覽代碼

[DOCS] Align docs to implementation for timeout parameters (#108593)

* [DOCS] Fix documentation for timeout-related parameters

Closes #108224
Nick Tindall 1 年之前
父節點
當前提交
3ecdd77e97

+ 1 - 1
docs/reference/cluster/get-settings.asciidoc

@@ -40,4 +40,4 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
     (Optional, Boolean) If `true`, returns default cluster settings from the local node. 
     Defaults to `false`.
 
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
+include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]

+ 1 - 1
docs/reference/cluster/nodes-info.asciidoc

@@ -184,7 +184,7 @@ running process:
 
 include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
 
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
+include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeout-nodes-request]
 
 
 [[cluster-nodes-info-api-example]]

+ 1 - 1
docs/reference/cluster/nodes-stats.asciidoc

@@ -147,7 +147,7 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=level]
     (Optional, string) A comma-separated list of document types for the
     `indexing` index metric.
 
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
+include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeout-nodes-request]
 
 include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes]
 

+ 1 - 1
docs/reference/cluster/nodes-usage.asciidoc

@@ -54,7 +54,7 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=node-id]
 [[cluster-nodes-usage-api-query-params]]
 ==== {api-query-parms-title}
 
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
+include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeout-nodes-request]
 
 
 [[cluster-nodes-usage-api-example]]

+ 5 - 1
docs/reference/cluster/tasks.asciidoc

@@ -48,7 +48,11 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=nodes]
 
 include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=parent-task-id]
 
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
+`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 information. However, timed out
+nodes are included in the response's `node_failures` property. Defaults to `30s`.
 
 `wait_for_completion`::
 (Optional, Boolean) If `true`, the request blocks until all found tasks are complete.

+ 1 - 1
docs/reference/data-streams/lifecycle/apis/explain-lifecycle.asciidoc

@@ -38,7 +38,7 @@ execution.
   (Optional, Boolean) Includes default configurations related to the lifecycle of the target.
   Defaults to `false`.
 
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
+include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
 
 [[data-streams-explain-lifecycle-example]]
 ==== {api-examples-title}

+ 1 - 1
docs/reference/ilm/apis/explain.asciidoc

@@ -49,7 +49,7 @@ or `_all`.
   {ilm-init} and are in an error state, either due to an encountering an error while
   executing the policy, or attempting to use a policy that does not exist.
 
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
+include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
 
 [[ilm-explain-lifecycle-example]]
 ==== {api-examples-title}

+ 1 - 1
docs/reference/ilm/apis/remove-policy-from-index.asciidoc

@@ -40,7 +40,7 @@ target. Supports wildcards (`*`). To target all data streams and indices, use
 [[ilm-remove-policy-query-params]]
 ==== {api-query-parms-title}
 
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
+include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
 
 [[ilm-remove-policy-example]]
 ==== {api-examples-title}

+ 1 - 1
docs/reference/indices/delete-component-template.asciidoc

@@ -58,4 +58,4 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=component-template]
 [[delete-component-template-api-query-params]]
 ==== {api-query-parms-title}
 
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
+include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]

+ 1 - 1
docs/reference/indices/delete-index-template-v1.asciidoc

@@ -55,4 +55,4 @@ expressions are supported.
 [[delete-template-api-v1-query-params]]
 ==== {api-query-parms-title}
 
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
+include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]

+ 1 - 1
docs/reference/indices/delete-index-template.asciidoc

@@ -61,4 +61,4 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-template]
 [[delete-template-api-query-params]]
 ==== {api-query-parms-title}
 
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
+include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]

+ 0 - 2
docs/reference/indices/field-usage-stats.asciidoc

@@ -46,8 +46,6 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailabl
 
 include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
 
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
-
 `fields`::
 +
 --

+ 9 - 0
docs/reference/rest-api/common-parms.asciidoc

@@ -1232,6 +1232,15 @@ indicate that it was not completely acknowledged. Defaults to `30s`.
 Can also be set to `-1` to indicate that the request should never timeout.
 end::timeoutparms[]
 
+tag::timeout-nodes-request[]
+`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 information. However, timed out
+nodes are included in the response's `_nodes.failed` property. Defaults to no
+timeout.
+end::timeout-nodes-request[]
+
 tag::transform-id[]
 Identifier for the {transform}.
 end::transform-id[]

+ 2 - 4
docs/reference/rest-api/watcher/start.asciidoc

@@ -24,10 +24,8 @@ information, see <<security-privileges>>.
 //[[watcher-api-start-path-params]]
 //==== {api-path-parms-title}
 
-[[watcher-api-start-query-params]]
-==== {api-query-parms-title}
-
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
+//[[watcher-api-start-query-params]]
+//==== {api-query-parms-title}
 
 //[[watcher-api-start-request-body]]
 //==== {api-request-body-title}

+ 2 - 4
docs/reference/searchable-snapshots/apis/node-cache-stats.asciidoc

@@ -30,10 +30,8 @@ For more information, see <<security-privileges>>.
     For example, `nodeId1,nodeId2`. For node selection options, see
     <<cluster-nodes>>.
 
-[[searchable-snapshots-api-cache-stats-query-params]]
-==== {api-query-parms-title}
-
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
+//[[searchable-snapshots-api-cache-stats-query-params]]
+//==== {api-query-parms-title}
 
 [role="child_attributes"]
 [[searchable-snapshots-api-cache-stats-response-body]]

+ 1 - 1
docs/reference/shutdown/apis/shutdown-delete.asciidoc

@@ -40,7 +40,7 @@ The ID of a node that you prepared for shut down.
 [[delete-shutdown-api-params]]
 ==== {api-query-parms-title}
 
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
+include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
 
 [[delete-shutdown-api-example]]
 ==== {api-examples-title}

+ 2 - 4
docs/reference/shutdown/apis/shutdown-get.asciidoc

@@ -37,10 +37,8 @@ Use to monitor the shut down process after calling <<put-shutdown, put shutdown>
 The ID of a node that is being prepared for shutdown.
 If no ID is specified, returns the status of all nodes being prepared for shutdown.
 
-[[get-shutdown-api-params]]
-==== {api-query-parms-title}
-
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
+//[[get-shutdown-api-params]]
+//==== {api-query-parms-title}
 
 [[get-shutdown-api-example]]
 ==== {api-examples-title}

+ 1 - 1
docs/reference/shutdown/apis/shutdown-put.asciidoc

@@ -50,7 +50,7 @@ No error is thrown if you specify an invalid node ID.
 [[put-shutdown-api-params]]
 ==== {api-query-parms-title}
 
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
+include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
 
 [role="child_attributes"]
 [[put-shutdown-api-request-body]]

+ 1 - 6
docs/reference/snapshot-restore/apis/delete-repo-api.asciidoc

@@ -51,9 +51,4 @@ supported.
 [[delete-snapshot-repo-api-query-params]]
 ==== {api-query-parms-title}
 
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-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`.
+include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]

+ 1 - 6
docs/reference/snapshot-restore/apis/put-repo-api.asciidoc

@@ -52,12 +52,7 @@ IMPORTANT: Several options for this API can be specified using a query parameter
 or a request body parameter. If both parameters are specified, only the query
 parameter is used.
 
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-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`.
+include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
 
 `verify`::
 (Optional, Boolean)

+ 1 - 6
docs/reference/snapshot-restore/apis/verify-repo-api.asciidoc

@@ -47,12 +47,7 @@ Name of the snapshot repository to verify.
 [[verify-snapshot-repo-api-query-params]]
 ==== {api-query-parms-title}
 
-include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-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`.
+include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
 
 [role="child_attributes"]
 [[verify-snapshot-repo-api-response-body]]