From 9d7592f4009895b07d54eb753a57412ca601a0e9 Mon Sep 17 00:00:00 2001 From: Aria Marble <111301581+ariamarble@users.noreply.github.com> Date: Tue, 27 Sep 2022 17:09:07 -0700 Subject: [PATCH] Add wait_for_completion to API documentation (#1328) * updated incorrect links Signed-off-by: ariamarble * update with wait for completion Signed-off-by: ariamarble * made suggested change Signed-off-by: ariamarble * made additional changes Signed-off-by: ariamarble Signed-off-by: ariamarble --- _opensearch/rest-api/document-apis/update-by-query.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_opensearch/rest-api/document-apis/update-by-query.md b/_opensearch/rest-api/document-apis/update-by-query.md index bb7ebe2b08..a9d6177938 100644 --- a/_opensearch/rest-api/document-apis/update-by-query.md +++ b/_opensearch/rest-api/document-apis/update-by-query.md @@ -77,6 +77,7 @@ terminate_after | Integer | The maximum number of documents OpenSearch should pr timeout | Time | How long the operation should wait from a response from active shards. Default is `1m`. version | Boolean | Whether to include the document version as a match. wait_for_active_shards | String | The number of shards that must be active before OpenSearch executes the operation. Valid values are `all` or any integer up to the total number of shards in the index. Default is 1, which is the primary shard. +wait_for_completion | boolean | When set to `false`, the response body includes a task ID and OpenSearch executes the operation asynchronously. The task ID can be used to check the status of the task or to cancel the task. Default is set to `true`. ## Request body