Skip to content

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

@gargharsh3134

Description

@gargharsh3134

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

Metadata

Metadata

Assignees

Labels

In progressIssue/PR: The issue or PR is in progress.v2.18.0

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions