Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Java Client page is out of date and needs updating #8625

Open
1 of 4 tasks
epugh opened this issue Oct 28, 2024 · 1 comment
Open
1 of 4 tasks

[DOC] Java Client page is out of date and needs updating #8625

epugh opened this issue Oct 28, 2024 · 1 comment
Assignees
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. v2.16.0

Comments

@epugh
Copy link
Collaborator

epugh commented Oct 28, 2024

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request.

The https://opensearch.org/docs/latest/clients/java/ page is out of date. There are a long list of things that need updating:

  1. final ApacheHttpClient5TransportBuilder builder = ApacheHttpClient5TransportBuilder.builder(host); code doesn't exist.
  2. final HttpHost host = new HttpHost("https", "localhost", 9200); is specifying parameters in the wrong order
  3. It's unclear why you would pick RestClient versus Apache HttpClient 5, guidence would be useful.
  4. Sections below the two clients, it's unclear if they apply to both clients or not.
  5. We reference implementation 'org.opensearch.client:opensearch-java:2.8.1' however we are up to 2.16.0.
  6. Java High Level Rest Client shows up higher in the navigation, even through it's not recommended.

Version: List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all.
2.16, but I think it's been there a while.

What other resources are available?

n/a

@Naarcha-AWS
Copy link
Collaborator

@epugh: Thanks for submitting this! Did you want to submit a PR updating the issues you see?

@Naarcha-AWS Naarcha-AWS added 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. and removed untriaged labels Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. v2.16.0
Projects
None yet
Development

No branches or pull requests

2 participants