Clarifies that the docs.count field in the _cat/indices API includes hidden nested documents. #5492
+183 −25
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
mridula-s109 added enhancement specification documentation skip-backport 
| Following you can find the validation changes against the target branch for the APIs.
You can validate these APIs yourself by using the |
| I generated the output and confirmed that it appears in a docs preview:  |
Mikep86 approved these changes Oct 17, 2025
| }, | ||
| "docs.count": { | ||
| "description": "available docs", | ||
| "description": "The number of documents in the index, including hidden nested documents.\nFor indices with `semantic_text` fields or other nested field types,\nthis count includes the internal nested documents.\nTo get the logical document count (excluding nested documents), use\nthe `_count` API or `_cat/count` API instead.", |
There was a problem hiding this comment.
Nit: Do we want/need newlines in the JSON like this? Honest question, I don't know how they affect downstream rendering of the spec.
There was a problem hiding this comment.
This is automatic, don't think need to be concerned about this. Lisa's preview LGTM.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Summary
Clarifies that the
docs.countfield in the_cat/indicesAPI includes hidden nested documents, which can lead to higher counts than expected when using field types likesemantic_text.Changes
docs.countinCatIndicesRequest.tsto explicitly state that it includes nested documents_countor_cat/countAPIs for logical document countRelated Issues
Fixes #127354
Related PRs