Fix API spec for reindex rethrottle#6098
Merged
PeteGillinElastic merged 1 commit intomainfrom Mar 10, 2026
Merged
Conversation
The API spec failed to reflect the fact that this API accepts the `group_by` parameter (for historical reasons: it doesn't actually make much sense), and doesn't include all the possible elements which could be present in the response. The `group_by` parameter is marked as stack-only, as elastic/elasticsearch#143771 plans to block it in serverless (which is okay, as it is currently internal-only). The changes to the response follow the pattern used by the list tasks API (which is what this is using under the hood): https://github.com/elastic/elasticsearch-specification/blob/main/specification/tasks/_types/TaskListResponseBase.ts .
PeteGillinElastic
force-pushed
the
reindex-rethrottle-api-fix
branch
from
98154fb to
32065e4
Compare
PeteGillinElastic
added
the
skip-backport
Contributor
|
Following you can find the validation changes against the target branch for the API.
You can validate this API yourself by using the |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The API spec failed to reflect the fact that this API accepts the
group_byparameter (for historical reasons: it doesn't actually make much sense), and doesn't include all the possible elements which could be present in the response.The
group_byparameter is marked as stack-only, as elastic/elasticsearch#143771 plans to block it in serverless (which is okay, as it is currently internal-only).The changes to the response follow the pattern used by the list tasks API (which is what this is using under the hood):
https://github.com/elastic/elasticsearch-specification/blob/main/specification/tasks/_types/TaskListResponseBase.ts .