Skip to content

Clarifies that the docs.count field in the _cat/indices API includes hidden nested documents. #5492

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

Merged
merged 3 commits into from
Oct 21, 2025
Merged

Clarifies that the docs.count field in the _cat/indices API includes hidden nested documents. #5492

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8486801
Updated clarification to the docs
mridula-s109 Oct 15, 2025
b543006
fixed code styling
mridula-s109 Oct 15, 2025
9248072
Generate output
lcawl Oct 15, 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
6 changes: 5 additions & 1 deletion specification/cat/indices/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,11 @@ export class IndicesRecord {
'rep'?: string

/**
* available docs
* The number of documents in the index, including hidden nested documents.
* For indices with `semantic_text` fields or other nested field types,
* this count includes the internal nested documents.
* To get the logical document count (excluding nested documents), use
* the `_count` API or `_cat/count` API instead.
* @aliases dc,docsCount
*/
'docs.count'?: string | null
Expand Down