OpenSearch/docs/reference/aggregations/metrics
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
..
avg-aggregation.asciidoc Scripting: Change keys for inline/stored scripts to source/id (#25127) 2017-06-09 08:29:25 -07:00
cardinality-aggregation.asciidoc [Docs] clarification about cardinality accuracy (#34616) 2018-10-22 13:15:45 -04:00
extendedstats-aggregation.asciidoc Docs: Remove remaining references to file and native scripts (#26580) 2017-09-11 11:39:29 -07:00
geobounds-aggregation.asciidoc Make sure to use the type _doc in the REST documentation. (#34662) 2018-10-22 11:54:04 -07:00
geocentroid-aggregation.asciidoc Make sure to use the type _doc in the REST documentation. (#34662) 2018-10-22 11:54:04 -07:00
max-aggregation.asciidoc Scripting: Change keys for inline/stored scripts to source/id (#25127) 2017-06-09 08:29:25 -07:00
median-absolute-deviation-aggregation.asciidoc median absolute deviation agg (#34482) 2018-10-30 07:22:52 -07:00
min-aggregation.asciidoc [Docs] Fix typo in Min Aggregation reference (#30899) 2018-05-31 15:05:03 +02:00
percentile-aggregation.asciidoc Docs: Match the examples in the description (#31710) 2018-07-02 14:12:49 -04:00
percentile-rank-aggregation.asciidoc Docs: Fix description of percentile ranks example example (#31652) 2018-06-28 09:29:56 -04:00
scripted-metric-aggregation.asciidoc Label required scripts in Scripted Metric Agg docs (#35051) 2018-10-29 15:13:14 -06:00
stats-aggregation.asciidoc Scripting: Change keys for inline/stored scripts to source/id (#25127) 2017-06-09 08:29:25 -07:00
sum-aggregation.asciidoc Corrected aggregation name to match the example (#33786) 2018-09-17 18:24:43 -07:00
tophits-aggregation.asciidoc Make hits.total an object in the search response (#35849) 2018-12-05 19:49:06 +01:00
valuecount-aggregation.asciidoc Scripting: Change keys for inline/stored scripts to source/id (#25127) 2017-06-09 08:29:25 -07:00
weighted-avg-aggregation.asciidoc Add WeightedAvg metric aggregation (#31037) 2018-07-23 18:33:15 -04:00