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

Jump to bottom
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

merged 3 commits into from
Oct 21, 2025

Conversation

@mridula-s109
Copy link
Contributor

Summary

Clarifies that the docs.count field in the _cat/indices API includes hidden nested documents, which can lead to higher counts than expected when using field types like semantic_text.

Changes

  • Updated the documentation for docs.count in CatIndicesRequest.ts to explicitly state that it includes nested documents
  • Added guidance to use _count or _cat/count APIs for logical document count

Related Issues

Fixes #127354

Related PRs

  • elasticsearch #136329 (semantic_text documentation update)

@mridula-s109 mridula-s109 self-assigned this Oct 15, 2025
@mridula-s109 mridula-s109 added enhancement specification documentation skip-backport This pull request should not be backported labels Oct 15, 2025
@mridula-s109 mridula-s109 mentioned this pull request Oct 15, 2025
Closed
@github-actions
Copy link
Contributor

github-actions bot commented Oct 15, 2025 •
edited
Loading

Following you can find the validation changes against the target branch for the APIs.

API Status Request Response
get 🟢 317/317 → 321/321 314/314 → 318/318
index 🟢 1440/1440 → 1445/1445 1442/1442 → 1447/1447
indices.create 🔴 1373/1397 → 1378/1402 1397/1397 → 1402/1402
indices.get_mapping 🔴 198/198 → 202/202 187/198 → 191/202
search 🔴 2584/2611 → 2585/2612 2611/2611 → 2612/2612

You can validate these APIs yourself by using the make validate target.

@mridula-s109 mridula-s109 mentioned this pull request Oct 15, 2025
Closed
pquentin
pquentin approved these changes Oct 15, 2025
View reviewed changes
Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! LGTM.

@lcawl
Copy link
Contributor

lcawl commented Oct 15, 2025

I generated the output and confirmed that it appears in a docs preview:

image

lcawl
lcawl approved these changes Oct 15, 2025
View reviewed changes
Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs output LGTM

Mikep86
Mikep86 approved these changes Oct 17, 2025
View reviewed changes
Copy link

@Mikep86 Mikep86 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I left a small question about the inclusion of newlines

@mridula-s109 mridula-s109 merged commit 1fc83c0 into main Oct 21, 2025
8 checks passed
@mridula-s109 mridula-s109 deleted the cat-indices-docs-count-clarification branch October 21, 2025 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pquentin pquentin pquentin approved these changes

@lcawl lcawl lcawl approved these changes

@Mikep86 Mikep86 Mikep86 approved these changes

@leemthompo leemthompo Awaiting requested review from leemthompo

Assignees

@mridula-s109 mridula-s109

Labels

documentation enhancement skip-backport This pull request should not be backported specification

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@mridula-s109 @lcawl @pquentin @Mikep86 @leemthompo