Skip to content

Update gRPC terms lookup for protobufs 1.7.0 (id_2/query) - #12968

Open
wanshi-ma wants to merge 2 commits into
opensearch-project:mainfrom
wanshi-ma:grpc-terms-lookup-1.7.0
Open

Update gRPC terms lookup for protobufs 1.7.0 (id_2/query)#12968
wanshi-ma wants to merge 2 commits into
opensearch-project:mainfrom
wanshi-ma:grpc-terms-lookup-1.7.0

Conversation

@wanshi-ma

Copy link
Copy Markdown

Description

Updates the gRPC Search API reference for the protobufs 1.7.0 changes to TermsLookup. 1.7.0 adds an id_2 / query oneof to TermsLookup and deprecates the flat id field, and renames the TermsQuery map/value fields (terms_lookup_field_string_array_mapterms, terms_lookup_fieldlookup, string_arrayvalue). This PR:

  • Adds TermsQueryField and TermsLookup message-field tables, documenting id_2, query, routing, store, and marking id as deprecated (use id_2).
  • Updates the "Terms query" and "Terms query with a terms lookup" examples to the 1.7.0 field names, and adds examples for the new id_2 (document-id) and query (query-based) lookups plus the deprecated-id backward-compatibility path.

All request examples were verified against a local node running the 1.7.0 protobufs (server code change: opensearch-project/OpenSearch#22759).

Issues Resolved

Companion to opensearch-project/OpenSearch#22759 (protobufs 1.7.0 bump); protobufs schema change: opensearch-project/opensearch-protobufs#480.

Version

3.9

Frontend features

N/A

Checklist

  • 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.

Signed-off-by: Wanshi Ma <wanshima@amazon.com>
@github-actions

Copy link
Copy Markdown

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).

@kolchfa-aws kolchfa-aws added release-notes PR: Include this PR in the automated release notes v3.9.0 labels Aug 24, 2026

@kolchfa-aws kolchfa-aws left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thank you, @wanshi-ma!

Comment thread _api-reference/grpc-apis/search.md Outdated
Comment thread _api-reference/grpc-apis/search.md Outdated
Comment thread _api-reference/grpc-apis/search.md Outdated
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
@kolchfa-aws

Copy link
Copy Markdown
Collaborator

Thank you, @wanshi-ma! @karenyrx Would you like to review this PR?

| `value_type` | `optional` [`TermsQueryValueType`](https://github.com/opensearch-project/opensearch-protobufs/blob/1.4.0/protos/schemas/common.proto#L3310) | The types of values used for filtering. Valid values are `default` and `bitmap`. Default is `default`. |
| `terms` | `map<string, `[`TermsQueryField`](https://github.com/opensearch-project/opensearch-protobufs/blob/1.4.0/protos/schemas/common.proto#L2332)`>` | A map of field names to term values or term lookups. |

#### TermsQueryField fields

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @wanshi-ma ! This PR looks good to me, provided opensearch-project/OpenSearch#22759 is merged (which should be soon).

For upgrading the rest of the file from protobufs version 1.4.0 -> 1.7.0, I'll take it up as a separate PR: https://github.com/opensearch-project/documentation-website/pull/12980/changes

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 Tech review PR: Tech review in progress v3.9.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants