Skip to content

Conversation

srikanthpadakanti
Copy link
Contributor

@srikanthpadakanti srikanthpadakanti commented Jul 29, 2025

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.

  • Adds the query parameter to the terms lookup parameters table.
  • Clarifies the usage of id vs. query for terms lookup.
  • Prepares documentation for the upcoming feature release.

Issues Resolved

Closes #10526
Linked to opensearch-project/OpenSearch#17599

Version

To be released in the 3.2 version

Checklist

  • Documentation changes only
  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link

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.

@kolchfa-aws kolchfa-aws added v3.2.0 Doc review PR: Doc review in progress release-notes PR: Include this PR in the automated release notes labels Jul 30, 2025
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a 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.

@srikanthpadakanti
Copy link
Contributor Author

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]>
@kolchfa-aws kolchfa-aws added Editorial review PR: Editorial review in progress and removed Doc review PR: Doc review in progress labels Jul 30, 2025
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Editorial review

Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@natebower natebower removed the Editorial review PR: Editorial review in progress label Jul 30, 2025
@natebower natebower merged commit 35235b1 into opensearch-project:main Jul 30, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-notes PR: Include this PR in the automated release notes v3.2.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Add documentation for "Terms lookup by query" enhancement ([OpenSearch#17599](https://github.com/opensearch-project/OpenSearch/issues/17599))
3 participants