From ca96e3fbb396384227f54f748ae7c09eeb0b16de Mon Sep 17 00:00:00 2001 From: Elastic Machine Date: Mon, 14 Aug 2023 14:36:07 +0000 Subject: [PATCH] Update specification output --- output/schema/schema.json | 122 +++++++++++++++++++------------------- 1 file changed, 61 insertions(+), 61 deletions(-) diff --git a/output/schema/schema.json b/output/schema/schema.json index 0c5dd5510f..0b6d41e8ea 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -125711,7 +125711,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L276-L291" + "specLocation": "ingest/_types/Processors.ts#L273-L288" }, { "inherits": { @@ -125818,7 +125818,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L293-L329" + "specLocation": "ingest/_types/Processors.ts#L290-L326" }, { "inherits": { @@ -125859,7 +125859,7 @@ } }, { - "description": "The field to assign the converted value to, by default `field` is updated in-place.", + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", "name": "target_field", "required": false, "serverDefault": "field", @@ -125872,7 +125872,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L384-L399" + "specLocation": "ingest/_types/Processors.ts#L381-L397" }, { "inherits": { @@ -125937,7 +125937,7 @@ } }, { - "description": "The field to assign the polygon shape to, by default `field` is updated in-place.", + "description": "The field to assign the polygon shape to\nBy default, the field is updated in-place.", "name": "target_field", "required": false, "type": { @@ -125949,7 +125949,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L401-L423" + "specLocation": "ingest/_types/Processors.ts#L399-L422" }, { "inherits": { @@ -125990,7 +125990,7 @@ } }, { - "description": "The field to assign the converted value to, by default `field` is updated in-place.", + "description": "The field to assign the converted value to.\nBy default, the `field` is updated in-place.", "name": "target_field", "required": false, "serverDefault": "field", @@ -126015,7 +126015,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L435-L454" + "specLocation": "ingest/_types/Processors.ts#L434-L454" }, { "kind": "enum", @@ -126046,7 +126046,7 @@ "name": "ConvertType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L425-L433" + "specLocation": "ingest/_types/Processors.ts#L424-L432" }, { "inherits": { @@ -126062,7 +126062,7 @@ }, "properties": [ { - "description": "Value used to fill empty fields, empty fields will be skipped if this is not provided.\nEmpty field is one with no value (2 consecutive separators) or empty quotes (`\"\"`).", + "description": "Value used to fill empty fields.\nEmpty fields are skipped if this is not provided.\nAn empty field is one with no value (2 consecutive separators) or empty quotes (`\"\"`).", "name": "empty_value", "required": false, "type": { @@ -126144,7 +126144,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L456-L488" + "specLocation": "ingest/_types/Processors.ts#L456-L489" }, { "inherits": { @@ -126250,7 +126250,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L490-L528" + "specLocation": "ingest/_types/Processors.ts#L491-L529" }, { "inherits": { @@ -126332,7 +126332,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L530-L557" + "specLocation": "ingest/_types/Processors.ts#L531-L558" }, { "inherits": { @@ -126398,7 +126398,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L559-L578" + "specLocation": "ingest/_types/Processors.ts#L560-L579" }, { "inherits": { @@ -126438,7 +126438,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L580-L591" + "specLocation": "ingest/_types/Processors.ts#L581-L592" }, { "inherits": { @@ -126453,7 +126453,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L593-L593" + "specLocation": "ingest/_types/Processors.ts#L594-L594" }, { "inherits": { @@ -126557,7 +126557,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L595-L634" + "specLocation": "ingest/_types/Processors.ts#L596-L635" }, { "inherits": { @@ -126585,7 +126585,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L636-L642" + "specLocation": "ingest/_types/Processors.ts#L637-L643" }, { "inherits": { @@ -126638,7 +126638,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L644-L658" + "specLocation": "ingest/_types/Processors.ts#L645-L659" }, { "inherits": { @@ -126679,7 +126679,7 @@ } }, { - "description": "f `true` only first found geoip data will be returned, even if field contains array.", + "description": "If `true`, only the first found geoip data will be returned, even if the field contains an array.", "name": "first_only", "required": false, "serverDefault": true, @@ -126733,7 +126733,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L331-L360" + "specLocation": "ingest/_types/Processors.ts#L328-L357" }, { "inherits": { @@ -126825,7 +126825,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L660-L685" + "specLocation": "ingest/_types/Processors.ts#L661-L686" }, { "inherits": { @@ -126890,7 +126890,7 @@ } }, { - "description": "The field to assign the converted value to, by default `field` is updated in-place.", + "description": "The field to assign the converted value to\nBy default, the `field` is updated in-place.", "name": "target_field", "required": false, "serverDefault": "field", @@ -126903,7 +126903,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L687-L710" + "specLocation": "ingest/_types/Processors.ts#L688-L712" }, { "kind": "interface", @@ -126937,7 +126937,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L733-L745", + "specLocation": "ingest/_types/Processors.ts#L735-L747", "variants": { "kind": "container" } @@ -127014,7 +127014,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L760-L786" + "specLocation": "ingest/_types/Processors.ts#L762-L788" }, { "kind": "interface", @@ -127050,7 +127050,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L747-L758" + "specLocation": "ingest/_types/Processors.ts#L749-L760" }, { "inherits": { @@ -127122,7 +127122,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L712-L731" + "specLocation": "ingest/_types/Processors.ts#L714-L733" }, { "inherits": { @@ -127162,7 +127162,7 @@ } }, { - "description": "The field to assign the joined value to, by default field is updated in-place.", + "description": "The field to assign the joined value to.\nBy default, the field is updated in-place.", "name": "target_field", "required": false, "serverDefault": "field", @@ -127175,7 +127175,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L788-L802" + "specLocation": "ingest/_types/Processors.ts#L790-L805" }, { "inherits": { @@ -127254,7 +127254,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L804-L833" + "specLocation": "ingest/_types/Processors.ts#L807-L836" }, { "kind": "enum", @@ -127272,7 +127272,7 @@ "name": "JsonProcessorConflictStrategy", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L835-L840" + "specLocation": "ingest/_types/Processors.ts#L838-L843" }, { "inherits": { @@ -127429,7 +127429,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L842-L894" + "specLocation": "ingest/_types/Processors.ts#L845-L897" }, { "inherits": { @@ -127470,7 +127470,7 @@ } }, { - "description": "The field to assign the converted value to, by default field is updated in-place.", + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", "name": "target_field", "required": false, "serverDefault": "field", @@ -127483,7 +127483,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L896-L911" + "specLocation": "ingest/_types/Processors.ts#L899-L915" }, { "kind": "interface", @@ -127637,7 +127637,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L913-L924" + "specLocation": "ingest/_types/Processors.ts#L917-L928" }, { "kind": "interface", @@ -127710,7 +127710,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L238-L261" + "specLocation": "ingest/_types/Processors.ts#L235-L258" }, { "kind": "interface", @@ -128014,7 +128014,7 @@ } }, { - "description": "Sets one field and associates it with the specified value.\nIf the field already exists, its value will be replaced with the provided one.", + "description": "Adds a field with the specified value.\nIf the field already exists, its value will be replaced with the provided one.", "docId": "set-processor", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/set-processor.html", "name": "set", @@ -128056,7 +128056,7 @@ } }, { - "description": "Trims whitespace from field.\nIf the field is an array of strings, all members of the array will be trimmed.\nThis only works on leading and trailing whitespace.", + "description": "Trims whitespace from a field.\nIf the field is an array of strings, all members of the array will be trimmed.\nThis only works on leading and trailing whitespace.", "docId": "trim-processor", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/trim-processor.html", "name": "trim", @@ -128098,7 +128098,7 @@ } }, { - "description": "Converts a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024).\nIf the field is an array of strings, all members of the array will be converted.\nSupported human readable units are \"b\", \"kb\", \"mb\", \"gb\", \"tb\", \"pb\" case insensitive.\nAn error will occur if the field is not a supported format or resultant value exceeds 2^63.", + "description": "Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `1024`).\nIf the field is an array of strings, all members of the array will be converted.\nSupported human readable units are \"b\", \"kb\", \"mb\", \"gb\", \"tb\", \"pb\" case insensitive.\nAn error will occur if the field is not a supported format or resultant value exceeds 2^63.", "docId": "bytes-processor", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/bytes-processor.html", "name": "bytes", @@ -128112,7 +128112,7 @@ } }, { - "description": "Similar to the Grok Processor, dissect also extracts structured fields out of a single text field within a document.\nHowever unlike the Grok Processor, dissect does not use Regular Expressions.\nThis allows dissect’s syntax to be simple and for some cases faster than the Grok Processor.\nDissect matches a single text field against a defined pattern.", + "description": "Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern.", "docId": "dissect-processor", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dissect-processor.html", "name": "dissect", @@ -128196,7 +128196,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L28-L236", + "specLocation": "ingest/_types/Processors.ts#L28-L233", "variants": { "kind": "container", "nonExhaustive": true @@ -128241,7 +128241,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L926-L936" + "specLocation": "ingest/_types/Processors.ts#L930-L940" }, { "inherits": { @@ -128294,7 +128294,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L938-L954" + "specLocation": "ingest/_types/Processors.ts#L942-L958" }, { "inherits": { @@ -128380,7 +128380,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L978-L1012" + "specLocation": "ingest/_types/Processors.ts#L982-L1016" }, { "inherits": { @@ -128423,7 +128423,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1014-L1023" + "specLocation": "ingest/_types/Processors.ts#L1018-L1027" }, { "kind": "enum", @@ -128439,7 +128439,7 @@ "name": "ShapeType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1025-L1028" + "specLocation": "ingest/_types/Processors.ts#L1029-L1032" }, { "inherits": { @@ -128470,7 +128470,7 @@ "description": "The sort order to use.\nAccepts `\"asc\"` or `\"desc\"`.", "name": "order", "required": false, - "serverDefault": "\"asc\"", + "serverDefault": "asc", "type": { "kind": "instance_of", "type": { @@ -128480,7 +128480,7 @@ } }, { - "description": "The field to assign the sorted value to, by default `field` is updated in-place.", + "description": "The field to assign the sorted value to.\nBy default, the field is updated in-place.", "name": "target_field", "required": false, "type": { @@ -128492,7 +128492,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1030-L1045" + "specLocation": "ingest/_types/Processors.ts#L1034-L1050" }, { "inherits": { @@ -128558,7 +128558,7 @@ } }, { - "description": "The field to assign the split value to, by default `field` is updated in-place.", + "description": "The field to assign the split value to.\nBy default, the field is updated in-place.", "name": "target_field", "required": false, "serverDefault": "field", @@ -128571,7 +128571,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1047-L1071" + "specLocation": "ingest/_types/Processors.ts#L1052-L1077" }, { "inherits": { @@ -128612,7 +128612,7 @@ } }, { - "description": "The field to assign the trimmed value to, by default `field` is updated in-place.", + "description": "The field to assign the trimmed value to.\nBy default, the field is updated in-place.", "name": "target_field", "required": false, "serverDefault": "field", @@ -128625,7 +128625,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1073-L1088" + "specLocation": "ingest/_types/Processors.ts#L1079-L1095" }, { "inherits": { @@ -128666,7 +128666,7 @@ } }, { - "description": "The field to assign the converted value to, by default `field` is updated in-place.", + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", "name": "target_field", "required": false, "serverDefault": "field", @@ -128679,7 +128679,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1090-L1105" + "specLocation": "ingest/_types/Processors.ts#L1097-L1113" }, { "inherits": { @@ -128720,7 +128720,7 @@ } }, { - "description": "The field to assign the converted value to, by default `field` is updated in-place.", + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", "name": "target_field", "required": false, "serverDefault": "field", @@ -128733,7 +128733,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1107-L1122" + "specLocation": "ingest/_types/Processors.ts#L1115-L1131" }, { "inherits": { @@ -128788,7 +128788,7 @@ } }, { - "description": "The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the regexes.yaml from uap-core it ships with.", + "description": "The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with.", "name": "regex_file", "required": false, "type": { @@ -128813,7 +128813,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L362-L382" + "specLocation": "ingest/_types/Processors.ts#L359-L379" }, { "kind": "enum", @@ -128853,7 +128853,7 @@ "name": "UserAgentProperty", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L263-L274" + "specLocation": "ingest/_types/Processors.ts#L260-L271" }, { "attachedBehaviors": [