OpenSearch/docs/reference/aggregations/bucket
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
..
adjacency-matrix-aggregation.asciidoc Docs - removed experimental/beta markers from adjacency matrix aggregation (#34599) 2018-10-19 09:33:59 +01:00
autodatehistogram-aggregation.asciidoc Add interval response parameter to AutoDateInterval histogram (#33254) 2018-09-05 07:35:59 -04:00
children-aggregation.asciidoc Make hits.total an object in the search response (#35849) 2018-12-05 19:49:06 +01:00
composite-aggregation.asciidoc Make sure to use the type _doc in the REST documentation. (#34662) 2018-10-22 11:54:04 -07:00
datehistogram-aggregation.asciidoc [Docs] Fix typo in datehistogram-aggregation.asciidoc (#35855) 2018-11-23 15:16:53 +01:00
daterange-aggregation.asciidoc Document and test date_range "missing" support (#28983) 2018-03-13 12:58:30 -07:00
diversified-sampler-aggregation.asciidoc Adds deprecation logging to ScriptDocValues#getValues. (#34279) 2018-11-27 14:30:13 -05:00
filter-aggregation.asciidoc Update filter-aggregation.asciidoc (#24138) 2017-04-17 18:46:13 -04:00
filters-aggregation.asciidoc filters agg docs duplicated 'bucket' word removal (#30677) 2018-05-17 15:21:50 +01:00
geodistance-aggregation.asciidoc Make sure to use the type _doc in the REST documentation. (#34662) 2018-10-22 11:54:04 -07:00
geohashgrid-aggregation.asciidoc Make sure to use the type _doc in the REST documentation. (#34662) 2018-10-22 11:54:04 -07:00
global-aggregation.asciidoc CONSOLE-ify global-aggregation.asciidoc 2017-01-20 14:36:51 -05:00
histogram-aggregation.asciidoc [DOC] Fix mathematical representation on interval (range) (#27450) 2017-11-21 17:06:26 +00:00
iprange-aggregation.asciidoc Ensure that ip_range aggregations always return bucket keys. (#30701) 2018-05-24 08:55:14 -07:00
missing-aggregation.asciidoc CONSOLEify some more aggregation docs 2017-05-16 17:25:24 -04:00
nested-aggregation.asciidoc fixing typo in nested-aggregation.asciidoc (#26481) 2017-09-04 06:42:44 +02:00
parent-aggregation.asciidoc Make hits.total an object in the search response (#35849) 2018-12-05 19:49:06 +01:00
range-aggregation.asciidoc [Docs] Convert remaining code snippets in docs (#26422) 2017-08-30 12:11:10 +02:00
reverse-nested-aggregation.asciidoc [Doc] Fixs typo in reverse-nested-aggregation.asciidoc (#28348) 2018-01-24 17:54:02 +01:00
sampler-aggregation.asciidoc Update experimental labels in the docs (#25727) 2017-07-18 14:06:22 +02:00
significantterms-aggregation.asciidoc [Docs] Remove repeating words (#33087) 2018-08-28 13:16:43 +02:00
significanttext-aggregation.asciidoc Docs - remove experimental marker from significant_text aggregation (#34598) 2018-10-19 09:32:02 +01:00
terms-aggregation.asciidoc Docs: Fix typo in field name in aggregations (#34223) 2018-10-02 10:54:29 -04:00