Update gRPC terms lookup for protobufs 1.7.0 (id_2/query) - #12968
Update gRPC terms lookup for protobufs 1.7.0 (id_2/query)#12968wanshi-ma wants to merge 2 commits into
Conversation
Signed-off-by: Wanshi Ma <wanshima@amazon.com>
|
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
left a comment
There was a problem hiding this comment.
Thank you, @wanshi-ma!
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
|
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 |
There was a problem hiding this comment.
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
Description
Updates the gRPC Search API reference for the protobufs 1.7.0 changes to
TermsLookup. 1.7.0 adds anid_2/queryoneof toTermsLookupand deprecates the flatidfield, and renames theTermsQuerymap/value fields (terms_lookup_field_string_array_map→terms,terms_lookup_field→lookup,string_array→value). This PR:TermsQueryFieldandTermsLookupmessage-field tables, documentingid_2,query,routing,store, and markingidas deprecated (useid_2).id_2(document-id) andquery(query-based) lookups plus the deprecated-idbackward-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