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] List Analyzers Through _cat #5426

Closed
1 of 4 tasks
macohen opened this issue Oct 30, 2023 · 3 comments
Closed
1 of 4 tasks

[DOC] List Analyzers Through _cat #5426

macohen opened this issue Oct 30, 2023 · 3 comments
Assignees
Labels
Milestone

Comments

@macohen
Copy link
Contributor

macohen commented Oct 30, 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.
This feature gives users the ability to list all analyzers available on their cluster. We are targeting 2.12 for this release.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
opensearch-project/OpenSearch#5481

cc: @lukas-vlcek (the developer of this feature)

@macohen macohen changed the title [DOC] [DOC] List Analyzers Through _cat Oct 30, 2023
@hdhalter hdhalter added this to the v2.12 milestone Oct 30, 2023
@hdhalter hdhalter added 1 - Backlog Issue: The issue is unassigned or assigned but not started and removed untriaged labels Oct 30, 2023
@hdhalter hdhalter added 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. and removed 1 - Backlog Issue: The issue is unassigned or assigned but not started labels Dec 1, 2023
@macohen
Copy link
Contributor Author

macohen commented Dec 1, 2023

@lukas-vlcek are you able to provide documentation for this feature? Thinking this could go here: https://opensearch.org/docs/latest/analyzers/index/. Check out https://github.com/opensearch-project/documentation-website for the source for the docs if you haven't before...

Thanks!

@hdhalter hdhalter added 2 - In progress Issue/PR: The issue or PR is in progress. and removed 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. labels Jan 29, 2024
@lukas-vlcek
Copy link
Contributor

@macohen I created a PR to add documentation around new API option here #6252
However, the list of text analysis components is NOT currently included in _cat API because the information does not fit tab separated output very well.

Shall we close this ticket for now? The discussion can still go on and we can reopen if we find good representation of the information for _cat API. I am open to any suggestions but currently it is only part of Nodes API.

@hdhalter
Copy link
Contributor

Yes, we can close this and revisit when appropriate. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

No branches or pull requests

4 participants