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

[FEATURE] Opensearch 2.7.x client documentation improvements #499

Closed
firatsivrikaya opened this issue May 23, 2023 · 1 comment · Fixed by opensearch-project/documentation-website#4149 or #501
Assignees
Labels
enhancement New feature or request

Comments

@firatsivrikaya
Copy link

Is your feature request related to a problem?

While I have been checking the documentation of opensearch clients for 2.7.x on Java client - OpenSearch documentation I have seen that some of the examples (eg Java client - OpenSearch documentation) are using
org.apache.hc.client5 and org.apache.hc.core5 packages, but sample program on Java client - OpenSearch documentation is done with org.apache.http. packages.

What solution would you like?

Documentation should state that I need a additional third party dependencies to run the example which uses the hc packages.
Also, It would be good if we could see a complete example on the create client part of the developer guide for each versions.
opensearch-java/USER_GUIDE.md at main · opensearch-project/opensearch-java · GitHub

What alternatives have you considered?

Do you have any additional context?

Version : OpenSearch 2.7.x
OS Forum Question Link : https://forum.opensearch.org/t/opensearch-2-7-x-client-documentation/14424
implementation ‘org.opensearch.client:opensearch-rest-client:2.7.0’
implementation ‘org.opensearch.client:opensearch-java:2.4.0’

PS: There is an extra space on documentation of gradle script (between rest-client and 2.7.0 parts)
dependencies {
implementation 'org.opensearch.client:opensearch-rest-client: 2.7.0'
implementation 'org.opensearch.client:opensearch-java:2.4.0'
}

Thanks!

@firatsivrikaya firatsivrikaya added enhancement New feature or request untriaged labels May 23, 2023
@firatsivrikaya firatsivrikaya changed the title [FEATURE] [FEATURE] Opensearch 2.7.x client documentation improvements May 23, 2023
@reta reta removed the untriaged label May 23, 2023
@reta reta self-assigned this May 23, 2023
@reta
Copy link
Collaborator

reta commented May 23, 2023

I believe the documentation snippet for 2.x line includes RestClient usage for OpenSearch 3.x line, I will fix that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
2 participants