docs: Update live queries documentation with new response format#12186
Merged
kolchfa-aws merged 3 commits intoopensearch-project:mainfrom Apr 6, 2026
Merged
Conversation
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc 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). |
Update the live queries API documentation to reflect the restructured response model including coordinator/shard task breakdowns, finished queries cache lifecycle, new query parameters (wlmGroupId, use_finished_cache), and detailed field explanations for both live and finished query responses. Signed-off-by: Kishore Kumaar Natarajan <kkumaarn@amazon.com>
1a257b3 to
84e120e
Compare
Collaborator
|
@KishoreKicha14 Is this ready for doc review? |
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
kolchfa-aws
approved these changes
Apr 6, 2026
Collaborator
kolchfa-aws
left a comment
There was a problem hiding this comment.
Thank you, @KishoreKicha14! Doc review complete.
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
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
Update the live queries API documentation to reflect the restructured response model in the query-insights plugin. Changes include:
Issues Resolved
Closes[]
Version
3.6
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.