Skip to content

Commit 670faa8

Browse files
authored
[DOCS] Count API: clarify ways to specify search query (elastic#120564) (elastic#120683)
* Clarify query methods; other sprucing * Apply suggestions from review
1 parent 57dc275 commit 670faa8

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

docs/reference/rest-api/common-parms.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -865,7 +865,7 @@ end::search-q[]
865865

866866
tag::query[]
867867
`query`::
868-
(Optional, <<query-dsl,query object>>) Defines the search definition using the
868+
(Optional, <<query-dsl,query object>>) Defines the search query using
869869
<<query-dsl,Query DSL>>.
870870
end::query[]
871871

docs/reference/search/count.asciidoc

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@ GET /my-index-000001/_count?q=user:kimchy
1818
--------------------------------------------------
1919
// TEST[setup:my_index]
2020

21-
NOTE: The query being sent in the body must be nested in a `query` key, same as
22-
the <<search-search,search API>> works.
23-
24-
2521
[[search-count-api-request]]
2622
==== {api-request-title}
2723

@@ -39,9 +35,12 @@ or alias.
3935
==== {api-description-title}
4036

4137
The count API allows you to execute a query and get the number of matches for
42-
that query. The query can either
43-
be provided using a simple query string as a parameter, or using the
44-
<<query-dsl,Query DSL>> defined within the request body.
38+
that query. You can provide the query by either:
39+
40+
* Including the <<search-count-api-query-params,`q` query string parameter>>
41+
* Defining <<query-dsl,Query DSL>> within the <<search-count-request-body,request body>>
42+
43+
Using both returns an error.
4544

4645
The count API supports <<api-multi-index,multi-target syntax>>. You can run a single
4746
count API search across multiple data streams and indices.
@@ -92,6 +91,8 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=lenient]
9291
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference]
9392

9493
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-q]
94+
+
95+
NOTE: If the `q` parameter is specified, the count API does not accept a <<search-count-request-body,request body>>.
9596

9697
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing]
9798

@@ -140,5 +141,5 @@ Both examples above do the same: count the number of documents in
140141
}
141142
--------------------------------------------------
142143

143-
The query is optional, and when not provided, it will use `match_all` to
144-
count all the docs.
144+
The query is optional. When no query is provided, the API uses <<query-dsl-match-all-query,`match_all`>> to
145+
count all the documents.

0 commit comments

Comments
 (0)