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] Fix OpenSearch Java documentation for IndexSettings #4072

Open
1 of 4 tasks
harshavamsi opened this issue May 12, 2023 · 6 comments
Open
1 of 4 tasks

[DOC] Fix OpenSearch Java documentation for IndexSettings #4072

harshavamsi opened this issue May 12, 2023 · 6 comments
Assignees
Labels
1 - Backlog Issue: The issue is unassigned or assigned but not started good first issue Good for newcomers Sev2 High-medium priority. Upcoming release or incorrect information.

Comments

@harshavamsi
Copy link
Contributor

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. Provide a summary of the request and all versions that are affected.
https://opensearch.org/docs/latest/clients/java/#creating-an-index -- this references a class IndexSettingsBody that does not exist in the Java client. This should just be IndexSettings.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
Coming from opensearch-project/opensearch-java#475

@Naarcha-AWS Naarcha-AWS added 1 - Backlog Issue: The issue is unassigned or assigned but not started Sev2 High-medium priority. Upcoming release or incorrect information. and removed untriaged labels May 17, 2023
@Naarcha-AWS Naarcha-AWS self-assigned this May 17, 2023
@tobycaulk-safely
Copy link

PutSettingsRequest is also present in the documentation and doesn't exist either. Seems like the correct class is PutIndicesSettingsRequest.

@Naarcha-AWS Naarcha-AWS added the good first issue Good for newcomers label Sep 8, 2023
@Naarcha-AWS Naarcha-AWS removed their assignment Oct 3, 2023
@BigSamu
Copy link
Contributor

BigSamu commented Oct 16, 2023

@Naarcha-AWS I would like to work on this issue

@BigSamu
Copy link
Contributor

BigSamu commented Oct 18, 2023

@harshavamsi, @tobycaulk-safely,

I am currently reviewing this issue and checking source code for version 2.11 and the classes you mentioned that do not exist indeed exist in the base code. Here some links:

Class IndexSettingsBody -> https://github.com/search?q=repo%3AimRishN%2Fopensearch-java+IndexSettingsBody&type=code

Class PutSettingsRequest -> https://github.com/search?q=repo%3AimRishN%2Fopensearch-java%20PutSettingsRequest&type=code

Which OpenSearch version did you use to get the BUG you mentioned?

Regards,

Samuel

@BigSamu
Copy link
Contributor

BigSamu commented Oct 20, 2023

@harshavamsi, @tobycaulk-safely,

Sorry for bothering again. I would appreciate your input on this issue. Just to see how to proceed.

Regards,

Samuel

@tobycaulk-safely
Copy link

tobycaulk-safely commented Oct 20, 2023

@BigSamu Sorry, my team abandoned this project a while ago so I'm not sure of the exact version.

Those search results you're seeing are from a forked version of this repository, though (seems to be finding results in this repository: https://github.com/imRishN/opensearch-java). Did you search all of Github or just OpenSearch's repository?

This search indicates that PutSettingsRequest does not exist in the opensearch-project/opensearch-java project:

https://github.com/search?q=repo%3Aopensearch-project%2Fopensearch-java%20PutSettingsRequest&type=code

Whereas the PutIndicesSettingsRequest does:
https://github.com/search?q=repo%3Aopensearch-project%2Fopensearch-java+PutIndicesSettingsRequest&type=code

(Also, sorry about the duplicate notifications. I just realized I had initially replied from my personal Github account. Oops!)

@BigSamu
Copy link
Contributor

BigSamu commented Oct 21, 2023

@tobycaulk-safely,

Many thanks for your reply. You're right. My bad. I was looking at the fork of imRishN. I already looked at the source code of OpenSearch, and you and @harshavamsi were right. PR #5354 was just created to solve this error in the documentation.

@Naarcha-AWS would appreciate your review of this new PR for this issue.

Regards,

Samuel

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog Issue: The issue is unassigned or assigned but not started good first issue Good for newcomers Sev2 High-medium priority. Upcoming release or incorrect information.
Projects
None yet
Development

No branches or pull requests

5 participants