OpenSearch/docs/reference/search/request
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
..
collapse.asciidoc [Docs] Remove repeating words (#33087) 2018-08-28 13:16:43 +02:00
docvalue-fields.asciidoc Search: Support of wildcard on docvalue_fields (#32980) 2018-08-23 10:04:00 +02:00
explain.asciidoc
from-size.asciidoc
highlighters-internal.asciidoc [DOCS] Update highlighting docs (#28802) 2018-04-18 17:41:19 -04:00
highlighting.asciidoc Make hits.total an object in the search response (#35849) 2018-12-05 19:49:06 +01:00
index-boost.asciidoc Resolve index names in indices_boost 2016-12-11 21:41:49 +09:00
inner-hits.asciidoc Make hits.total an object in the search response (#35849) 2018-12-05 19:49:06 +01:00
min-score.asciidoc
named-queries-and-filters.asciidoc Add indent 2016-05-19 09:33:29 +02:00
post-filter.asciidoc Allow `_doc` as a type. (#27816) 2017-12-14 17:47:53 +01:00
preference.asciidoc Improve docs for search preferences (#32159) 2018-07-18 12:58:17 +01:00
query.asciidoc
rescore.asciidoc [Docs] Clarify accepted sort case (#31605) 2018-07-06 10:11:36 +02:00
script-fields.asciidoc [Docs] Fix script-fields snippet execution (#30693) 2018-05-22 20:22:42 +02:00
scroll.asciidoc Added soft limit to open scroll contexts #25244 (#36009) 2018-12-03 19:57:10 +01:00
search-after.asciidoc [Docs] Clarify search_after behavior 2018-11-30 14:30:23 +01:00
search-type.asciidoc Fix a grammatical error in the 'search types' documentation. 2018-05-22 22:09:04 -07:00
sort.asciidoc Add max_children limit to nested sort (#33587) 2018-10-05 12:02:47 +02:00
source-filtering.asciidoc Fixed naming inconsistency for fields/stored_fields in the APIs (#20166) 2016-09-13 20:54:41 +02:00
stored-fields.asciidoc Remove usage of multi-types from the docs and added a page explaining type removal (#25543) 2017-07-05 12:30:19 +02:00
version.asciidoc Add CONSOLE to version docs 2016-05-18 15:32:48 +02:00