Fix wait_for_completion option description and default setting docs #8136
Conversation
epugh
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable and
stephen-crawford
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
…ct doc Signed-off-by: Eric Pugh <[email protected]>
epugh
force-pushed
the
fix_wait_for_completion_doc
branch
from
1061550 to
6219d97
Compare
epugh
changed the title
There was a problem hiding this comment.
@epugh: Is the default setting false? Also, can you make sure that my suggestion doesn't change any technical meaning?
| @@ -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. | |||
There was a problem hiding this comment.
| 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. | |
| wait_for_completion | Boolean | When `false`, OpenSearch does not wait for the reindex to complete and instead performs this request asynchronously. Asynchronous requests run in the background. You can use the [Tasks]({{site.url}}{{site.baseurl}}/api-reference/tasks/) API to monitor progress. |
There was a problem hiding this comment.
so your change is good. However, it isn't clear that the default is "true", I thought the other wording maybe did that better. Thoughts on how to make it clear the default for this parameter is true?
There was a problem hiding this comment.
To be clear, the default is "true"!
There was a problem hiding this comment.
| 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. | |
| wait_for_completion | Boolean | When `false`, OpenSearch does not wait for the reindex to complete and instead performs this request asynchronously. Asynchronous requests run in the background. You can use the [Tasks]({{site.url}}{{site.baseurl}}/api-reference/tasks/) API to monitor progress. Default is `true`. |
There was a problem hiding this comment.
I think you can tag the default to the end unless you want to add additional context for the default behavior.
Naarcha-AWS
added
4 - Doc review
|
@epugh: Let me know once you've implemented the changes and we'll get this merged. |
Description
The documentation for the
wait_for_completionturns out to be wrong, the default value istrue. However, more importantly, it's not a great doc... I didn't get what it did at first till a colleague pointed it out and then someone on#generalclarified it for me!I did a quick search for
wait_for_completionacross docs, and stylisticially it's documented in a few ways. For my fix, I took the descirption used indelete-by-query.md.I did NOT try to fix the other places where maybe the option description could be improved or standardized....
Issues Resolved
List any issues this PR will resolve, e.g. Closes [...].
Version
2.16
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.