Skip to content

Commit

Permalink
reuse description from delete-by-query.md, to be clearer. fix incorre…
Browse files Browse the repository at this point in the history 
…ct doc

Signed-off-by: Eric Pugh <[email protected]>
  • Loading branch information
@epugh
epugh committed Aug 30, 2024
1 parent 97fe260 commit 6219d97
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion _api-reference/document-apis/reindex.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Parameter | Type | Description
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`.
timeout | Time | How long to wait for a response from the cluster. Default is `30s`.
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.
wait_for_completion | Boolean | Waits for the matching tasks to complete. Default is `false`.
wait_for_completion | Boolean | Setting this parameter to false indicates to OpenSearch it should not wait for completion and perform this request asynchronously. Asynchronous requests run in the background, and you can use the [Tasks]({{site.url}}{{site.baseurl}}/api-reference/tasks) API to monitor progress.

Check failure on line 47 in _api-reference/document-apis/reindex.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/api-reference/tasks)'.

Raw Output:
{"message": "[OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/api-reference/tasks)'.", "location": {"path": "_api-reference/document-apis/reindex.md", "range": {"start": {"line": 47, "column": 236}}}, "severity": "ERROR"}
requests_per_second | Integer | Specifies the request’s throttling in sub-requests per second. Default is -1, which means no throttling.
require_alias | Boolean | Whether the destination index must be an index alias. Default is `false`.
scroll | Time | How long to keep the search context open. Default is `5m`.
Expand Down

0 comments on commit 6219d97

Please sign in to comment.