Update OpenSearch Java Client documentation: update version, add ApacheHttpClient5Transport, fix code samples by reta · Pull Request #3510 · opensearch-project/documentation-website

reta · 2023-03-16T20:37:53Z

Description

Update OpenSearch Java Client documentation: update version, add ApacheHttpClient5Transport, fix code samples

Issues Resolved

Closes opensearch-project/opensearch-java#409

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.

…heHttpClient5Transport, fix code samples Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

reta · 2023-03-16T20:38:20Z

@VachaShah @hdhalter @dblock please take a look, thank you!

kolchfa-aws

LGTM. Made a couple of suggestions. Thanks, @reta!

kolchfa-aws · 2023-03-16T20:40:56Z

_clients/java.md

 This getting started guide illustrates how to connect to OpenSearch, index documents, and run queries. For the client source code, see the [opensearch-java repo](https://github.com/opensearch-project/opensearch-java).

-## Installing the client
+## Installing the client using Apache HttpClient 5 Transport


Suggested change

## Installing the client using Apache HttpClient 5 Transport

## Installing the client using Apache HttpClient 5 Transport

kolchfa-aws · 2023-03-17T00:57:36Z

_clients/java.md


-## Installing the client
+## Installing the client using Apache HttpClient 5 Transport
+To start using the OpenSearch Java client, you need to provide the transport. The default one is `ApacheHttpClient5TransportBuilder` and comes with the Java client.


Suggested change

To start using the OpenSearch Java client, you need to provide the transport. The default one is `ApacheHttpClient5TransportBuilder` and comes with the Java client.

To start using the OpenSearch Java client, you need to provide a transport. The default `ApacheHttpClient5TransportBuilder` transport comes with the Java client. To use the OpenSearch Java client with the default transport, add it to your `pom.xml` file as a dependency:

kolchfa-aws · 2023-03-17T01:00:34Z

_clients/java.md

+```
+{% include copy.html %}
+
+If you're using Gradle, add the following dependencies to your project.


Suggested change

If you're using Gradle, add the following dependencies to your project.

If you're using Gradle, add the following dependencies to your project:

kolchfa-aws · 2023-03-17T01:02:29Z

_clients/java.md

+
+## Installing the client using RestClient Transport
+
+The alternative way to create a Java client is by using `RestClient` based transport, ensure that you have the following dependencies in your project's `pom.xml` file:


Suggested change

The alternative way to create a Java client is by using `RestClient` based transport, ensure that you have the following dependencies in your project's `pom.xml` file:

Alternatively, you can create a Java client by using the `RestClient`-based transport. In this case, make sure that you have the following dependencies in your project's `pom.xml` file:

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

reta · 2023-03-17T12:12:13Z

LGTM. Made a couple of suggestions. Thanks, @reta!

Thanks @kolchfa-aws , comments addressed!

…heHttpClient5Transport, fix code samples (#3510) * Update OpenSearch Java Client documentation: update version, add ApacheHttpClient5Transport, fix code samples Signed-off-by: Andriy Redko <andriy.redko@aiven.io> * Address review comments Signed-off-by: Andriy Redko <andriy.redko@aiven.io> --------- Signed-off-by: Andriy Redko <andriy.redko@aiven.io> (cherry picked from commit 4e58f94) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…heHttpClient5Transport, fix code samples (#3510) (#3537) * Update OpenSearch Java Client documentation: update version, add ApacheHttpClient5Transport, fix code samples * Address review comments --------- (cherry picked from commit 4e58f94) Signed-off-by: Andriy Redko <andriy.redko@aiven.io> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…heHttpClient5Transport, fix code samples (#3510) (#3536) * Update OpenSearch Java Client documentation: update version, add ApacheHttpClient5Transport, fix code samples * Address review comments --------- (cherry picked from commit 4e58f94) Signed-off-by: Andriy Redko <andriy.redko@aiven.io> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…heHttpClient5Transport, fix code samples (#3510) (#3535) * Update OpenSearch Java Client documentation: update version, add ApacheHttpClient5Transport, fix code samples * Address review comments --------- (cherry picked from commit 4e58f94) Signed-off-by: Andriy Redko <andriy.redko@aiven.io> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…heHttpClient5Transport, fix code samples (#3510) * Update OpenSearch Java Client documentation: update version, add ApacheHttpClient5Transport, fix code samples Signed-off-by: Andriy Redko <andriy.redko@aiven.io> * Address review comments Signed-off-by: Andriy Redko <andriy.redko@aiven.io> --------- Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

…heHttpClient5Transport, fix code samples (opensearch-project#3510) * Update OpenSearch Java Client documentation: update version, add ApacheHttpClient5Transport, fix code samples Signed-off-by: Andriy Redko <andriy.redko@aiven.io> * Address review comments Signed-off-by: Andriy Redko <andriy.redko@aiven.io> --------- Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

Update OpenSearch Java Client documentation: update version, add Apac…

9f3b190

…heHttpClient5Transport, fix code samples Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

reta requested a review from a team as a code owner March 16, 2023 20:37

kolchfa-aws approved these changes Mar 17, 2023

View reviewed changes

Address review comments

1858683

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

Naarcha-AWS approved these changes Mar 21, 2023

View reviewed changes

Naarcha-AWS added backport 1.3 PR: Backport label for v1.3.x backport 2.5 PR: Backport label for 2.5 backport 2.6 PR: Backport label for 2.6 labels Mar 21, 2023

Naarcha-AWS merged commit 4e58f94 into opensearch-project:main Mar 21, 2023

opensearch-trigger-bot bot mentioned this pull request Mar 21, 2023

[Backport 1.3] Update OpenSearch Java Client documentation: update version, add ApacheHttpClient5Transport, fix code samples #3535

Merged

opensearch-trigger-bot bot mentioned this pull request Mar 21, 2023

[Backport 2.5] Update OpenSearch Java Client documentation: update version, add ApacheHttpClient5Transport, fix code samples #3536

Merged

opensearch-trigger-bot bot mentioned this pull request Mar 21, 2023

[Backport 2.6] Update OpenSearch Java Client documentation: update version, add ApacheHttpClient5Transport, fix code samples #3537

Merged

reta mentioned this pull request Mar 22, 2023

[BUG] Feedback on Java Client documentation opensearch-project/opensearch-java#409

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update OpenSearch Java Client documentation: update version, add ApacheHttpClient5Transport, fix code samples#3510

Update OpenSearch Java Client documentation: update version, add ApacheHttpClient5Transport, fix code samples#3510
Naarcha-AWS merged 2 commits intoopensearch-project:mainfrom
reta:issue-409

reta commented Mar 16, 2023

Uh oh!

reta commented Mar 16, 2023 •

edited

Loading

Uh oh!

kolchfa-aws left a comment

Uh oh!

kolchfa-aws Mar 16, 2023

Uh oh!

kolchfa-aws Mar 17, 2023 •

edited

Loading

Uh oh!

kolchfa-aws Mar 17, 2023

Uh oh!

kolchfa-aws Mar 17, 2023

Uh oh!

reta commented Mar 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	## Installing the client using Apache HttpClient 5 Transport
	## Installing the client using Apache HttpClient 5 Transport

	To start using the OpenSearch Java client, you need to provide the transport. The default one is `ApacheHttpClient5TransportBuilder` and comes with the Java client.
	To start using the OpenSearch Java client, you need to provide a transport. The default `ApacheHttpClient5TransportBuilder` transport comes with the Java client. To use the OpenSearch Java client with the default transport, add it to your `pom.xml` file as a dependency:

	If you're using Gradle, add the following dependencies to your project.
	If you're using Gradle, add the following dependencies to your project:


		## Installing the client using RestClient Transport

		The alternative way to create a Java client is by using `RestClient` based transport, ensure that you have the following dependencies in your project's `pom.xml` file:

	The alternative way to create a Java client is by using `RestClient` based transport, ensure that you have the following dependencies in your project's `pom.xml` file:
	Alternatively, you can create a Java client by using the `RestClient`-based transport. In this case, make sure that you have the following dependencies in your project's `pom.xml` file:

Conversation

reta commented Mar 16, 2023

Description

Issues Resolved

Checklist

Uh oh!

reta commented Mar 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kolchfa-aws left a comment

Choose a reason for hiding this comment

Uh oh!

kolchfa-aws Mar 16, 2023

Choose a reason for hiding this comment

Uh oh!

kolchfa-aws Mar 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kolchfa-aws Mar 17, 2023

Choose a reason for hiding this comment

Uh oh!

kolchfa-aws Mar 17, 2023

Choose a reason for hiding this comment

Uh oh!

reta commented Mar 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

reta commented Mar 16, 2023 •

edited

Loading

kolchfa-aws Mar 17, 2023 •

edited

Loading