diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index 4b30ac46a52c..5db1ae10ae90 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -875,7 +875,7 @@ end::search-q[] tag::query[] `query`:: -(Optional, <>) Defines the search definition using the +(Optional, <>) Defines the search query using <>. end::query[] diff --git a/docs/reference/search/count.asciidoc b/docs/reference/search/count.asciidoc index e0e86dd13129..184069167c88 100644 --- a/docs/reference/search/count.asciidoc +++ b/docs/reference/search/count.asciidoc @@ -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 <> 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 -<> defined within the request body. +that query. You can provide the query by either: + +* Including the <> +* Defining <> within the <> + +Using both returns an error. The count API supports <>. 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 <>. 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 <> to +count all the documents.