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.

Sign up for GitHub

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

Jump to bottom

[DOC] New Paginated _list APIs (_list/indices and _list/shards) in Opensearch #8596

Closed
1 of 4 tasks
gargharsh3134 opened this issue Oct 22, 2024 · 0 comments · Fixed by #8594
Closed
1 of 4 tasks

[DOC] New Paginated _list APIs (_list/indices and _list/shards) in Opensearch #8596

gargharsh3134 opened this issue Oct 22, 2024 · 0 comments · Fixed by #8594
Assignees
@gargharsh3134
Labels
2 - In progress Issue/PR: The issue or PR is in progress. v2.18.0

Comments

@gargharsh3134
Copy link
Contributor

gargharsh3134 commented Oct 22, 2024 •
edited
Loading

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.
Documentation changes required for newly introduced _list APIs (namely _list/indices and _list/shards). These new APIs serve as a paginated alternate to existing _cat/indices and _cat/shards APIs. _list/indices and _list/shards APIs, will continue to support all the query parameters which are currently supported by the _cat counterparts, along with 3 new additional parameters, namely:
next_token, size and sort

*Version: 2.18 and onwards.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
opensearch-project/OpenSearch#14258
opensearch-project/OpenSearch#14257
@gargharsh3134 gargharsh3134 mentioned this issue Oct 22, 2024
Merged
1 task
@Naarcha-AWS Naarcha-AWS added 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. v2.18.0 and removed untriaged labels Oct 22, 2024
@Naarcha-AWS Naarcha-AWS 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 Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gargharsh3134 gargharsh3134

Labels
2 - In progress Issue/PR: The issue or PR is in progress. v2.18.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Adding documentation for _list APIs gargharsh3134/documentation-website
2 participants
@gargharsh3134 @Naarcha-AWS