[DOCS] Count API: clarify ways to specify search query (#120564)

* Clarify query methods; other sprucing

* Apply suggestions from review
This commit is contained in:
Marci W 2025-01-22 18:05:00 -05:00 committed by GitHub
parent 0ab5d951da
commit abeb60ff1e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 11 additions and 10 deletions

View file

@ -875,7 +875,7 @@ end::search-q[]
tag::query[]
`query`::
(Optional, <<query-dsl,query object>>) Defines the search definition using the
(Optional, <<query-dsl,query object>>) Defines the search query using
<<query-dsl,Query DSL>>.
end::query[]

View file

@ -18,10 +18,6 @@ GET /my-index-000001/_count?q=user:kimchy
--------------------------------------------------
// TEST[setup:my_index]
NOTE: The query being sent in the body must be nested in a `query` key, same as
the <<search-search,search API>> works.
[[search-count-api-request]]
==== {api-request-title}
@ -39,9 +35,12 @@ or alias.
==== {api-description-title}
The count API allows you to execute a query and get the number of matches for
that query. The query can either
be provided using a simple query string as a parameter, or using the
<<query-dsl,Query DSL>> defined within the request body.
that query. You can provide the query by either:
* Including the <<search-count-api-query-params,`q` query string parameter>>
* Defining <<query-dsl,Query DSL>> within the <<search-count-request-body,request body>>
Using both returns an error.
The count API supports <<api-multi-index,multi-target syntax>>. You can run a single
count API search across multiple data streams and indices.
@ -92,6 +91,8 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=lenient]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-q]
+
NOTE: If the `q` parameter is specified, the count API does not accept a <<search-count-request-body,request body>>.
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing]
@ -140,5 +141,5 @@ Both examples above do the same: count the number of documents in
}
--------------------------------------------------
The query is optional, and when not provided, it will use `match_all` to
count all the docs.
The query is optional. When no query is provided, the API uses <<query-dsl-match-all-query,`match_all`>> to
count all the documents.