Skip to content

Commit

Permalink
[DOCS] Clarify supported parameters for terms value source (#81775) (
Browse files Browse the repository at this point in the history
…#81778)

The composite aggregation's `terms` value source doesn't support the same set of
parameters as the `terms` aggregation.

Closes #81431.
  • Loading branch information
jrodewig authored Dec 15, 2021
1 parent bd8ebbb commit 398a198
Showing 1 changed file with 10 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -122,7 +122,7 @@ The `sources` parameter can be any of the following types:
[[_terms]]
===== Terms

The `terms` value source is equivalent to a simple `terms` aggregation.
The `terms` value source is similar to a simple `terms` aggregation.
The values are extracted from a field exactly like the `terms` aggregation.

Example:
@@ -205,6 +205,13 @@ GET /_search
----
////

Although similar, the `terms` value source doesn't support the same set of
parameters as the `terms` aggregation. For other supported value source
parameters, see:

* <<_order>>
* <<_missing_bucket>>

[[_histogram]]
===== Histogram

@@ -556,6 +563,7 @@ GET /_search
}
--------------------------------------------------

[[_order]]
==== Order

By default the composite buckets are sorted by their natural ordering. Values are sorted
@@ -588,6 +596,7 @@ GET /_search
\... will sort the composite bucket in descending order when comparing values from the `date_histogram` source
and in ascending order when comparing values from the `terms` source.

[[_missing_bucket]]
==== Missing bucket

By default documents without a value for a given source are ignored.

0 comments on commit 398a198

Please sign in to comment.