Update doc for adding new param in cat shards action for cancellation… #8127
Conversation
… support Signed-off-by: Somesh Gupta <[email protected]>
aasom143
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
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. |
_api-reference/cat/cat-shards.md
Outdated
| @@ -33,6 +33,7 @@ Parameter | Type | Description | |||
| bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/). | |||
| local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is `false`. | |||
| cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. | |||
| cancel_after_time_interval | Time | The time after which the shards request will be canceled. Default is -1. | |||
There was a problem hiding this comment.
| cancel_after_time_interval | Time | The time after which the shards request will be canceled. Default is -1. | |
| cancel_after_time_interval | Time | The amount of time after which the shard request will be canceled. Default is `-1`. |
There was a problem hiding this comment.
I was referring the flag from the cat search API, Can you please check that - https://opensearch.org/docs/latest/api-reference/search/
If you still want i will make above suggestion.
There was a problem hiding this comment.
This way it's clearer that it's the amount of time and not just a time on the clock. We should change in search API too.
kolchfa-aws
added
release-notes
Signed-off-by: Somesh Gupta <[email protected]>
|
@kolchfa-aws can you please check and merge if it looks good? |
|
Thank you, @aasom143! Applying "Done but waiting to merge" label to put this in the 2.17 editorial queue starting 9/11. This PR will be merged before the release. |
kolchfa-aws
added
6 - Done but waiting to merge
opensearch-project#8127) * Update doc for adding new param in cat shards action for cancellation support Signed-off-by: Somesh Gupta <[email protected]> * Fixed comment Signed-off-by: Somesh Gupta <[email protected]> --------- Signed-off-by: Somesh Gupta <[email protected]> Signed-off-by: Eric Pugh <[email protected]>
opensearch-project#8127) * Update doc for adding new param in cat shards action for cancellation support Signed-off-by: Somesh Gupta <[email protected]> * Fixed comment Signed-off-by: Somesh Gupta <[email protected]> --------- Signed-off-by: Somesh Gupta <[email protected]> Signed-off-by: Noah Staveley <[email protected]>
… support
Description
Cancellation support on cat shards admin API. Added new flag to set the timeout for shard request.
Issues Resolved
Closes #13908
Version
From OS version 2.17 and onwards, the cancellation support will be given to cat shards API.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.