OpenSearch/docs/reference/mapping/params
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
..
analyzer.asciidoc Allow `_doc` as a type. (#27816) 2017-12-14 17:47:53 +01:00
boost.asciidoc Allow `_doc` as a type. (#27816) 2017-12-14 17:47:53 +01:00
coerce.asciidoc Allow `_doc` as a type. (#27816) 2017-12-14 17:47:53 +01:00
copy-to.asciidoc Allow `_doc` as a type. (#27816) 2017-12-14 17:47:53 +01:00
doc-values.asciidoc Allow `_doc` as a type. (#27816) 2017-12-14 17:47:53 +01:00
dynamic.asciidoc Allow `_doc` as a type. (#27816) 2017-12-14 17:47:53 +01:00
eager-global-ordinals.asciidoc Allow `_doc` as a type. (#27816) 2017-12-14 17:47:53 +01:00
enabled.asciidoc Allow `_doc` as a type. (#27816) 2017-12-14 17:47:53 +01:00
fielddata.asciidoc Remove reference to multiple fields with one name (#31127) 2018-06-07 12:38:57 +01:00
format.asciidoc Remove leftover doc about format being updatable 2018-09-25 10:13:23 +02:00
ignore-above.asciidoc Remove some documentation that only makes sense with multiple types. (#35066) 2018-10-30 10:19:12 -07:00
ignore-malformed.asciidoc Add a new `_ignored` meta field. (#29658) 2018-05-02 10:47:02 +02:00
index-options.asciidoc Allow `_doc` as a type. (#27816) 2017-12-14 17:47:53 +01:00
index-phrases.asciidoc Improve docs for index_prefixes option (#35778) 2018-11-22 09:20:46 +00:00
index-prefixes.asciidoc Improve docs for index_prefixes option (#35778) 2018-11-22 09:20:46 +00:00
index.asciidoc [Docs] Clarify mapping `index` option default (#27104) 2017-10-25 12:42:29 +02:00
multi-fields.asciidoc [Docs] Delete inappropriate backtick (#35722) 2018-11-20 10:08:32 +01:00
normalizer.asciidoc Make hits.total an object in the search response (#35849) 2018-12-05 19:49:06 +01:00
norms.asciidoc Allow `_doc` as a type. (#27816) 2017-12-14 17:47:53 +01:00
null-value.asciidoc Clarify that the `null_value` option doesn't modify the `_source` document. (#28374) 2018-01-31 15:04:11 +01:00
position-increment-gap.asciidoc Allow `_doc` as a type. (#27816) 2017-12-14 17:47:53 +01:00
properties.asciidoc [Docs] Delete superfluous callouts (#31111) 2018-06-06 09:53:14 +02:00
search-analyzer.asciidoc Allow `_doc` as a type. (#27816) 2017-12-14 17:47:53 +01:00
similarity.asciidoc Improve similarity integration. (#29187) 2018-04-03 16:45:25 +02:00
store.asciidoc Allow `_doc` as a type. (#27816) 2017-12-14 17:47:53 +01:00
term-vector.asciidoc Allow `_doc` as a type. (#27816) 2017-12-14 17:47:53 +01:00