Add note about AggregateOrder parsing lazyness (#1777) (#1778)

elastic · Jun 30, 2022 · cda51c1 · cda51c1
1 parent ff80fef
commit cda51c1
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 7 deletions.
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/specification/_types/aggregations/bucket.ts b/specification/_types/aggregations/bucket.ts
@@ -358,6 +358,10 @@ export class TermsAggregation extends BucketAggregationBase {
   size?: integer
 }
 
+// Note: ES is very lazy when parsing this data type: it accepts any number of properties in the objects below,
+// but will only keep the *last* property in JSON document order and ignore others.
+// This means that something like `"order": { "downloads": "desc", "_key": "asc" }` will actually be interpreted
+// as `"order": [ { "_key": "asc" } ]`
 export type AggregateOrder =
   | SingleKeyDictionary<Field, SortOrder>
   | SingleKeyDictionary<Field, SortOrder>[]