Skip to content

Commit 050c7eb

Browse files
jrodewiggaobinlong
andauthored
[DOCS] Correct the default value of wait_for_completion query param (#65800) (#65902)
Co-authored-by: James Rodewig <[email protected]> Co-authored-by: bellengao <[email protected]>
1 parent ab05f62 commit 050c7eb

File tree

4 files changed

+9
-10
lines changed

4 files changed

+9
-10
lines changed

docs/reference/cluster/tasks.asciidoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=parent-task-id]
4545

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

48-
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_completion]
49-
48+
`wait_for_completion`::
49+
(Optional, Boolean) If `true`, the request blocks until the operation is complete.
50+
Defaults to `false`.
5051

5152
[[tasks-api-response-codes]]
5253
==== {api-response-codes-title}

docs/reference/docs/reindex.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout]
440440

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

443-
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_completion]
443+
`wait_for_completion`::
444+
(Optional, Boolean) If `true`, the request blocks until the operation is complete.
445+
Defaults to `true`.
444446

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

docs/reference/rest-api/common-parms.asciidoc

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1102,9 +1102,3 @@ Default: 1, the primary shard.
11021102
See <<index-wait-for-active-shards>>.
11031103
--
11041104
end::wait_for_active_shards[]
1105-
1106-
tag::wait_for_completion[]
1107-
`wait_for_completion`::
1108-
(Optional, Boolean) If `true`, the request blocks until the operation is complete.
1109-
Defaults to `true`.
1110-
end::wait_for_completion[]

docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ to mount.
4545

4646
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
4747

48-
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_completion]
48+
`wait_for_completion`::
49+
(Optional, Boolean) If `true`, the request blocks until the operation is complete.
50+
Defaults to `false`.
4951

5052
[[searchable-snapshots-api-mount-request-body]]
5153
==== {api-request-body-title}

0 commit comments

Comments
 (0)