Skip to content

Improved the documentation for cat indices API #136329

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+1 −1
Open

Improved the documentation for cat indices API #136329

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1131001
Improved the cat indices doc
mridula-s109 Oct 9, 2025
ffa8266
Merge branch 'main' into cat_api_doc_incorrect
mridula-s109 Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion rest-api-spec/src/main/resources/rest-api-spec/api/cat.indices.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"cat.indices": {
"documentation": {
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices",
"description": "Get index information"
"description": "Get index information. Document counts come directly from Lucene, so they include hidden nested documents (for example, those created by semantic_text fields). Use the cat count or count APIs to retrieve the top-level Elasticsearch document count."
},
"stability": "stable",
"visibility": "public",
Expand Down