Add wait_for_completion to API documentation (#1328)

* updated incorrect links Signed-off-by: ariamarble <[email protected]> * update with wait for completion Signed-off-by: ariamarble <[email protected]> * made suggested change Signed-off-by: ariamarble <[email protected]> * made additional changes Signed-off-by: ariamarble <[email protected]> Signed-off-by: ariamarble <[email protected]>
opensearch-project · Sep 28, 2022 · 9d7592f · 9d7592f
1 parent 1b69f70
commit 9d7592f
Showing 1 changed file with 1 addition and 0 deletions.
diff --git 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