Skip to content

Add Cluster/Allocation/Explain Query Param Example #4849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

joshua-adams-1
Copy link

@joshua-adams-1 joshua-adams-1 commented Jul 9, 2025


Change Details

Extends the documentation for the cluster/allocation/explain API after query parameter support was added in elastic/elasticsearch#129342

  • The query parameters were defined
  • A second request example was provided, highlighting how to pass all parameters in the URL string rather than the request body

Release

To be merged after elastic/elasticsearch#129342


Issue - elastic/elasticsearch#127028

Extends the documentation for the `cluster/allocation/explain` API after query parameter support was added in #129342. A second example request was provided with all four query parameters and an empty request body.
Autogenerated output from running `make contrib`
@joshua-adams-1 joshua-adams-1 requested a review from a team as a code owner July 9, 2025 09:47
Declared the query parameters, ran make contrib and resolved the validation errors
@joshua-adams-1 joshua-adams-1 self-assigned this Jul 9, 2025
@joshua-adams-1 joshua-adams-1 marked this pull request as draft July 9, 2025 10:05
@joshua-adams-1 joshua-adams-1 added documentation skip-backport This pull request should not be backported and removed documentation labels Jul 9, 2025
@joshua-adams-1 joshua-adams-1 marked this pull request as ready for review July 9, 2025 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-backport This pull request should not be backported specification
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant