opensearch-project / opensearch-project/opensearch-java

[BUG] High Level Rest Client Docs

Open
#579 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug good first issue
Dominant language
Java
Stars
165
Forks
250
Avg merge
1d 18h
Merged PRs (30d)
26

Description

What is the bug?

The docs say
The OpenSearch Java high-level REST client lets you interact with your OpenSearch clusters and indexes through Java methods and data structures rather than HTTP methods and JSON.

But isn't the point of the rest client to use http methods with json?

Also i'm confused on this warning

The OpenSearch Java high-level REST client will be deprecated starting with OpenSearch version 3.0.0 and will be removed in a future release. We recommend switching to the [Java client](https://opensearch.org/docs/2.8/clients/java/) instead.

Does the java client have a way to make rest calls where you can pass in json, or is the ability to make rest calls to opensearch blocked after v3?

Will there still be a low level rest client exposed somewhere something similar to https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/java-rest-low-usage-initialization.html ?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the quoted High Level REST Client documentation and the linked Java client documentation, then verify what each client supports for HTTP methods, JSON requests, and low-level REST calls. Done means the documentation clearly explains the deprecation warning, the Java client's REST capabilities, and whether a low-level REST client remains available after version 3.0.0.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.