From 01fc1095fb18f1cae43e9d671fd2dd89934550fd Mon Sep 17 00:00:00 2001 From: bellengao Date: Sat, 5 Dec 2020 04:52:35 +0800 Subject: [PATCH] [DOCS] Correct the default value of `wait_for_completion` query param (#65800) Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com> --- docs/reference/cluster/tasks.asciidoc | 5 +++-- docs/reference/docs/reindex.asciidoc | 4 +++- docs/reference/rest-api/common-parms.asciidoc | 6 ------ .../searchable-snapshots/apis/mount-snapshot.asciidoc | 4 +++- 4 files changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/reference/cluster/tasks.asciidoc b/docs/reference/cluster/tasks.asciidoc index 88145cdf459db..44fe6532bd0ac 100644 --- a/docs/reference/cluster/tasks.asciidoc +++ b/docs/reference/cluster/tasks.asciidoc @@ -45,8 +45,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=parent-task-id] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_completion] - +`wait_for_completion`:: +(Optional, Boolean) If `true`, the request blocks until the operation is complete. +Defaults to `false`. [[tasks-api-response-codes]] ==== {api-response-codes-title} diff --git a/docs/reference/docs/reindex.asciidoc b/docs/reference/docs/reindex.asciidoc index 683aff2bcaa99..0dca3a6115fd0 100644 --- a/docs/reference/docs/reindex.asciidoc +++ b/docs/reference/docs/reindex.asciidoc @@ -440,7 +440,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_completion] +`wait_for_completion`:: +(Optional, Boolean) If `true`, the request blocks until the operation is complete. +Defaults to `true`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=requests_per_second] diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index 1c069f8e13dd9..0ddcd2d11d3e9 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -1100,9 +1100,3 @@ Default: 1, the primary shard. See <>. -- end::wait_for_active_shards[] - -tag::wait_for_completion[] -`wait_for_completion`:: -(Optional, Boolean) If `true`, the request blocks until the operation is complete. -Defaults to `true`. -end::wait_for_completion[] diff --git a/docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc b/docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc index da1109b70f1f5..4b8f12d59c3e4 100644 --- a/docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc +++ b/docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc @@ -45,7 +45,9 @@ to mount. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_completion] +`wait_for_completion`:: +(Optional, Boolean) If `true`, the request blocks until the operation is complete. +Defaults to `false`. [[searchable-snapshots-api-mount-request-body]] ==== {api-request-body-title}