From b8753396601e569d423f179aa0ed53846f77dbd8 Mon Sep 17 00:00:00 2001 From: Florian Bernd Date: Fri, 21 Jun 2024 11:06:22 +0200 Subject: [PATCH] Maintain "behavior" meta-data in specification --- compiler/src/model/build-model.ts | 5 +- compiler/src/model/metamodel.ts | 1 + compiler/src/model/utils.ts | 28 +- compiler/src/steps/validate-model.ts | 7 + docs/behaviors.md | 6 + output/schema/schema.json | 592 ++++++++++-------- .../_global/search/_types/suggester.ts | 3 + specification/_types/Errors.ts | 2 + .../_types/aggregations/Aggregate.ts | 9 +- specification/_types/common.ts | 3 + specification/_types/query_dsl/compound.ts | 9 + specification/_types/query_dsl/geo.ts | 14 +- specification/_types/query_dsl/specialized.ts | 3 + specification/_types/query_dsl/term.ts | 3 + specification/_types/sort.ts | 5 + specification/indices/_types/IndexSettings.ts | 2 + specification/indices/analyze/types.ts | 3 + .../IndicesFieldUsageStatsResponse.ts | 3 + specification/indices/shard_stores/types.ts | 3 + specification/ingest/simulate/types.ts | 2 + specification/nodes/info/types.ts | 3 + specification/watcher/_types/Conditions.ts | 3 + typescript-generator/src/metamodel.ts | 1 + 23 files changed, 453 insertions(+), 257 deletions(-) diff --git a/compiler/src/model/build-model.ts b/compiler/src/model/build-model.ts index 303499c87a..3c1a66cd0c 100644 --- a/compiler/src/model/build-model.ts +++ b/compiler/src/model/build-model.ts @@ -459,7 +459,8 @@ function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | Int properties: new Array() } - hoistTypeAnnotations(type, declaration.getJsDocs()) + const jsDocs = declaration.getJsDocs() + hoistTypeAnnotations(type, jsDocs) const variant = parseVariantNameTag(declaration.getJsDocs()) if (typeof variant === 'string') { @@ -522,7 +523,7 @@ function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | Int if (Node.isClassDeclaration(declaration)) { for (const implement of declaration.getImplements()) { if (isKnownBehavior(implement)) { - type.behaviors = (type.behaviors ?? []).concat(modelBehaviors(implement)) + type.behaviors = (type.behaviors ?? []).concat(modelBehaviors(implement, jsDocs)) } else { type.implements = (type.implements ?? []).concat(modelImplements(implement)) } diff --git a/compiler/src/model/metamodel.ts b/compiler/src/model/metamodel.ts index 05673cc6de..84d117ccc4 100644 --- a/compiler/src/model/metamodel.ts +++ b/compiler/src/model/metamodel.ts @@ -213,6 +213,7 @@ export class Container extends VariantBase { export class Inherits { type: TypeName generics?: ValueOf[] + meta?: string[] } /** diff --git a/compiler/src/model/utils.ts b/compiler/src/model/utils.ts index 01c60023ca..6bbdcee0aa 100644 --- a/compiler/src/model/utils.ts +++ b/compiler/src/model/utils.ts @@ -414,14 +414,32 @@ export function modelImplements (node: ExpressionWithTypeArguments): model.Inher * A class could have multiple behaviors from multiple classes, * which are defined inside the node typeArguments. */ -export function modelBehaviors (node: ExpressionWithTypeArguments): model.Inherits { +export function modelBehaviors (node: ExpressionWithTypeArguments, jsDocs: JSDoc[]): model.Inherits { + const behaviorName = node.getExpression().getText() const generics = node.getTypeArguments().map(node => modelType(node)) + + let meta: string[] | undefined + const tags = parseJsDocTagsAllowDuplicates(jsDocs) + if (tags.behavior_meta !== undefined) { + // Splits a string by comma, but preserves comma in quoted strings + const re = /(?<=")[^"]+?(?="(?:\s*?,|\s*?$))|(?<=(?:^|,)\s*?)(?:[^,"\s][^,"]*[^,"\s])|(?:[^,"\s])(?![^"]*?"(?:\s*?,|\s*?$))(?=\s*?(?:,|$))/g + for (const tag of tags.behavior_meta) { + const id = tag.split(' ') + if (id[0].trim() !== behaviorName) { + continue + } + meta = id.slice(1).join(' ').match(re) as string[] + break + } + } + return { type: { - name: node.getExpression().getText(), + name: behaviorName, namespace: getNameSpace(node) }, - ...(generics.length > 0 && { generics }) + ...(generics.length > 0 && { generics }), + meta } } @@ -574,7 +592,7 @@ function setTags {} ``` There are also many places where we expect only one runtime-defined property, such as in field-related queries. To capture that uniqueness constraint, we can use the `AdditionalProperty` (singular) behavior. ```ts +/** + * @behavior_meta AdditionalProperty field, bounding_box + */ class GeoBoundingBoxQuery extends QueryBase implements AdditionalProperty ``` diff --git a/output/schema/schema.json b/output/schema/schema.json index eb828d9da4..34e4e18e39 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -34778,7 +34778,7 @@ } ], "shortcutProperty": "context", - "specLocation": "_global/search/_types/suggester.ts#L232-L261" + "specLocation": "_global/search/_types/suggester.ts#L235-L264" }, { "generics": [ @@ -35083,7 +35083,7 @@ } } ], - "specLocation": "_global/search/_types/suggester.ts#L160-L178" + "specLocation": "_global/search/_types/suggester.ts#L163-L181" }, { "codegenNames": [ @@ -35098,7 +35098,7 @@ "name": "Context", "namespace": "_global.search._types" }, - "specLocation": "_global/search/_types/suggester.ts#L225-L230", + "specLocation": "_global/search/_types/suggester.ts#L228-L233", "type": { "items": [ { @@ -35266,7 +35266,7 @@ } } ], - "specLocation": "_global/search/_types/suggester.ts#L265-L328" + "specLocation": "_global/search/_types/suggester.ts#L268-L331" }, { "kind": "interface", @@ -35644,7 +35644,7 @@ } } ], - "specLocation": "_global/search/_types/suggester.ts#L106-L139", + "specLocation": "_global/search/_types/suggester.ts#L109-L142", "variants": { "kind": "container", "nonExhaustive": true @@ -36743,7 +36743,7 @@ } } ], - "specLocation": "_global/search/_types/suggester.ts#L427-L432" + "specLocation": "_global/search/_types/suggester.ts#L430-L435" }, { "kind": "interface", @@ -36827,7 +36827,7 @@ } } ], - "specLocation": "_global/search/_types/suggester.ts#L434-L438" + "specLocation": "_global/search/_types/suggester.ts#L437-L441" }, { "kind": "interface", @@ -36966,7 +36966,7 @@ } } ], - "specLocation": "_global/search/_types/suggester.ts#L330-L343" + "specLocation": "_global/search/_types/suggester.ts#L333-L346" }, { "kind": "interface", @@ -37000,7 +37000,7 @@ } } ], - "specLocation": "_global/search/_types/suggester.ts#L345-L354" + "specLocation": "_global/search/_types/suggester.ts#L348-L357" }, { "kind": "interface", @@ -37034,7 +37034,7 @@ } } ], - "specLocation": "_global/search/_types/suggester.ts#L416-L425" + "specLocation": "_global/search/_types/suggester.ts#L419-L428" }, { "kind": "interface", @@ -37265,7 +37265,7 @@ } } ], - "specLocation": "_global/search/_types/suggester.ts#L356-L414" + "specLocation": "_global/search/_types/suggester.ts#L359-L417" }, { "kind": "interface", @@ -37655,7 +37655,7 @@ } } ], - "specLocation": "_global/search/_types/suggester.ts#L180-L191" + "specLocation": "_global/search/_types/suggester.ts#L183-L194" }, { "kind": "interface", @@ -37950,7 +37950,7 @@ } } ], - "specLocation": "_global/search/_types/suggester.ts#L442-L458", + "specLocation": "_global/search/_types/suggester.ts#L445-L461", "variants": { "kind": "container" } @@ -38086,7 +38086,7 @@ "name": "StringDistance", "namespace": "_global.search._types" }, - "specLocation": "_global/search/_types/suggester.ts#L469-L490" + "specLocation": "_global/search/_types/suggester.ts#L472-L493" }, { "kind": "interface", @@ -38108,7 +38108,7 @@ } } ], - "specLocation": "_global/search/_types/suggester.ts#L460-L465" + "specLocation": "_global/search/_types/suggester.ts#L463-L468" }, { "generics": [ @@ -38280,7 +38280,7 @@ } } ], - "specLocation": "_global/search/_types/suggester.ts#L193-L221" + "specLocation": "_global/search/_types/suggester.ts#L196-L224" }, { "kind": "enum", @@ -38298,7 +38298,7 @@ "name": "SuggestSort", "namespace": "_global.search._types" }, - "specLocation": "_global/search/_types/suggester.ts#L492-L501" + "specLocation": "_global/search/_types/suggester.ts#L495-L504" }, { "attachedBehaviors": [ @@ -38322,6 +38322,10 @@ } } ], + "meta": [ + "suggesters", + "The named suggesters" + ], "type": { "name": "AdditionalProperties", "namespace": "_spec_utils" @@ -38347,7 +38351,7 @@ } } ], - "specLocation": "_global/search/_types/suggester.ts#L101-L104" + "specLocation": "_global/search/_types/suggester.ts#L101-L107" }, { "kind": "interface", @@ -38393,7 +38397,7 @@ } } ], - "specLocation": "_global/search/_types/suggester.ts#L141-L156" + "specLocation": "_global/search/_types/suggester.ts#L144-L159" }, { "inherits": { @@ -38667,7 +38671,7 @@ } } ], - "specLocation": "_global/search/_types/suggester.ts#L503-L565" + "specLocation": "_global/search/_types/suggester.ts#L506-L568" }, { "kind": "interface", @@ -42261,7 +42265,7 @@ } } ], - "specLocation": "_types/Errors.ts#L58-L64" + "specLocation": "_types/Errors.ts#L60-L66" }, { "kind": "interface", @@ -42594,7 +42598,7 @@ "name": "ClusterInfoTarget", "namespace": "_types" }, - "specLocation": "_types/common.ts#L378-L384" + "specLocation": "_types/common.ts#L381-L387" }, { "kind": "type_alias", @@ -42602,7 +42606,7 @@ "name": "ClusterInfoTargets", "namespace": "_types" }, - "specLocation": "_types/common.ts#L386-L386", + "specLocation": "_types/common.ts#L389-L389", "type": { "items": [ { @@ -43438,6 +43442,10 @@ "kind": "user_defined_value" } ], + "meta": [ + "metadata", + "Additional details about the error" + ], "type": { "name": "AdditionalProperties", "namespace": "_spec_utils" @@ -43527,7 +43535,7 @@ } } ], - "specLocation": "_types/Errors.ts#L25-L48" + "specLocation": "_types/Errors.ts#L25-L50" }, { "description": "The response returned by Elasticsearch when request execution did not succeed.", @@ -44159,6 +44167,10 @@ "kind": "union_of" } ], + "meta": [ + "field", + "location" + ], "type": { "name": "AdditionalProperty", "namespace": "_spec_utils" @@ -44227,7 +44239,7 @@ } } ], - "specLocation": "_types/sort.ts#L58-L66" + "specLocation": "_types/sort.ts#L59-L70" }, { "kind": "enum", @@ -45168,7 +45180,7 @@ } } ], - "specLocation": "_types/common.ts#L332-L359" + "specLocation": "_types/common.ts#L335-L362" }, { "inherits": { @@ -45215,6 +45227,10 @@ "kind": "user_defined_value" } ], + "meta": [ + "metadata", + "Document metadata" + ], "type": { "name": "AdditionalProperties", "namespace": "_spec_utils" @@ -45307,7 +45323,7 @@ } } ], - "specLocation": "_types/common.ts#L321-L330" + "specLocation": "_types/common.ts#L320-L333" }, { "inherits": { @@ -47905,7 +47921,7 @@ } } ], - "specLocation": "_types/sort.ts#L68-L74" + "specLocation": "_types/sort.ts#L72-L78" }, { "kind": "enum", @@ -47924,7 +47940,7 @@ "name": "ScriptSortType", "namespace": "_types" }, - "specLocation": "_types/sort.ts#L76-L80" + "specLocation": "_types/sort.ts#L80-L84" }, { "kind": "interface", @@ -48738,7 +48754,7 @@ } } ], - "specLocation": "_types/Errors.ts#L50-L56" + "specLocation": "_types/Errors.ts#L52-L58" }, { "kind": "interface", @@ -48885,7 +48901,7 @@ "name": "Slices", "namespace": "_types" }, - "specLocation": "_types/common.ts#L361-L366", + "specLocation": "_types/common.ts#L364-L369", "type": { "items": [ { @@ -48918,7 +48934,7 @@ "name": "SlicesCalculation", "namespace": "_types" }, - "specLocation": "_types/common.ts#L368-L376" + "specLocation": "_types/common.ts#L371-L379" }, { "kind": "type_alias", @@ -48926,7 +48942,7 @@ "name": "Sort", "namespace": "_types" }, - "specLocation": "_types/sort.ts#L99-L99", + "specLocation": "_types/sort.ts#L104-L104", "type": { "items": [ { @@ -48960,7 +48976,7 @@ "name": "SortCombinations", "namespace": "_types" }, - "specLocation": "_types/sort.ts#L93-L97", + "specLocation": "_types/sort.ts#L98-L102", "type": { "items": [ { @@ -49004,7 +49020,7 @@ "name": "SortMode", "namespace": "_types" }, - "specLocation": "_types/sort.ts#L103-L112" + "specLocation": "_types/sort.ts#L108-L117" }, { "attachedBehaviors": [ @@ -49028,6 +49044,10 @@ } } ], + "meta": [ + "field", + "sort" + ], "type": { "name": "AdditionalProperty", "namespace": "_spec_utils" @@ -49087,7 +49107,7 @@ } } ], - "specLocation": "_types/sort.ts#L82-L91", + "specLocation": "_types/sort.ts#L86-L96", "variants": { "kind": "container" } @@ -49108,7 +49128,7 @@ "name": "SortOrder", "namespace": "_types" }, - "specLocation": "_types/sort.ts#L114-L123" + "specLocation": "_types/sort.ts#L119-L128" }, { "kind": "type_alias", @@ -49116,7 +49136,7 @@ "name": "SortResults", "namespace": "_types" }, - "specLocation": "_types/sort.ts#L101-L101", + "specLocation": "_types/sort.ts#L106-L106", "type": { "kind": "array_of", "value": { @@ -49472,7 +49492,7 @@ } } ], - "specLocation": "_types/Errors.ts#L66-L71" + "specLocation": "_types/Errors.ts#L68-L73" }, { "kind": "type_alias", @@ -50390,7 +50410,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L573-L575", + "specLocation": "_types/aggregations/Aggregate.ts#L577-L579", "variantName": "adjacency_matrix" }, { @@ -50472,7 +50492,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L577-L579" + "specLocation": "_types/aggregations/Aggregate.ts#L581-L583" }, { "kind": "type_alias", @@ -52327,7 +52347,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L356-L360", + "specLocation": "_types/aggregations/Aggregate.ts#L358-L362", "variantName": "auto_date_histogram" }, { @@ -52674,7 +52694,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L706-L722", + "specLocation": "_types/aggregations/Aggregate.ts#L713-L729", "variantName": "boxplot" }, { @@ -53590,7 +53610,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L776-L777", + "specLocation": "_types/aggregations/Aggregate.ts#L783-L784", "variantName": "children" }, { @@ -53655,7 +53675,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L618-L623", + "specLocation": "_types/aggregations/Aggregate.ts#L622-L627", "variantName": "composite" }, { @@ -53915,7 +53935,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L625-L627" + "specLocation": "_types/aggregations/Aggregate.ts#L629-L631" }, { "inherits": { @@ -54107,7 +54127,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L747-L755", + "specLocation": "_types/aggregations/Aggregate.ts#L754-L762", "variantName": "simple_long_value" }, { @@ -54211,7 +54231,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L348-L349", + "specLocation": "_types/aggregations/Aggregate.ts#L350-L351", "variantName": "date_histogram" }, { @@ -54484,7 +54504,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L351-L354" + "specLocation": "_types/aggregations/Aggregate.ts#L353-L356" }, { "description": "Result of a `date_range` aggregation. Same format as a for a `range` aggregation: `from` and `to`\nin `buckets` are milliseconds since the Epoch, represented as a floating point number.", @@ -54500,7 +54520,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L543-L548", + "specLocation": "_types/aggregations/Aggregate.ts#L547-L552", "variantName": "date_range" }, { @@ -54795,7 +54815,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L411-L416", + "specLocation": "_types/aggregations/Aggregate.ts#L413-L418", "variantName": "dterms" }, { @@ -54837,7 +54857,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L418-L421" + "specLocation": "_types/aggregations/Aggregate.ts#L420-L423" }, { "kind": "interface", @@ -55310,7 +55330,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L495-L496", + "specLocation": "_types/aggregations/Aggregate.ts#L499-L500", "variantName": "filter" }, { @@ -55335,7 +55355,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L568-L569", + "specLocation": "_types/aggregations/Aggregate.ts#L572-L573", "variantName": "filters" }, { @@ -55429,7 +55449,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L571-L571" + "specLocation": "_types/aggregations/Aggregate.ts#L575-L575" }, { "inherits": { @@ -55507,7 +55527,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L639-L640", + "specLocation": "_types/aggregations/Aggregate.ts#L643-L644", "variantName": "frequent_item_sets" }, { @@ -55639,7 +55659,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L642-L645" + "specLocation": "_types/aggregations/Aggregate.ts#L646-L649" }, { "kind": "interface", @@ -55856,7 +55876,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L550-L554", + "specLocation": "_types/aggregations/Aggregate.ts#L554-L558", "variantName": "geo_distance" }, { @@ -55962,7 +55982,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L506-L508", + "specLocation": "_types/aggregations/Aggregate.ts#L510-L512", "variantName": "geohash_grid" }, { @@ -56071,7 +56091,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L510-L512" + "specLocation": "_types/aggregations/Aggregate.ts#L514-L516" }, { "inherits": { @@ -56095,7 +56115,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L522-L523", + "specLocation": "_types/aggregations/Aggregate.ts#L526-L527", "variantName": "geohex_grid" }, { @@ -56126,7 +56146,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L525-L527" + "specLocation": "_types/aggregations/Aggregate.ts#L529-L531" }, { "inherits": { @@ -56171,7 +56191,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L784-L791", + "specLocation": "_types/aggregations/Aggregate.ts#L791-L798", "variantName": "geo_line" }, { @@ -56312,7 +56332,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L514-L516", + "specLocation": "_types/aggregations/Aggregate.ts#L518-L520", "variantName": "geotile_grid" }, { @@ -56421,7 +56441,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L518-L520" + "specLocation": "_types/aggregations/Aggregate.ts#L522-L524" }, { "inherits": { @@ -56517,7 +56537,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L492-L493", + "specLocation": "_types/aggregations/Aggregate.ts#L496-L497", "variantName": "global" }, { @@ -56633,7 +56653,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L340-L341", + "specLocation": "_types/aggregations/Aggregate.ts#L342-L343", "variantName": "histogram" }, { @@ -56840,7 +56860,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L343-L346" + "specLocation": "_types/aggregations/Aggregate.ts#L345-L348" }, { "kind": "interface", @@ -57056,6 +57076,10 @@ "kind": "user_defined_value" } ], + "meta": [ + "data", + "Additional data" + ], "type": { "name": "AdditionalProperties", "namespace": "_spec_utils" @@ -57125,7 +57149,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L659-L670", + "specLocation": "_types/aggregations/Aggregate.ts#L663-L677", "variantName": "inference" }, { @@ -57198,7 +57222,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L684-L687" + "specLocation": "_types/aggregations/Aggregate.ts#L691-L694" }, { "kind": "interface", @@ -57281,7 +57305,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L678-L682" + "specLocation": "_types/aggregations/Aggregate.ts#L685-L689" }, { "kind": "interface", @@ -57324,7 +57348,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L672-L676" + "specLocation": "_types/aggregations/Aggregate.ts#L679-L683" }, { "inherits": { @@ -57348,7 +57372,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L629-L630", + "specLocation": "_types/aggregations/Aggregate.ts#L633-L634", "variantName": "ip_prefix" }, { @@ -57503,7 +57527,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L632-L637" + "specLocation": "_types/aggregations/Aggregate.ts#L636-L641" }, { "inherits": { @@ -57527,7 +57551,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L556-L558", + "specLocation": "_types/aggregations/Aggregate.ts#L560-L562", "variantName": "ip_range" }, { @@ -57693,7 +57717,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L560-L564" + "specLocation": "_types/aggregations/Aggregate.ts#L564-L568" }, { "kind": "type_alias", @@ -57798,7 +57822,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L431-L436", + "specLocation": "_types/aggregations/Aggregate.ts#L433-L438", "variantName": "lrareterms" }, { @@ -57840,7 +57864,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L438-L441" + "specLocation": "_types/aggregations/Aggregate.ts#L440-L443" }, { "description": "Result of a `terms` aggregation when the field is some kind of whole number like a integer, long, or a date.", @@ -57865,7 +57889,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L399-L404", + "specLocation": "_types/aggregations/Aggregate.ts#L401-L406", "variantName": "lterms" }, { @@ -57907,7 +57931,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L406-L409" + "specLocation": "_types/aggregations/Aggregate.ts#L408-L411" }, { "inherits": { @@ -57999,7 +58023,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L757-L761", + "specLocation": "_types/aggregations/Aggregate.ts#L764-L768", "variantName": "matrix_stats" }, { @@ -58149,7 +58173,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L763-L772" + "specLocation": "_types/aggregations/Aggregate.ts#L770-L779" }, { "inherits": { @@ -58418,7 +58442,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L483-L484", + "specLocation": "_types/aggregations/Aggregate.ts#L487-L488", "variantName": "missing" }, { @@ -58749,6 +58773,10 @@ } } ], + "meta": [ + "aggregations", + "Nested aggregations" + ], "type": { "name": "AdditionalProperties", "namespace": "_spec_utils" @@ -58774,7 +58802,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L331-L338" + "specLocation": "_types/aggregations/Aggregate.ts#L331-L340" }, { "kind": "interface", @@ -58832,7 +58860,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L461-L463", + "specLocation": "_types/aggregations/Aggregate.ts#L463-L465", "variantName": "multi_terms" }, { @@ -59008,7 +59036,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L465-L469" + "specLocation": "_types/aggregations/Aggregate.ts#L467-L471" }, { "kind": "interface", @@ -59060,7 +59088,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L486-L487", + "specLocation": "_types/aggregations/Aggregate.ts#L490-L491", "variantName": "nested" }, { @@ -59170,7 +59198,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L779-L780", + "specLocation": "_types/aggregations/Aggregate.ts#L786-L787", "variantName": "parent" }, { @@ -59531,7 +59559,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L531-L532", + "specLocation": "_types/aggregations/Aggregate.ts#L535-L536", "variantName": "range" }, { @@ -59696,7 +59724,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L534-L541" + "specLocation": "_types/aggregations/Aggregate.ts#L538-L545" }, { "inherits": { @@ -59835,7 +59863,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L741-L745", + "specLocation": "_types/aggregations/Aggregate.ts#L748-L752", "variantName": "rate" }, { @@ -59913,7 +59941,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L489-L490", + "specLocation": "_types/aggregations/Aggregate.ts#L493-L494", "variantName": "reverse_nested" }, { @@ -59960,7 +59988,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L498-L499", + "specLocation": "_types/aggregations/Aggregate.ts#L502-L503", "variantName": "sampler" }, { @@ -60056,7 +60084,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L649-L652", + "specLocation": "_types/aggregations/Aggregate.ts#L653-L656", "variantName": "scripted_metric" }, { @@ -60192,7 +60220,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L588-L590", + "specLocation": "_types/aggregations/Aggregate.ts#L592-L594", "variantName": "siglterms" }, { @@ -60234,7 +60262,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L597-L600" + "specLocation": "_types/aggregations/Aggregate.ts#L601-L604" }, { "inherits": { @@ -60258,7 +60286,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L602-L604", + "specLocation": "_types/aggregations/Aggregate.ts#L606-L608", "variantName": "sigsterms" }, { @@ -60289,7 +60317,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L606-L608" + "specLocation": "_types/aggregations/Aggregate.ts#L610-L612" }, { "generics": [ @@ -60342,7 +60370,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L581-L586" + "specLocation": "_types/aggregations/Aggregate.ts#L585-L590" }, { "inherits": { @@ -60580,7 +60608,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L592-L595" + "specLocation": "_types/aggregations/Aggregate.ts#L596-L599" }, { "inherits": { @@ -60876,6 +60904,10 @@ } } ], + "meta": [ + "aggregations", + "Nested aggregations" + ], "type": { "name": "AdditionalProperties", "namespace": "_spec_utils" @@ -60907,7 +60939,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L473-L481" + "specLocation": "_types/aggregations/Aggregate.ts#L475-L485" }, { "inherits": { @@ -61406,7 +61438,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L443-L447", + "specLocation": "_types/aggregations/Aggregate.ts#L445-L449", "variantName": "srareterms" }, { @@ -61437,7 +61469,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L449-L451" + "specLocation": "_types/aggregations/Aggregate.ts#L451-L453" }, { "inherits": { @@ -61623,7 +61655,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L693-L704", + "specLocation": "_types/aggregations/Aggregate.ts#L700-L711", "variantName": "string_stats" }, { @@ -61678,7 +61710,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L384-L389", + "specLocation": "_types/aggregations/Aggregate.ts#L386-L391", "variantName": "sterms" }, { @@ -61709,7 +61741,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L395-L397" + "specLocation": "_types/aggregations/Aggregate.ts#L397-L399" }, { "description": "Sum aggregation result. `value` is always present and is zero if there were no values to process.", @@ -61860,7 +61892,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L735-L739", + "specLocation": "_types/aggregations/Aggregate.ts#L742-L746", "variantName": "t_test" }, { @@ -61989,7 +62021,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L377-L382" + "specLocation": "_types/aggregations/Aggregate.ts#L379-L384" }, { "inherits": { @@ -62277,7 +62309,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L391-L393" + "specLocation": "_types/aggregations/Aggregate.ts#L393-L395" }, { "codegenNames": [ @@ -62464,7 +62496,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L654-L657", + "specLocation": "_types/aggregations/Aggregate.ts#L658-L661", "variantName": "top_hits" }, { @@ -62729,7 +62761,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L729-L733" + "specLocation": "_types/aggregations/Aggregate.ts#L736-L740" }, { "inherits": { @@ -62759,7 +62791,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L724-L727", + "specLocation": "_types/aggregations/Aggregate.ts#L731-L734", "variantName": "top_metrics" }, { @@ -62875,7 +62907,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L453-L459", + "specLocation": "_types/aggregations/Aggregate.ts#L455-L461", "variantName": "umrareterms" }, { @@ -62894,7 +62926,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L501-L502", + "specLocation": "_types/aggregations/Aggregate.ts#L505-L506", "variantName": "unmapped_sampler" }, { @@ -62920,7 +62952,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L610-L616", + "specLocation": "_types/aggregations/Aggregate.ts#L614-L620", "variantName": "umsigterms" }, { @@ -62946,7 +62978,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L423-L429", + "specLocation": "_types/aggregations/Aggregate.ts#L425-L431", "variantName": "umterms" }, { @@ -63043,7 +63075,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L362-L364", + "specLocation": "_types/aggregations/Aggregate.ts#L364-L366", "variantName": "variable_width_histogram" }, { @@ -63199,7 +63231,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L366-L373" + "specLocation": "_types/aggregations/Aggregate.ts#L368-L375" }, { "inherits": { @@ -75230,6 +75262,10 @@ } } ], + "meta": [ + "field", + "placement" + ], "type": { "name": "AdditionalProperty", "namespace": "_spec_utils" @@ -75248,7 +75284,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/compound.ts#L186-L188" + "specLocation": "_types/query_dsl/compound.ts#L189-L194" }, { "inherits": { @@ -75426,7 +75462,7 @@ "name": "DecayFunction", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/compound.ts#L194-L199", + "specLocation": "_types/query_dsl/compound.ts#L203-L208", "type": { "items": [ { @@ -75865,7 +75901,7 @@ "name": "FieldValueFactorModifier", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/compound.ts#L298-L341" + "specLocation": "_types/query_dsl/compound.ts#L307-L350" }, { "kind": "interface", @@ -75958,7 +75994,7 @@ "name": "FunctionBoostMode", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/compound.ts#L270-L296" + "specLocation": "_types/query_dsl/compound.ts#L279-L305" }, { "esQuirk": "this container is valid without a variant. Despite being documented as a function, 'weight'\nis actually a container property that can be combined with a function. Comment in the ES code\n(SearchModule#registerScoreFunctions) says: Weight doesn't have its own parser, so every function\nsupports it out of the box. Can be a single function too when not associated to any other function,\nwhich is why it needs to be registered manually here.", @@ -76065,7 +76101,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L201-L241", + "specLocation": "_types/query_dsl/compound.ts#L210-L250", "variants": { "kind": "container" } @@ -76102,7 +76138,7 @@ "name": "FunctionScoreMode", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/compound.ts#L243-L268" + "specLocation": "_types/query_dsl/compound.ts#L252-L277" }, { "inherits": { @@ -76335,6 +76371,10 @@ } } ], + "meta": [ + "field", + "bounding_box" + ], "type": { "name": "AdditionalProperty", "namespace": "_spec_utils" @@ -76395,7 +76435,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L32-L50" + "specLocation": "_types/query_dsl/geo.ts#L32-L53" }, { "attachedBehaviors": [ @@ -76435,6 +76475,10 @@ } } ], + "meta": [ + "field", + "placement" + ], "type": { "name": "AdditionalProperty", "namespace": "_spec_utils" @@ -76453,7 +76497,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/compound.ts#L190-L192" + "specLocation": "_types/query_dsl/compound.ts#L196-L201" }, { "inherits": { @@ -76508,6 +76552,10 @@ } } ], + "meta": [ + "field", + "location" + ], "type": { "name": "AdditionalProperty", "namespace": "_spec_utils" @@ -76580,7 +76628,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L57-L85" + "specLocation": "_types/query_dsl/geo.ts#L60-L91" }, { "kind": "enum", @@ -76596,7 +76644,7 @@ "name": "GeoExecution", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/geo.ts#L52-L55" + "specLocation": "_types/query_dsl/geo.ts#L55-L58" }, { "kind": "interface", @@ -76620,7 +76668,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L87-L89" + "specLocation": "_types/query_dsl/geo.ts#L93-L95" }, { "attachedBehaviors": [ @@ -76644,6 +76692,10 @@ } } ], + "meta": [ + "field", + "polygon" + ], "type": { "name": "AdditionalProperty", "namespace": "_spec_utils" @@ -76690,7 +76742,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L91-L99" + "specLocation": "_types/query_dsl/geo.ts#L97-L108" }, { "kind": "interface", @@ -76736,7 +76788,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L106-L117" + "specLocation": "_types/query_dsl/geo.ts#L115-L126" }, { "attachedBehaviors": [ @@ -76760,6 +76812,10 @@ } } ], + "meta": [ + "field", + "shape" + ], "type": { "name": "AdditionalProperty", "namespace": "_spec_utils" @@ -76792,7 +76848,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L121-L131" + "specLocation": "_types/query_dsl/geo.ts#L128-L143" }, { "kind": "enum", @@ -76813,7 +76869,7 @@ "name": "GeoValidationMethod", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/geo.ts#L147-L157" + "specLocation": "_types/query_dsl/geo.ts#L159-L169" }, { "inherits": { @@ -78908,7 +78964,7 @@ "name": "MultiValueMode", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/compound.ts#L343-L360" + "specLocation": "_types/query_dsl/compound.ts#L352-L369" }, { "inherits": { @@ -79138,6 +79194,10 @@ } } ], + "meta": [ + "field", + "placement" + ], "type": { "name": "AdditionalProperty", "namespace": "_spec_utils" @@ -79156,7 +79216,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/compound.ts#L182-L184" + "specLocation": "_types/query_dsl/compound.ts#L182-L187" }, { "kind": "enum", @@ -81391,7 +81451,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L369-L373" + "specLocation": "_types/query_dsl/specialized.ts#L372-L376" }, { "inherits": { @@ -81579,7 +81639,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L354-L367" + "specLocation": "_types/query_dsl/specialized.ts#L357-L370" }, { "attachedBehaviors": [ @@ -81603,6 +81663,10 @@ } } ], + "meta": [ + "field", + "shape" + ], "type": { "name": "AdditionalProperty", "namespace": "_spec_utils" @@ -81634,7 +81698,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L344-L352" + "specLocation": "_types/query_dsl/specialized.ts#L342-L355" }, { "kind": "enum", @@ -82561,7 +82625,7 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L263-L268" + "specLocation": "_types/query_dsl/term.ts#L266-L271" }, { "attachedBehaviors": [ @@ -82585,6 +82649,10 @@ } } ], + "meta": [ + "field", + "term" + ], "type": { "name": "AdditionalProperty", "namespace": "_spec_utils" @@ -82603,7 +82671,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/term.ts#L254-L256" + "specLocation": "_types/query_dsl/term.ts#L254-L259" }, { "codegenNames": [ @@ -82615,7 +82683,7 @@ "name": "TermsQueryField", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/term.ts#L258-L261", + "specLocation": "_types/query_dsl/term.ts#L261-L264", "type": { "items": [ { @@ -82802,7 +82870,7 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L270-L283" + "specLocation": "_types/query_dsl/term.ts#L273-L286" }, { "inherits": { @@ -82975,7 +83043,7 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L285-L287" + "specLocation": "_types/query_dsl/term.ts#L288-L290" }, { "inherits": { @@ -83100,7 +83168,7 @@ } ], "shortcutProperty": "value", - "specLocation": "_types/query_dsl/term.ts#L289-L306" + "specLocation": "_types/query_dsl/term.ts#L292-L309" }, { "inherits": { @@ -118062,7 +118130,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L405-L407" + "specLocation": "indices/_types/IndexSettings.ts#L407-L409" }, { "kind": "interface", @@ -118732,7 +118800,7 @@ "name": "IndexCheckOnStartup", "namespace": "indices._types" }, - "specLocation": "indices/_types/IndexSettings.ts#L260-L267" + "specLocation": "indices/_types/IndexSettings.ts#L262-L269" }, { "kind": "interface", @@ -119178,7 +119246,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L252-L258" + "specLocation": "indices/_types/IndexSettings.ts#L254-L260" }, { "attachedBehaviors": [ @@ -119198,6 +119266,10 @@ "kind": "user_defined_value" } ], + "meta": [ + "other_settings", + "." + ], "type": { "name": "AdditionalProperties", "namespace": "_spec_utils" @@ -119980,7 +120052,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L69-L167" + "specLocation": "indices/_types/IndexSettings.ts#L69-L169" }, { "kind": "interface", @@ -120100,7 +120172,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L317-L323" + "specLocation": "indices/_types/IndexSettings.ts#L319-L325" }, { "kind": "interface", @@ -120193,7 +120265,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L274-L307" + "specLocation": "indices/_types/IndexSettings.ts#L276-L309" }, { "kind": "interface", @@ -120215,7 +120287,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L309-L315" + "specLocation": "indices/_types/IndexSettings.ts#L311-L317" }, { "kind": "interface", @@ -120247,7 +120319,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L325-L328" + "specLocation": "indices/_types/IndexSettings.ts#L327-L330" }, { "kind": "interface", @@ -120604,7 +120676,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L269-L272" + "specLocation": "indices/_types/IndexSettings.ts#L271-L274" }, { "kind": "interface", @@ -120625,7 +120697,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L539-L541" + "specLocation": "indices/_types/IndexSettings.ts#L541-L543" }, { "kind": "interface", @@ -120647,7 +120719,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L543-L550" + "specLocation": "indices/_types/IndexSettings.ts#L545-L552" }, { "kind": "interface", @@ -120701,7 +120773,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L552-L557" + "specLocation": "indices/_types/IndexSettings.ts#L554-L559" }, { "kind": "interface", @@ -120725,7 +120797,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L559-L566" + "specLocation": "indices/_types/IndexSettings.ts#L561-L568" }, { "kind": "enum", @@ -120848,7 +120920,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L409-L422" + "specLocation": "indices/_types/IndexSettings.ts#L411-L424" }, { "kind": "interface", @@ -120871,7 +120943,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L434-L441" + "specLocation": "indices/_types/IndexSettings.ts#L436-L443" }, { "kind": "interface", @@ -120893,7 +120965,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L471-L477" + "specLocation": "indices/_types/IndexSettings.ts#L473-L479" }, { "kind": "interface", @@ -120915,7 +120987,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L462-L469" + "specLocation": "indices/_types/IndexSettings.ts#L464-L471" }, { "kind": "interface", @@ -120938,7 +121010,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L443-L451" + "specLocation": "indices/_types/IndexSettings.ts#L445-L453" }, { "kind": "interface", @@ -120961,7 +121033,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L453-L460" + "specLocation": "indices/_types/IndexSettings.ts#L455-L462" }, { "kind": "interface", @@ -120984,7 +121056,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L424-L432" + "specLocation": "indices/_types/IndexSettings.ts#L426-L434" }, { "kind": "interface", @@ -121005,7 +121077,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L330-L332" + "specLocation": "indices/_types/IndexSettings.ts#L332-L334" }, { "kind": "interface", @@ -121055,7 +121127,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L334-L337" + "specLocation": "indices/_types/IndexSettings.ts#L336-L339" }, { "kind": "interface", @@ -121113,7 +121185,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L401-L403" + "specLocation": "indices/_types/IndexSettings.ts#L403-L405" }, { "kind": "interface", @@ -121156,7 +121228,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L243-L246" + "specLocation": "indices/_types/IndexSettings.ts#L245-L248" }, { "kind": "enum", @@ -121249,7 +121321,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L233-L236" + "specLocation": "indices/_types/IndexSettings.ts#L235-L238" }, { "kind": "interface", @@ -121271,7 +121343,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L228-L231" + "specLocation": "indices/_types/IndexSettings.ts#L230-L233" }, { "kind": "interface", @@ -121301,7 +121373,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L248-L250" + "specLocation": "indices/_types/IndexSettings.ts#L250-L252" }, { "kind": "interface", @@ -121333,7 +121405,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L238-L241" + "specLocation": "indices/_types/IndexSettings.ts#L240-L243" }, { "kind": "type_alias", @@ -121341,7 +121413,7 @@ "name": "SettingsSimilarity", "namespace": "indices._types" }, - "specLocation": "indices/_types/IndexSettings.ts#L169-L180", + "specLocation": "indices/_types/IndexSettings.ts#L171-L182", "type": { "items": [ { @@ -121457,7 +121529,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L186-L191" + "specLocation": "indices/_types/IndexSettings.ts#L188-L193" }, { "kind": "interface", @@ -121475,7 +121547,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L182-L184" + "specLocation": "indices/_types/IndexSettings.ts#L184-L186" }, { "kind": "interface", @@ -121504,7 +121576,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L193-L196" + "specLocation": "indices/_types/IndexSettings.ts#L195-L198" }, { "kind": "interface", @@ -121555,7 +121627,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L198-L203" + "specLocation": "indices/_types/IndexSettings.ts#L200-L205" }, { "kind": "interface", @@ -121606,7 +121678,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L205-L210" + "specLocation": "indices/_types/IndexSettings.ts#L207-L212" }, { "kind": "interface", @@ -121635,7 +121707,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L212-L215" + "specLocation": "indices/_types/IndexSettings.ts#L214-L217" }, { "kind": "interface", @@ -121664,7 +121736,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L217-L220" + "specLocation": "indices/_types/IndexSettings.ts#L219-L222" }, { "kind": "interface", @@ -121704,7 +121776,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L222-L226" + "specLocation": "indices/_types/IndexSettings.ts#L224-L228" }, { "kind": "interface", @@ -121758,7 +121830,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L479-L484" + "specLocation": "indices/_types/IndexSettings.ts#L481-L486" }, { "kind": "interface", @@ -121812,7 +121884,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L491-L496" + "specLocation": "indices/_types/IndexSettings.ts#L493-L498" }, { "kind": "interface", @@ -121844,7 +121916,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L486-L489" + "specLocation": "indices/_types/IndexSettings.ts#L488-L491" }, { "kind": "interface", @@ -121912,7 +121984,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L498-L507" + "specLocation": "indices/_types/IndexSettings.ts#L500-L509" }, { "isOpen": true, @@ -121939,7 +122011,7 @@ "name": "StorageType", "namespace": "indices._types" }, - "specLocation": "indices/_types/IndexSettings.ts#L509-L537" + "specLocation": "indices/_types/IndexSettings.ts#L511-L539" }, { "kind": "interface", @@ -122096,7 +122168,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L339-L361" + "specLocation": "indices/_types/IndexSettings.ts#L341-L363" }, { "kind": "enum", @@ -122120,7 +122192,7 @@ "name": "TranslogDurability", "namespace": "indices._types" }, - "specLocation": "indices/_types/IndexSettings.ts#L363-L378" + "specLocation": "indices/_types/IndexSettings.ts#L365-L380" }, { "kind": "interface", @@ -122156,7 +122228,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L380-L399" + "specLocation": "indices/_types/IndexSettings.ts#L382-L401" }, { "kind": "enum", @@ -122605,6 +122677,10 @@ "kind": "user_defined_value" } ], + "meta": [ + "attributes", + "Additional tokenizer-specific attributes" + ], "type": { "name": "AdditionalProperties", "namespace": "_spec_utils" @@ -122717,7 +122793,7 @@ } } ], - "specLocation": "indices/analyze/types.ts#L52-L64" + "specLocation": "indices/analyze/types.ts#L52-L67" }, { "attachedBehaviors": [ @@ -122931,7 +123007,7 @@ "name": "TextToAnalyze", "namespace": "indices.analyze" }, - "specLocation": "indices/analyze/types.ts#L66-L66", + "specLocation": "indices/analyze/types.ts#L69-L69", "type": { "items": [ { @@ -122988,7 +123064,7 @@ } } ], - "specLocation": "indices/analyze/types.ts#L68-L71" + "specLocation": "indices/analyze/types.ts#L71-L74" }, { "attachedBehaviors": [ @@ -125419,7 +125495,7 @@ } } ], - "specLocation": "indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L54-L63" + "specLocation": "indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L57-L66" }, { "attachedBehaviors": [ @@ -125443,6 +125519,10 @@ } } ], + "meta": [ + "stats", + "Per index statistics" + ], "type": { "name": "AdditionalProperties", "namespace": "_spec_utils" @@ -125467,7 +125547,7 @@ } } ], - "specLocation": "indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L32-L36" + "specLocation": "indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L32-L39" }, { "kind": "interface", @@ -125554,7 +125634,7 @@ } } ], - "specLocation": "indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L65-L73" + "specLocation": "indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L68-L76" }, { "attachedBehaviors": [ @@ -125740,7 +125820,7 @@ } } ], - "specLocation": "indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L49-L52" + "specLocation": "indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L52-L55" }, { "kind": "interface", @@ -125764,7 +125844,7 @@ } } ], - "specLocation": "indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L38-L40" + "specLocation": "indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L41-L43" }, { "kind": "interface", @@ -125827,7 +125907,7 @@ } } ], - "specLocation": "indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L42-L47" + "specLocation": "indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L45-L50" }, { "attachedBehaviors": [ @@ -131974,6 +132054,10 @@ } } ], + "meta": [ + "node_id", + "node" + ], "type": { "name": "AdditionalProperty", "namespace": "_spec_utils" @@ -132020,7 +132104,7 @@ } } ], - "specLocation": "indices/shard_stores/types.ts#L30-L34" + "specLocation": "indices/shard_stores/types.ts#L30-L37" }, { "kind": "enum", @@ -132039,7 +132123,7 @@ "name": "ShardStoreAllocation", "namespace": "indices.shard_stores" }, - "specLocation": "indices/shard_stores/types.ts#L45-L49" + "specLocation": "indices/shard_stores/types.ts#L48-L52" }, { "kind": "interface", @@ -132071,7 +132155,7 @@ } } ], - "specLocation": "indices/shard_stores/types.ts#L51-L54" + "specLocation": "indices/shard_stores/types.ts#L54-L57" }, { "kind": "interface", @@ -132161,7 +132245,7 @@ } } ], - "specLocation": "indices/shard_stores/types.ts#L36-L43" + "specLocation": "indices/shard_stores/types.ts#L39-L46" }, { "kind": "enum", @@ -132187,7 +132271,7 @@ "name": "ShardStoreStatus", "namespace": "indices.shard_stores" }, - "specLocation": "indices/shard_stores/types.ts#L60-L69" + "specLocation": "indices/shard_stores/types.ts#L63-L72" }, { "kind": "interface", @@ -132211,7 +132295,7 @@ } } ], - "specLocation": "indices/shard_stores/types.ts#L56-L58" + "specLocation": "indices/shard_stores/types.ts#L59-L61" }, { "attachedBehaviors": [ @@ -140278,6 +140362,10 @@ } } ], + "meta": [ + "metadata", + "Additional metadata" + ], "type": { "name": "AdditionalProperties", "namespace": "_spec_utils" @@ -140390,7 +140478,7 @@ } } ], - "specLocation": "ingest/simulate/types.ts#L57-L85" + "specLocation": "ingest/simulate/types.ts#L57-L87" }, { "kind": "interface", @@ -172163,7 +172251,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L181-L183" + "specLocation": "nodes/info/types.ts#L184-L186" }, { "kind": "interface", @@ -172187,7 +172275,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L232-L234" + "specLocation": "nodes/info/types.ts#L235-L237" }, { "kind": "interface", @@ -172208,7 +172296,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L201-L203" + "specLocation": "nodes/info/types.ts#L204-L206" }, { "kind": "interface", @@ -172229,7 +172317,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L185-L187" + "specLocation": "nodes/info/types.ts#L188-L190" }, { "attachedBehaviors": [ @@ -172249,6 +172337,10 @@ "kind": "user_defined_value" } ], + "meta": [ + "settings", + "Additional or alternative settings" + ], "type": { "name": "AdditionalProperties", "namespace": "_spec_utils" @@ -172301,7 +172393,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L173-L179" + "specLocation": "nodes/info/types.ts#L173-L182" }, { "kind": "interface", @@ -172358,7 +172450,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L303-L308" + "specLocation": "nodes/info/types.ts#L306-L311" }, { "kind": "interface", @@ -172382,7 +172474,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L224-L226" + "specLocation": "nodes/info/types.ts#L227-L229" }, { "kind": "interface", @@ -172445,7 +172537,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L228-L230" + "specLocation": "nodes/info/types.ts#L231-L233" }, { "kind": "interface", @@ -172565,7 +172657,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L310-L321" + "specLocation": "nodes/info/types.ts#L313-L324" }, { "kind": "interface", @@ -172597,7 +172689,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L323-L326" + "specLocation": "nodes/info/types.ts#L326-L329" }, { "kind": "interface", @@ -172629,7 +172721,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L328-L331" + "specLocation": "nodes/info/types.ts#L331-L334" }, { "kind": "interface", @@ -172672,7 +172764,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L333-L337" + "specLocation": "nodes/info/types.ts#L336-L340" }, { "kind": "interface", @@ -172770,7 +172862,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L339-L348" + "specLocation": "nodes/info/types.ts#L342-L351" }, { "kind": "interface", @@ -172904,7 +172996,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L281-L284" + "specLocation": "nodes/info/types.ts#L284-L287" }, { "kind": "interface", @@ -172925,7 +173017,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L286-L288" + "specLocation": "nodes/info/types.ts#L289-L291" }, { "kind": "interface", @@ -172946,7 +173038,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L290-L292" + "specLocation": "nodes/info/types.ts#L293-L295" }, { "kind": "interface", @@ -173295,7 +173387,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L189-L194" + "specLocation": "nodes/info/types.ts#L192-L197" }, { "kind": "interface", @@ -173317,7 +173409,7 @@ } ], "shortcutProperty": "default", - "specLocation": "nodes/info/types.ts#L196-L199" + "specLocation": "nodes/info/types.ts#L199-L202" }, { "kind": "interface", @@ -173722,7 +173814,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L220-L222" + "specLocation": "nodes/info/types.ts#L223-L225" }, { "kind": "interface", @@ -173815,7 +173907,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L205-L209" + "specLocation": "nodes/info/types.ts#L208-L212" }, { "kind": "interface", @@ -173836,7 +173928,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L216-L218" + "specLocation": "nodes/info/types.ts#L219-L221" }, { "kind": "interface", @@ -173858,7 +173950,7 @@ } ], "shortcutProperty": "default", - "specLocation": "nodes/info/types.ts#L211-L214" + "specLocation": "nodes/info/types.ts#L214-L217" }, { "kind": "interface", @@ -173915,7 +174007,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L350-L354" + "specLocation": "nodes/info/types.ts#L353-L357" }, { "kind": "interface", @@ -173965,7 +174057,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L236-L240" + "specLocation": "nodes/info/types.ts#L239-L243" }, { "kind": "interface", @@ -173986,7 +174078,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L273-L275" + "specLocation": "nodes/info/types.ts#L276-L278" }, { "kind": "interface", @@ -174007,7 +174099,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L277-L279" + "specLocation": "nodes/info/types.ts#L280-L282" }, { "kind": "interface", @@ -174061,7 +174153,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L242-L247" + "specLocation": "nodes/info/types.ts#L245-L250" }, { "kind": "interface", @@ -174093,7 +174185,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L253-L256" + "specLocation": "nodes/info/types.ts#L256-L259" }, { "kind": "interface", @@ -174169,7 +174261,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L258-L262" + "specLocation": "nodes/info/types.ts#L261-L265" }, { "kind": "interface", @@ -174201,7 +174293,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L268-L271" + "specLocation": "nodes/info/types.ts#L271-L274" }, { "kind": "interface", @@ -174222,7 +174314,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L264-L266" + "specLocation": "nodes/info/types.ts#L267-L269" }, { "kind": "interface", @@ -174254,7 +174346,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L249-L251" + "specLocation": "nodes/info/types.ts#L252-L254" }, { "kind": "interface", @@ -174429,7 +174521,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L356-L370" + "specLocation": "nodes/info/types.ts#L359-L373" }, { "kind": "interface", @@ -174564,7 +174656,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L372-L389" + "specLocation": "nodes/info/types.ts#L375-L392" }, { "kind": "interface", @@ -174619,7 +174711,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L391-L398" + "specLocation": "nodes/info/types.ts#L394-L401" }, { "kind": "interface", @@ -174695,7 +174787,7 @@ } } ], - "specLocation": "nodes/info/types.ts#L294-L301" + "specLocation": "nodes/info/types.ts#L297-L304" }, { "attachedBehaviors": [ @@ -200693,6 +200785,10 @@ } } ], + "meta": [ + "operator", + "params" + ], "type": { "name": "AdditionalProperty", "namespace": "_spec_utils" @@ -200717,7 +200813,7 @@ } } ], - "specLocation": "watcher/_types/Conditions.ts#L32-L36" + "specLocation": "watcher/_types/Conditions.ts#L32-L39" }, { "kind": "interface", @@ -200882,7 +200978,7 @@ } } ], - "specLocation": "watcher/_types/Conditions.ts#L47-L59", + "specLocation": "watcher/_types/Conditions.ts#L50-L62", "variants": { "kind": "container" } @@ -200913,7 +201009,7 @@ "name": "ConditionOp", "namespace": "watcher._types" }, - "specLocation": "watcher/_types/Conditions.ts#L38-L45" + "specLocation": "watcher/_types/Conditions.ts#L41-L48" }, { "kind": "enum", @@ -200938,7 +201034,7 @@ "name": "ConditionType", "namespace": "watcher._types" }, - "specLocation": "watcher/_types/Conditions.ts#L61-L67" + "specLocation": "watcher/_types/Conditions.ts#L64-L70" }, { "kind": "enum", @@ -202682,7 +202778,7 @@ "namespace": "watcher._types" }, "properties": [], - "specLocation": "watcher/_types/Conditions.ts#L69-L69" + "specLocation": "watcher/_types/Conditions.ts#L72-L72" }, { "inherits": { @@ -202993,7 +203089,7 @@ "name": "Quantifier", "namespace": "watcher._types" }, - "specLocation": "watcher/_types/Conditions.ts#L71-L74" + "specLocation": "watcher/_types/Conditions.ts#L74-L77" }, { "kind": "interface", @@ -203405,7 +203501,7 @@ } } ], - "specLocation": "watcher/_types/Conditions.ts#L76-L84" + "specLocation": "watcher/_types/Conditions.ts#L79-L87" }, { "kind": "interface", diff --git a/specification/_global/search/_types/suggester.ts b/specification/_global/search/_types/suggester.ts index 0673c02ffd..21b7172210 100644 --- a/specification/_global/search/_types/suggester.ts +++ b/specification/_global/search/_types/suggester.ts @@ -98,6 +98,9 @@ export class TermSuggestOption { collate_match?: boolean } +/** + * @behavior_meta AdditionalProperties suggesters, "The named suggesters" + */ export class Suggester implements AdditionalProperties { /** Global suggest text, to avoid repetition when the same text is used in several suggesters */ text?: string diff --git a/specification/_types/Errors.ts b/specification/_types/Errors.ts index 8075f8975f..83973000cd 100644 --- a/specification/_types/Errors.ts +++ b/specification/_types/Errors.ts @@ -25,6 +25,8 @@ import { AdditionalProperties } from '@spec_utils/behaviors' /** * Cause and details about a request failure. This class defines the properties common to all error types. * Additional details are also provided, that depend on the error type. + * + * @behavior_meta AdditionalProperties metadata, "Additional details about the error" */ export class ErrorCause implements AdditionalProperties diff --git a/specification/_types/aggregations/Aggregate.ts b/specification/_types/aggregations/Aggregate.ts index 47a74dffe9..7d2b2ccb8c 100644 --- a/specification/_types/aggregations/Aggregate.ts +++ b/specification/_types/aggregations/Aggregate.ts @@ -330,6 +330,8 @@ export class MultiBucketAggregateBase extends AggregateBase { /** * Base type for multi-bucket aggregation results that can hold sub-aggregations results. + * + * @behavior_meta AdditionalProperties aggregations, "Nested aggregations" */ export class MultiBucketBase implements AdditionalProperties @@ -472,6 +474,8 @@ export class MultiTermsBucket extends MultiBucketBase { /** * Base type for single-bucket aggregation results that can hold sub-aggregations results. + * + * @behavior_meta AdditionalProperties aggregations, "Nested aggregations" */ export class SingleBucketAggregateBase extends AggregateBase @@ -656,7 +660,10 @@ export class TopHitsAggregate extends AggregateBase { hits: HitsMetadata } -/** @variant name=inference */ +/** + * @variant name=inference + * @behavior_meta AdditionalProperties data, "Additional data" + */ // This is a union with widely different fields, many of them being runtime-defined. We mimic below the few fields // present in `ParsedInference` with an additional properties spillover to not loose any data. export class InferenceAggregate diff --git a/specification/_types/common.ts b/specification/_types/common.ts index 1c74d5752c..de1f463e1e 100644 --- a/specification/_types/common.ts +++ b/specification/_types/common.ts @@ -317,6 +317,9 @@ export enum WaitForEvents { languid } +/** + * @behavior_meta AdditionalProperties metadata, "Document metadata" + */ // Additional properties are the meta fields export class InlineGet implements AdditionalProperties diff --git a/specification/_types/query_dsl/compound.ts b/specification/_types/query_dsl/compound.ts index 3e18821d51..1cf155b598 100644 --- a/specification/_types/query_dsl/compound.ts +++ b/specification/_types/query_dsl/compound.ts @@ -179,14 +179,23 @@ export class DecayFunctionBase { multi_value_mode?: MultiValueMode } +/** + * @behavior_meta AdditionalProperty field, placement + */ export class NumericDecayFunction extends DecayFunctionBase implements AdditionalProperty> {} +/** + * @behavior_meta AdditionalProperty field, placement + */ export class DateDecayFunction extends DecayFunctionBase implements AdditionalProperty> {} +/** + * @behavior_meta AdditionalProperty field, placement + */ export class GeoDecayFunction extends DecayFunctionBase implements AdditionalProperty> {} diff --git a/specification/_types/query_dsl/geo.ts b/specification/_types/query_dsl/geo.ts index fc230874ea..d5a5594758 100644 --- a/specification/_types/query_dsl/geo.ts +++ b/specification/_types/query_dsl/geo.ts @@ -29,6 +29,9 @@ import { import { FieldLookup, QueryBase } from './abstractions' import { Field } from '@_types/common' +/** + * @behavior_meta AdditionalProperty field, bounding_box + */ export class GeoBoundingBoxQuery extends QueryBase implements AdditionalProperty @@ -54,6 +57,9 @@ export enum GeoExecution { indexed } +/** + * @behavior_meta AdditionalProperty field, location + */ export class GeoDistanceQuery extends QueryBase implements AdditionalProperty @@ -88,7 +94,10 @@ export class GeoPolygonPoints { points: GeoLocation[] } -/** @deprecated 7.12.0 Use geo-shape instead. */ +/** + * @deprecated 7.12.0 Use geo-shape instead. + * @behavior_meta AdditionalProperty field, polygon + */ export class GeoPolygonQuery extends QueryBase implements AdditionalProperty @@ -116,6 +125,9 @@ export class GeoShapeFieldQuery { relation?: GeoShapeRelation } +/** + * @behavior_meta AdditionalProperty field, shape + */ // GeoShape query doesn't follow the common pattern of having a single field-name property // holding also the query base fields (boost and _name) export class GeoShapeQuery diff --git a/specification/_types/query_dsl/specialized.ts b/specification/_types/query_dsl/specialized.ts index f4e99b5277..e9a9947d45 100644 --- a/specification/_types/query_dsl/specialized.ts +++ b/specification/_types/query_dsl/specialized.ts @@ -339,6 +339,9 @@ export class ScriptScoreQuery extends QueryBase { script: Script } +/** + * @behavior_meta AdditionalProperty field, shape + */ // Shape query doesn't follow the common pattern of having a single field-name property // holding also the query base fields (boost and _name) export class ShapeQuery diff --git a/specification/_types/query_dsl/term.ts b/specification/_types/query_dsl/term.ts index d828eed53d..9382659ee8 100644 --- a/specification/_types/query_dsl/term.ts +++ b/specification/_types/query_dsl/term.ts @@ -251,6 +251,9 @@ export class TermQuery extends QueryBase { case_insensitive?: boolean } +/** + * @behavior_meta AdditionalProperty field, term + */ export class TermsQuery extends QueryBase implements AdditionalProperty {} diff --git a/specification/_types/sort.ts b/specification/_types/sort.ts index d320da8b99..9c443f5edf 100644 --- a/specification/_types/sort.ts +++ b/specification/_types/sort.ts @@ -55,6 +55,10 @@ export class FieldSort { export class ScoreSort { order?: SortOrder } + +/** + * @behavior_meta AdditionalProperty field, location + */ export class GeoDistanceSort implements AdditionalProperty { @@ -82,6 +86,7 @@ export enum ScriptSortType { /** * @doc_id sort-search-results * @variants container + * @behavior_meta AdditionalProperty field, sort */ export class SortOptions implements AdditionalProperty { _score?: ScoreSort diff --git a/specification/indices/_types/IndexSettings.ts b/specification/indices/_types/IndexSettings.ts index a74a613085..1307fe1d45 100644 --- a/specification/indices/_types/IndexSettings.ts +++ b/specification/indices/_types/IndexSettings.ts @@ -68,6 +68,8 @@ export class RetentionLease { /** * @doc_id index-modules-settings + * + * @behavior_meta AdditionalProperties other_settings, "Additional settings not covered in this type. */ export class IndexSettings implements AdditionalProperties diff --git a/specification/indices/analyze/types.ts b/specification/indices/analyze/types.ts index 27b8f7f492..44d6bf3d24 100644 --- a/specification/indices/analyze/types.ts +++ b/specification/indices/analyze/types.ts @@ -49,6 +49,9 @@ export class CharFilterDetail { } // Additional properties are attributes that can be set by plugin-defined tokenizers +/** + * @behavior_meta AdditionalProperties attributes, "Additional tokenizer-specific attributes" + */ export class ExplainAnalyzeToken implements AdditionalProperties { diff --git a/specification/indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts b/specification/indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts index 6ff86754f2..b6f4396e84 100644 --- a/specification/indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts +++ b/specification/indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts @@ -29,6 +29,9 @@ export class Response { body: FieldsUsageBody } +/** + * @behavior_meta AdditionalProperties stats, "Per index statistics" + */ export class FieldsUsageBody implements AdditionalProperties { diff --git a/specification/indices/shard_stores/types.ts b/specification/indices/shard_stores/types.ts index 4ca0367dd8..29c37e8807 100644 --- a/specification/indices/shard_stores/types.ts +++ b/specification/indices/shard_stores/types.ts @@ -27,6 +27,9 @@ export class IndicesShardStores { shards: Dictionary } +/** + * @behavior_meta AdditionalProperty node_id, node + */ export class ShardStore implements AdditionalProperty { allocation: ShardStoreAllocation allocation_id?: Id diff --git a/specification/ingest/simulate/types.ts b/specification/ingest/simulate/types.ts index 450d1267fe..36be981818 100644 --- a/specification/ingest/simulate/types.ts +++ b/specification/ingest/simulate/types.ts @@ -56,6 +56,8 @@ export class Document { /** * The simulated document, with optional metadata. + * + * @behavior_meta AdditionalProperties metadata, "Additional metadata" */ export class DocumentSimulation implements AdditionalProperties diff --git a/specification/nodes/info/types.ts b/specification/nodes/info/types.ts index dd0e833180..ac171e8aae 100644 --- a/specification/nodes/info/types.ts +++ b/specification/nodes/info/types.ts @@ -170,6 +170,9 @@ export class NodeInfoRepositoriesUrl { allowed_urls: string } +/** + * @behavior_meta AdditionalProperties settings, "Additional or alternative settings" + */ export class NodeInfoDiscover implements AdditionalProperties { diff --git a/specification/watcher/_types/Conditions.ts b/specification/watcher/_types/Conditions.ts index 5985ae080a..444be99af5 100644 --- a/specification/watcher/_types/Conditions.ts +++ b/specification/watcher/_types/Conditions.ts @@ -29,6 +29,9 @@ export class ArrayCompareOpParams { value: FieldValue } +/** + * @behavior_meta AdditionalProperty operator, params + */ export class ArrayCompareCondition implements AdditionalProperty { diff --git a/typescript-generator/src/metamodel.ts b/typescript-generator/src/metamodel.ts index 05673cc6de..84d117ccc4 100644 --- a/typescript-generator/src/metamodel.ts +++ b/typescript-generator/src/metamodel.ts @@ -213,6 +213,7 @@ export class Container extends VariantBase { export class Inherits { type: TypeName generics?: ValueOf[] + meta?: string[] } /**