OpenSearch/docs/reference/search
Jim Ferenczi 18866c4c0b
Make hits.total an object in the search response (#35849)
This commit changes the format of the `hits.total` in the search response to be an object with
a `value` and a `relation`. The `value` indicates the number of hits that match the query and the
`relation` indicates whether the number is accurate (in which case the relation is equals to `eq`)
or a lower bound of the total (in which case it is equals to `gte`).
This change also adds a parameter called `rest_total_hits_as_int` that can be used in the
search APIs to opt out from this change (retrieve the total hits as a number in the rest response).
Note that currently all search responses are accurate (`track_total_hits: true`) or they don't contain
`hits.total` (`track_total_hits: true`). We'll add a way to get a lower bound of the total hits in a
follow up (to allow numbers to be passed to `track_total_hits`).

Relates #33028
2018-12-05 19:49:06 +01:00
..
request Make hits.total an object in the search response (#35849) 2018-12-05 19:49:06 +01:00
suggesters Make hits.total an object in the search response (#35849) 2018-12-05 19:49:06 +01:00
count.asciidoc Deprecate types in count and msearch. (#35421) 2018-11-16 13:04:43 -08:00
explain.asciidoc Update to lucene-8.0.0-snapshot-c78429a554 (#36212) 2018-12-05 12:43:56 +00:00
field-caps.asciidoc In the field capabilities API, remove support for providing fields in the request body. (#30185) 2018-04-27 16:14:11 -07:00
multi-search.asciidoc Remove references to multiple types in the search documentation. (#34625) 2018-10-19 09:47:34 -07:00
profile.asciidoc Make hits.total an object in the search response (#35849) 2018-12-05 19:49:06 +01:00
rank-eval.asciidoc Add ERR to ranking evaluation documentation (#32314) 2018-07-24 19:58:34 +02:00
request-body.asciidoc Make hits.total an object in the search response (#35849) 2018-12-05 19:49:06 +01:00
search-shards.asciidoc Default to one shard (#30539) 2018-05-14 12:22:35 -04:00
search-template.asciidoc Remove references to multiple types in the search documentation. (#34625) 2018-10-19 09:47:34 -07:00
search.asciidoc Remove references to multiple types in the search documentation. (#34625) 2018-10-19 09:47:34 -07:00
suggesters.asciidoc [Docs] Emphazise suggest behaviour with missing query part (#35393) 2018-11-28 12:01:27 +01:00
uri-request.asciidoc Make hits.total an object in the search response (#35849) 2018-12-05 19:49:06 +01:00
validate.asciidoc Deprecate types in validate query requests. (#35575) 2018-11-16 08:59:04 -08:00