-
Notifications
You must be signed in to change notification settings - Fork 604
[DOC] Add query parameter support to terms lookup table in Terms Query documentation #10527
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
[DOC] Add query parameter support to terms lookup table in Terms Query documentation #10527
Conversation
Signed-off-by: Srikanth Padakanti <[email protected]>
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. |
Signed-off-by: Fanit Kolchina <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, @srikanthpadakanti! I edited the docs. Can you please add a complete example:
- The
users
index setup - The response received from the terms lookup by query
Also, instead of the 3 examples (missing fields, field specified as scalar and list, and empty/null fields), it would be great to provide an actual request that has all 3 and the response. We can then explain the response and show the behavior.
@kolchfa-aws I have added full example covering the edge cases as well. |
Signed-off-by: Fanit Kolchina <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Editorial review
Signed-off-by: Nathan Bower <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Description
This PR updates the Terms Query documentation to reflect the enhancement for terms lookup queries to support the
query
parameter, as described in opensearch-project/OpenSearch#17599.query
parameter to the terms lookup parameters table.id
vs.query
for terms lookup.Issues Resolved
Closes #10526
Linked to opensearch-project/OpenSearch#17599
Version
To be released in the 3.2 version
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.