Skip to content

Conversation

finnegancarroll
Copy link
Contributor

@finnegancarroll finnegancarroll commented Oct 9, 2025

Description

Add gRPC example code snippets for python which mirror the existing java examples.

(Additionally fixing the PyPI link in _api-reference/grpc-apis/index.md. This was pointing to most recent release, but for 3.3 it should be specifically 0.19.0.)

Testing these example code snippets by copying them into a python file and executing against a 3.3 node.
Bulk example: python grpcbulktest.py

index {
  x_index: "my-index"
  x_id {
    string: "U-HpyZkBc-tZ9EIMBNch"
  }
  x_primary_term: 1
  result: "created"
  x_seq_no: 3
  x_shards {
    successful: 1
    total: 2
  }
  x_version: 1
}

Search example: python grpcsearchtest.py

Found total_hits {
  relation: TOTAL_HITS_RELATION_EQ
  value: 4
}
 hits
total {
  total_hits {
    relation: TOTAL_HITS_RELATION_EQ
    value: 4
  }
}
hits {
  x_index: "my-index"
  x_id: "T-G-yZkBc-tZ9EIM89dJ"
  x_score {
    double: 0.047891139984130859
  }
  x_source: "{\"field\": \"value\"}"
}

Issues Resolved

Closes #11189

Version

3.3

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

  • 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

github-actions bot commented Oct 9, 2025

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: Finn Carroll <[email protected]>
@kolchfa-aws kolchfa-aws added Tech review PR: Tech review in progress release-notes PR: Include this PR in the automated release notes v3.3.0 labels Oct 9, 2025
Copy link
Contributor

@karenyrx karenyrx left a comment

Choose a reason for hiding this comment

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

Thanks @finnegancarroll !

@finnegancarroll
Copy link
Contributor Author

Hi @kolchfa-aws , this pr is ready for review. Thanks!

@kolchfa-aws kolchfa-aws added Doc review PR: Doc review in progress and removed Tech review PR: Tech review in progress labels Oct 9, 2025
@kolchfa-aws kolchfa-aws added Editorial review PR: Editorial review in progress and removed Doc review PR: Doc review in progress labels Oct 9, 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.

LGTM

@natebower natebower removed the Editorial review PR: Editorial review in progress label Oct 9, 2025
@natebower natebower merged commit a4c1364 into opensearch-project:main Oct 9, 2025
7 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.3.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] Add gRPC python client library usage examples

4 participants