documentation-website icon indicating copy to clipboard operation
documentation-website copied to clipboard

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

Open epugh opened this issue 1 year ago • 1 comments

What do you want to do?

  • [ ] Request a change to existing documentation
  • [ ] Add new documentation
  • [x] 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

epugh avatar Oct 28 '24 21:10 epugh

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

Naarcha-AWS avatar Nov 07 '24 19:11 Naarcha-AWS