Adding rethrottle api docs #9607
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
AntonEliatra
requested review from
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki,
natebower,
dlvenable 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. |
|
@dhwanilpatel Could you please review this PR? Thanks! |
kolchfa-aws
added
Tech review
dhwanilpatel
approved these changes
Jun 25, 2025
kolchfa-aws
added
Doc review
kolchfa-aws
requested changes
Jun 27, 2025
There was a problem hiding this comment.
Thank you, @AntonEliatra! Please see my comments and let me know if you have any questions.
_api-reference/tasks/rethrottle.md
Outdated
| ### Example request: Re-throttle a running delete by query task | ||
|
|
||
| ```bash | ||
| curl -X POST "localhost:9200/_delete_by_query/<YOUR_TASK_ID>/_rethrottle?requests_per_second=10" -H 'Content-Type: application/json' |
There was a problem hiding this comment.
Please use Dev Tools format (POST /_delete_by_query/, etc.) without curl
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
kolchfa-aws
added
Editorial review
natebower
reviewed
Jul 1, 2025
Signed-off-by: Nathan Bower <nbower@amazon.com>
natebower
approved these changes
Jul 1, 2025
natebower
added
the
Done but waiting to merge
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Jul 14, 2025
* Adding retrottle api docs Signed-off-by: Anton Rubin <anton.rubin@eliatra.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: AntonEliatra <anton.rubin@eliatra.com> * addressing PR comments Signed-off-by: Anton Rubin <anton.rubin@eliatra.com> * Apply suggestions from code review Signed-off-by: Nathan Bower <nbower@amazon.com> --------- Signed-off-by: Anton Rubin <anton.rubin@eliatra.com> Signed-off-by: AntonEliatra <anton.rubin@eliatra.com> Signed-off-by: Nathan Bower <nbower@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> (cherry picked from commit f7b3288) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws
added a commit
that referenced
this pull request
Jul 15, 2025
* Adding retrottle api docs * Apply suggestions from code review * addressing PR comments * Apply suggestions from code review --------- (cherry picked from commit f7b3288) Signed-off-by: Anton Rubin <anton.rubin@eliatra.com> Signed-off-by: AntonEliatra <anton.rubin@eliatra.com> Signed-off-by: Nathan Bower <nbower@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adding rethrottle api docs
Issues Resolved
Closes #2112
Version
all
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.