Skip to content

Conversation

karenyrx
Copy link
Contributor

@karenyrx karenyrx commented Oct 9, 2025

Description

  1. Update the Java examples to have error handling scenarios
  2. Update the gRPC usage guide to put more important sections first for clarity

Issues Resolved

Closes #10999

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: Karen X <[email protected]>
@karenyrx karenyrx marked this pull request as ready for review October 9, 2025 20:15
Signed-off-by: Karen X <[email protected]>
@finnegancarroll
Copy link
Contributor

https://github.com/opensearch-project/opensearch-protobufs/compare/2ea2050d375d71ff142279c3cdccf0b4c692c678..b6f889416da83b7dc4a0408347965e7820bd61d0

I think there were a couple minor name changes in bulk request:
setIndex -> setXIndex
setId -> setXId

OperationContainer added to BulkBody:

        BulkRequestBody deleteBody = BulkRequestBody.newBuilder()
                .set(deleteOp)

->

        BulkRequestBody deleteBody = BulkRequestBody.newBuilder()
                .setOperationContainer(OperationContainer.newBuilder().setDelete(deleteOp).build())


HitsMetadata hits = response.getHits();
if (hits.hasTotal()) {
System.out.println("Total hits: " + hits.getTotal().getValue());
Copy link
Contributor

Choose a reason for hiding this comment

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

System.out.println("Total hits: " + hits.getTotal().getTotalHits().getValue());

@finnegancarroll
Copy link
Contributor

Added couple comments on variable name changes - otherwise LGTM.

Signed-off-by: Karen X <[email protected]>
@karenyrx
Copy link
Contributor Author

hi @kolchfa-aws could you help review this? Tech review is complete. Thanks!

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, @karenyrx! Please see my comments and let me know if you have any questions.

@kolchfa-aws kolchfa-aws added Doc review PR: Doc review in progress release-notes PR: Include this PR in the automated release notes v3.3.0 labels Oct 13, 2025
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Nathan Bower <[email protected]>
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.

Doc and editorial reviews complete. LGTM

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] Documentation for GRPC APIs in 3.3 release

4 participants