Skip to content

Commit 2708bfd

Browse files
Fix wait_for_completion option description and default setting docs (#8136) (#10299)
1 parent 0d63d14 commit 2708bfd

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

_api-reference/document-apis/reindex.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Parameter | Type | Description
3030
refresh | Boolean | If true, OpenSearch refreshes shards to make the reindex operation available to search results. Valid options are `true`, `false`, and `wait_for`, which tells OpenSearch to wait for a refresh before executing the operation. Default is `false`.
3131
timeout | Time | How long to wait for a response from the cluster. Default is `30s`.
3232
wait_for_active_shards | String | The number of active shards that must be available before OpenSearch processes the reindex request. Default is 1 (only the primary shard). Set to `all` or a positive integer. Values greater than 1 require replicas. For example, if you specify a value of 3, the index must have two replicas distributed across two additional nodes for the operation to succeed.
33-
wait_for_completion | Boolean | Waits for the matching tasks to complete. Default is `false`.
33+
wait_for_completion | Boolean | If `false`, OpenSearch runs the reindex operation asynchronously, without waiting for it to complete. The request returns immediately, and the task continues in the background. You can monitor its progress using the [Tasks API]({{site.url}}{{site.baseurl}}/api-reference/tasks/). Default is `true`, which means the operation runs synchronously.
3434
requests_per_second | Integer | Specifies the request’s throttling in sub-requests per second. Default is -1, which means no throttling.
3535
require_alias | Boolean | Whether the destination index must be an index alias. Default is `false`.
3636
scroll | Time | How long to keep the search context open. Default is `5m`.

0 commit comments

Comments
 (0)