Skip to content

Commit

Permalink
[DOCS] Remove _term and _time agg order keys (#78209)
Browse files Browse the repository at this point in the history
Adds an 8.0 breaking change for the removal of the `_term` and `_time`
agg `order` keys.

Relates to #39450
  • Loading branch information
jrodewig committed Sep 22, 2021
1 parent 979f297 commit 15baf40
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 2 deletions.
2 changes: 0 additions & 2 deletions docs/reference/aggregations/bucket/terms-aggregation.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -248,8 +248,6 @@ GET /_search
}
--------------------------------------------------

deprecated[6.0.0, Use `_key` instead of `_term` to order buckets by their term]

Ordering the buckets by single value metrics sub-aggregation (identified by the aggregation name):

[source,console,id=terms-aggregation-subaggregation-example]
Expand Down
26 changes: 26 additions & 0 deletions docs/reference/migration/migrate_8_0/aggregations.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,32 @@

//tag::notable-breaking-changes[]

[[remove-term-order-key]]
.The `terms` aggregation no longer supports the `_term` order key.
[%collapsible]
====
*Details* +
The `terms` aggregation no longer supports the `_term` key in `order` values. To
sort buckets by their term, use `_key` instead.
*Impact* +
Discontinue use of the `_term` order key. Requests that include a `_term` order
key will return an error.
====

[[remove-time-order-key]]
.The `date_histogram` aggregation no longer supports the `_time` order key.
[%collapsible]
====
*Details* +
The `date_histogram` aggregation no longer supports the `_time` key in `order`
values. To sort buckets by their key, use `_key` instead.
*Impact* +
Discontinue use of the `_time` order key. Requests that include a `_time` order
key will return an error.
====

[[remove-moving-avg-agg]]
.The `moving_avg` aggregation has been removed.
[%collapsible]
Expand Down

0 comments on commit 15baf40

Please sign in to comment.