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] The `_index_template' API docs are missing #5394

Closed
1 of 4 tasks
alex-at-cascade opened this issue Oct 25, 2023 · 3 comments · Fixed by #7635
Closed
1 of 4 tasks

[DOC] The `_index_template' API docs are missing #5394

alex-at-cascade opened this issue Oct 25, 2023 · 3 comments · Fixed by #7635
Assignees
Labels
2 - In progress Issue/PR: The issue or PR is in progress. API Content gap

Comments

@alex-at-cascade
Copy link

alex-at-cascade commented Oct 25, 2023

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.

The _index_template API docs are missing. It would be helpful if the full description of the API was covered. (As well as the deprecated _template APIs, for helping to understand code that are calling those.)

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

@alex-at-cascade alex-at-cascade changed the title [DOC] the `_index_template' API docs are missing [DOC] The `_index_template' API docs are missing Oct 25, 2023
@hdhalter
Copy link
Contributor

hdhalter commented Nov 9, 2023

Hi @alex-at-cascade - does this page cover the information you are looking for? https://opensearch.org/docs/2.11/im-plugin/index-templates/

@hdhalter hdhalter added 2 - In progress Issue/PR: The issue or PR is in progress. and removed untriaged labels Nov 9, 2023
@hdhalter hdhalter self-assigned this Nov 9, 2023
@alex-at-cascade
Copy link
Author

That seems to have some stuff, but it seemed like it might be incomplete. I was looking for the full API definition in the "API Reference" section. (As an example, see how https://opensearch.org/docs/2.11/api-reference/index-apis/alias/ has a lot more detail than https://opensearch.org/docs/2.11/im-plugin/index-alias/ )

@hdhalter
Copy link
Contributor

@kolchfa-aws - Assigning to you so you can look into it when you start work on the API coverage. Thanks.

@kolchfa-aws kolchfa-aws added 1 - Backlog Issue: The issue is unassigned or assigned but not started and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Nov 29, 2023
@Naarcha-AWS Naarcha-AWS added 2 - In progress Issue/PR: The issue or PR is in progress. and removed 1 - Backlog Issue: The issue is unassigned or assigned but not started labels May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In progress Issue/PR: The issue or PR is in progress. API Content gap
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants