@elastic/schemas 0.5.1 → 0.6.0

package/src/es/json/text_structure.find_field_structure.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_field_structure","description":"Find the structure of a text field.\n\nFind the structure of a text field in an Elasticsearch index.\n\nThis API provides a starting point for extracting further information from log messages already ingested into Elasticsearch.\nFor example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field.\n\nThe response from the API contains:\n\n* Sample messages.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\n* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\nIf the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.\nIt helps determine why the returned structure was chosen.","x-api":{"id":"text-structure.find_field_structure","name":"find-field-structure","namespace":"text-structure"},"x-method":"GET","x-path":"/_text_structure/find_field_structure","x-urls":[{"path":"/_text_structure/find_field_structure","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"column_names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"If `format` is set to `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header row, columns are named \"column1\", \"column2\", \"column3\", for example.","x-found-in":"query"},"delimiter":{"type":"string","description":"If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.","x-found-in":"query"},"documents_to_sample":{"type":"number","description":"The number of documents to include in the structural analysis.\nThe minimum value is 2.","x-found-in":"query"},"ecs_compatibility":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__EcsCompatibilityType","description":"The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of the meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output.\nThe intention in that situation is that a user who knows the meanings will rename the fields before using them.","x-found-in":"query"},"explain":{"type":"boolean","description":"If `true`, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result.","x-found-in":"query"},"field":{"type":"string","description":"The field that should be analyzed.","x-found-in":"query"},"format":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FormatType","description":"The high level structure of the text.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is set to delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.","x-found-in":"query"},"grok_pattern":{"type":"string","description":"If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.","x-found-in":"query"},"index":{"type":"string","description":"The name of the index that contains the analyzed field.","x-found-in":"query"},"quote":{"type":"string","description":"If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.","x-found-in":"query"},"should_trim_fields":{"type":"boolean","description":"If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is true.\nOtherwise, the default value is `false`.","x-found-in":"query"},"should_parse_recursively":{"type":"boolean","description":"If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively.\nThe nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting.\nAnything beyond that depth is parsed as an `object` type field.\nFor formats other than `ndjson`, this parameter is ignored.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires, it will be stopped.","x-found-in":"query"},"timestamp_field":{"type":"string","description":"The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.","x-found-in":"query"},"timestamp_format":{"type":"string","description":"The Java time format of the timestamp field in the text.\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`).\nSpacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified, the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.","x-found-in":"query"}},"required":["field","index"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_field_structure","description":"Find the structure of a text field.\n\nFind the structure of a text field in an Elasticsearch index.\n\nThis API provides a starting point for extracting further information from log messages already ingested into Elasticsearch.\nFor example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field.\n\nThe response from the API contains:\n\n* Sample messages.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\n* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\nIf the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.\nIt helps determine why the returned structure was chosen.","x-api":{"id":"text-structure.find_field_structure","name":"find-field-structure","namespace":"text-structure"},"x-method":"GET","x-path":"/_text_structure/find_field_structure","x-urls":[{"path":"/_text_structure/find_field_structure","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"column_names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"If `format` is set to `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header row, columns are named \"column1\", \"column2\", \"column3\", for example.","x-found-in":"query"},"delimiter":{"type":"string","description":"If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.","x-found-in":"query"},"documents_to_sample":{"type":"number","description":"The number of documents to include in the structural analysis.\nThe minimum value is 2.","x-found-in":"query"},"ecs_compatibility":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__EcsCompatibilityType","description":"The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of the meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output.\nThe intention in that situation is that a user who knows the meanings will rename the fields before using them.","x-found-in":"query"},"explain":{"type":"boolean","description":"If `true`, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result.","x-found-in":"query"},"field":{"type":"string","description":"The field that should be analyzed.","x-found-in":"query"},"format":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FormatType","description":"The high level structure of the text.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is set to delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.","x-found-in":"query"},"grok_pattern":{"type":"string","description":"If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.","x-found-in":"query"},"index":{"type":"string","description":"The name of the index that contains the analyzed field.","x-found-in":"query"},"quote":{"type":"string","description":"If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.","x-found-in":"query"},"should_trim_fields":{"type":"boolean","description":"If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is true.\nOtherwise, the default value is `false`.","x-found-in":"query"},"should_parse_recursively":{"type":"boolean","description":"If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively.\nThe nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting.\nAnything beyond that depth is parsed as an `object` type field.\nFor formats other than `ndjson`, this parameter is ignored.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires, it will be stopped.","x-found-in":"query"},"timestamp_field":{"type":"string","description":"The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.","x-found-in":"query"},"timestamp_format":{"type":"string","description":"The Java time format of the timestamp field in the text.\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`).\nSpacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified, the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.","x-found-in":"query"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["field","index"]}

package/src/es/json/text_structure.find_message_structure.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_message_structure","description":"Find the structure of text messages.\n\nFind the structure of a list of text messages.\nThe messages must contain data that is suitable to be ingested into Elasticsearch.\n\nThis API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.\nUse this API rather than the find text structure API if your input text has already been split up into separate messages by some other process.\n\nThe response from the API contains:\n\n* Sample messages.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\nAppropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\nIf the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.\nIt helps determine why the returned structure was chosen.","x-api":{"id":"text-structure.find_message_structure","name":"find-message-structure","namespace":"text-structure"},"x-method":"GET","x-path":"/_text_structure/find_message_structure","x-urls":[{"path":"/_text_structure/find_message_structure","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"column_names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"If the format is `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header role, columns are named \"column1\", \"column2\", \"column3\", for example.","x-found-in":"query"},"delimiter":{"type":"string","description":"If you the format is `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.","x-found-in":"query"},"ecs_compatibility":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__EcsCompatibilityType","description":"The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it.","x-found-in":"query"},"explain":{"type":"boolean","description":"If this parameter is set to true, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result.","x-found-in":"query"},"format":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FormatType","description":"The high level structure of the text.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.","x-found-in":"query"},"grok_pattern":{"type":"string","description":"If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.","x-found-in":"query"},"quote":{"type":"string","description":"If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.","x-found-in":"query"},"should_trim_fields":{"type":"boolean","description":"If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is true.\nOtherwise, the default value is `false`.","x-found-in":"query"},"should_parse_recursively":{"type":"boolean","description":"If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively.\nThe nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting.\nAnything beyond that depth is parsed as an `object` type field.\nFor formats other than `ndjson`, this parameter is ignored.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires, it will be stopped.","x-found-in":"query"},"timestamp_field":{"type":"string","description":"The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.","x-found-in":"query"},"timestamp_format":{"type":"string","description":"The Java time format of the timestamp field in the text.\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`).\nSpacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified, the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.","x-found-in":"query"},"messages":{"type":"array","items":{"type":"string"},"description":"The list of messages you want to analyze.","x-found-in":"body"}},"required":["messages"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_message_structure","description":"Find the structure of text messages.\n\nFind the structure of a list of text messages.\nThe messages must contain data that is suitable to be ingested into Elasticsearch.\n\nThis API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.\nUse this API rather than the find text structure API if your input text has already been split up into separate messages by some other process.\n\nThe response from the API contains:\n\n* Sample messages.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\nAppropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\nIf the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.\nIt helps determine why the returned structure was chosen.","x-api":{"id":"text-structure.find_message_structure","name":"find-message-structure","namespace":"text-structure"},"x-method":"GET","x-path":"/_text_structure/find_message_structure","x-urls":[{"path":"/_text_structure/find_message_structure","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"column_names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"If the format is `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header role, columns are named \"column1\", \"column2\", \"column3\", for example.","x-found-in":"query"},"delimiter":{"type":"string","description":"If you the format is `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.","x-found-in":"query"},"ecs_compatibility":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__EcsCompatibilityType","description":"The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it.","x-found-in":"query"},"explain":{"type":"boolean","description":"If this parameter is set to true, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result.","x-found-in":"query"},"format":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FormatType","description":"The high level structure of the text.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.","x-found-in":"query"},"grok_pattern":{"type":"string","description":"If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.","x-found-in":"query"},"quote":{"type":"string","description":"If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.","x-found-in":"query"},"should_trim_fields":{"type":"boolean","description":"If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is true.\nOtherwise, the default value is `false`.","x-found-in":"query"},"should_parse_recursively":{"type":"boolean","description":"If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively.\nThe nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting.\nAnything beyond that depth is parsed as an `object` type field.\nFor formats other than `ndjson`, this parameter is ignored.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires, it will be stopped.","x-found-in":"query"},"timestamp_field":{"type":"string","description":"The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.","x-found-in":"query"},"timestamp_format":{"type":"string","description":"The Java time format of the timestamp field in the text.\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`).\nSpacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified, the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.","x-found-in":"query"},"messages":{"type":"array","items":{"type":"string"},"description":"The list of messages you want to analyze.","x-found-in":"body"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["messages"]}

package/src/es/json/text_structure.find_structure.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_structure","description":"Find the structure of a text file.\n\nThe text file must contain data that is suitable to be ingested into Elasticsearch.\n\nThis API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.\nUnlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format.\nIt must, however, be text; binary text formats are not currently supported.\nThe size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb.\n\nThe response from the API contains:\n\n* A couple of messages from the beginning of the text.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\n* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.","x-api":{"id":"text-structure.find_structure","name":"find-structure","namespace":"text-structure"},"x-method":"POST","x-path":"/_text_structure/find_structure","x-urls":[{"path":"/_text_structure/find_structure","methods":["POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.13.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-body-format":"ndjson","type":"object","properties":{"charset":{"type":"string","description":"The text's character set.\nIt must be a character set that is supported by the JVM that Elasticsearch uses.\nFor example, `UTF-8`, `UTF-16LE`, `windows-1252`, or `EUC-JP`.\nIf this parameter is not specified, the structure finder chooses an appropriate character set.","x-found-in":"query"},"column_names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"If you have set format to `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header role, columns are named \"column1\", \"column2\", \"column3\", for example.","x-found-in":"query"},"delimiter":{"type":"string","description":"If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.","x-found-in":"query"},"ecs_compatibility":{"type":"string","description":"The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nValid values are `disabled` and `v1`.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it.","x-found-in":"query"},"explain":{"type":"boolean","description":"If this parameter is set to `true`, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result.\nIf the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen.","x-found-in":"query"},"format":{"$ref":"./text_structure.find_structure.json#/$defs/text_structure.find_structure__FindStructureFormat","description":"The high level structure of the text.\nValid values are `ndjson`, `xml`, `delimited`, and `semi_structured_text`.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is set to `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.","x-found-in":"query"},"grok_pattern":{"type":"string","description":"If you have set `format` to `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.","x-found-in":"query"},"has_header_row":{"type":"boolean","description":"If you have set `format` to `delimited`, you can use this parameter to indicate whether the column names are in the first row of the text.\nIf this parameter is not specified, the structure finder guesses based on the similarity of the first row of the text to other rows.","x-found-in":"query"},"line_merge_size_limit":{"type":"number","description":"The maximum number of characters in a message when lines are merged to form messages while analyzing semi-structured text.\nIf you have extremely long messages you may need to increase this, but be aware that this may lead to very long processing times if the way to group lines into messages is misdetected.","x-found-in":"query"},"lines_to_sample":{"type":"number","description":"The number of lines to include in the structural analysis, starting from the beginning of the text.\nThe minimum is 2.\nIf the value of this parameter is greater than the number of lines in the text, the analysis proceeds (as long as there are at least two lines in the text) for all of the lines.\n\nNOTE: The number of lines and the variation of the lines affects the speed of the analysis.\nFor example, if you upload text where the first 1000 lines are all variations on the same message, the analysis will find more commonality than would be seen with a bigger sample.\nIf possible, however, it is more efficient to upload sample text with more variety in the first 1000 lines than to request analysis of 100000 lines to achieve some variety.","x-found-in":"query"},"quote":{"type":"string","description":"If you have set `format` to `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.","x-found-in":"query"},"should_trim_fields":{"type":"boolean","description":"If you have set `format` to `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is `true`.\nOtherwise, the default value is `false`.","x-found-in":"query"},"should_parse_recursively":{"type":"boolean","description":"If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively.\nThe nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting.\nAnything beyond that depth is parsed as an `object` type field.\nFor formats other than `ndjson`, this parameter is ignored.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires then it will be stopped.","x-found-in":"query"},"timestamp_field":{"type":"string","description":"The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text were ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the `format` is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.","x-found-in":"query"},"timestamp_format":{"type":"string","description":"The Java time format of the timestamp field in the text.\n\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and separated from the `ss` by a `.`, `,` or `:`.\nSpacing and punctuation is also permitted with the exception of `?`, newline and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text this will result in the structure finder treating the text as single-line messages.","x-found-in":"query"},"text_files":{"type":"array","items":{},"x-found-in":"body","x-body-root":true}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_structure","description":"Find the structure of a text file.\n\nThe text file must contain data that is suitable to be ingested into Elasticsearch.\n\nThis API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.\nUnlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format.\nIt must, however, be text; binary text formats are not currently supported.\nThe size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb.\n\nThe response from the API contains:\n\n* A couple of messages from the beginning of the text.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\n* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.","x-api":{"id":"text-structure.find_structure","name":"find-structure","namespace":"text-structure"},"x-method":"POST","x-path":"/_text_structure/find_structure","x-urls":[{"path":"/_text_structure/find_structure","methods":["POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.13.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-body-format":["ndjson"],"type":"object","properties":{"charset":{"type":"string","description":"The text's character set.\nIt must be a character set that is supported by the JVM that Elasticsearch uses.\nFor example, `UTF-8`, `UTF-16LE`, `windows-1252`, or `EUC-JP`.\nIf this parameter is not specified, the structure finder chooses an appropriate character set.","x-found-in":"query"},"column_names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"If you have set format to `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header role, columns are named \"column1\", \"column2\", \"column3\", for example.","x-found-in":"query"},"delimiter":{"type":"string","description":"If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.","x-found-in":"query"},"ecs_compatibility":{"type":"string","description":"The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nValid values are `disabled` and `v1`.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it.","x-found-in":"query"},"explain":{"type":"boolean","description":"If this parameter is set to `true`, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result.\nIf the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen.","x-found-in":"query"},"format":{"$ref":"./text_structure.find_structure.json#/$defs/text_structure.find_structure__FindStructureFormat","description":"The high level structure of the text.\nValid values are `ndjson`, `xml`, `delimited`, and `semi_structured_text`.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is set to `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.","x-found-in":"query"},"grok_pattern":{"type":"string","description":"If you have set `format` to `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.","x-found-in":"query"},"has_header_row":{"type":"boolean","description":"If you have set `format` to `delimited`, you can use this parameter to indicate whether the column names are in the first row of the text.\nIf this parameter is not specified, the structure finder guesses based on the similarity of the first row of the text to other rows.","x-found-in":"query"},"line_merge_size_limit":{"type":"number","description":"The maximum number of characters in a message when lines are merged to form messages while analyzing semi-structured text.\nIf you have extremely long messages you may need to increase this, but be aware that this may lead to very long processing times if the way to group lines into messages is misdetected.","x-found-in":"query"},"lines_to_sample":{"type":"number","description":"The number of lines to include in the structural analysis, starting from the beginning of the text.\nThe minimum is 2.\nIf the value of this parameter is greater than the number of lines in the text, the analysis proceeds (as long as there are at least two lines in the text) for all of the lines.\n\nNOTE: The number of lines and the variation of the lines affects the speed of the analysis.\nFor example, if you upload text where the first 1000 lines are all variations on the same message, the analysis will find more commonality than would be seen with a bigger sample.\nIf possible, however, it is more efficient to upload sample text with more variety in the first 1000 lines than to request analysis of 100000 lines to achieve some variety.","x-found-in":"query"},"quote":{"type":"string","description":"If you have set `format` to `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.","x-found-in":"query"},"should_trim_fields":{"type":"boolean","description":"If you have set `format` to `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is `true`.\nOtherwise, the default value is `false`.","x-found-in":"query"},"should_parse_recursively":{"type":"boolean","description":"If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively.\nThe nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting.\nAnything beyond that depth is parsed as an `object` type field.\nFor formats other than `ndjson`, this parameter is ignored.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires then it will be stopped.","x-found-in":"query"},"timestamp_field":{"type":"string","description":"The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text were ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the `format` is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.","x-found-in":"query"},"timestamp_format":{"type":"string","description":"The Java time format of the timestamp field in the text.\n\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and separated from the `ss` by a `.`, `,` or `:`.\nSpacing and punctuation is also permitted with the exception of `?`, newline and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text this will result in the structure finder treating the text as single-line messages.","x-found-in":"query"},"text_files":{"type":"array","items":{},"x-found-in":"body","x-body-root":true}}}

package/src/es/json/text_structure.test_grok_pattern.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.test_grok_pattern","description":"Test a Grok pattern.\n\nTest a Grok pattern on one or more lines of text.\nThe API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.","x-api":{"id":"text-structure.test_grok_pattern","name":"test-grok-pattern","namespace":"text-structure"},"x-method":"GET","x-path":"/_text_structure/test_grok_pattern","x-urls":[{"path":"/_text_structure/test_grok_pattern","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.13.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"ecs_compatibility":{"type":"string","description":"The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nValid values are `disabled` and `v1`.","x-found-in":"query"},"grok_pattern":{"type":"string","description":"The Grok pattern to run on the text.","x-found-in":"body"},"text":{"type":"array","items":{"type":"string"},"description":"The lines of text to run the Grok pattern on.","x-found-in":"body"}},"required":["grok_pattern","text"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.test_grok_pattern","description":"Test a Grok pattern.\n\nTest a Grok pattern on one or more lines of text.\nThe API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.","x-api":{"id":"text-structure.test_grok_pattern","name":"test-grok-pattern","namespace":"text-structure"},"x-method":"GET","x-path":"/_text_structure/test_grok_pattern","x-urls":[{"path":"/_text_structure/test_grok_pattern","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.13.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"ecs_compatibility":{"type":"string","description":"The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nValid values are `disabled` and `v1`.","x-found-in":"query"},"grok_pattern":{"type":"string","description":"The Grok pattern to run on the text.","x-found-in":"body"},"text":{"type":"array","items":{"type":"string"},"description":"The lines of text to run the Grok pattern on.","x-found-in":"body"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["grok_pattern","text"]}

package/src/es/json/transform._types.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"transform._types__Latest":{"type":"object","properties":{"sort":{"type":"string","description":"Specifies the date field that is used to identify the latest documents."},"unique_key":{"type":"array","items":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"description":"Specifies an array of one or more fields that are used to group the data."}},"required":["sort","unique_key"]},"transform._types__Pivot":{"type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"description":"Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket\nscript, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation,\nmin, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted\naverage."},"group_by":{"type":"object","additionalProperties":{"$ref":"./transform._types.json#/$defs/transform._types__PivotGroupByContainer"},"description":"Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are\ncurrently supported: date histogram, geotile grid, histogram, terms."}}},"transform._types__PivotGroupByContainer":{"type":"object","properties":{"date_histogram":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__DateHistogramAggregation"},"geotile_grid":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__GeoTileGridAggregation"},"histogram":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__HistogramAggregation"},"terms":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__TermsAggregation"}}},"transform._types__RetentionPolicyContainer":{"type":"object","properties":{"time":{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicy","description":"Specifies that the transform uses a time field to set the retention policy."}}},"transform._types__RetentionPolicy":{"type":"object","properties":{"field":{"type":"string","description":"The date field that is used to calculate the age of the document."},"max_age":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the maximum age of a document in the destination index. Documents that are older than the configured\nvalue are removed from the destination index."}},"required":["field","max_age"]},"transform._types__Settings":{"type":"object","properties":{"align_checkpoints":{"type":"boolean","description":"Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align\ncheckpoint ranges with the date histogram interval when date histogram is specified as a group source in the\ntransform config. As a result, less document updates in the destination index will be performed thus improving\noverall performance."},"dates_as_epoch_millis":{"type":"boolean","description":"Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was\nthe default for transforms created before version 7.11. For compatible output set this value to `true`."},"deduce_mappings":{"type":"boolean","description":"Specifies whether the transform should deduce the destination index mappings from the transform configuration."},"docs_per_second":{"type":"number","description":"Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a\nwait time between search requests. The default value is null, which disables throttling."},"max_page_search_size":{"type":"number","description":"Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker\nexceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is `10` and the\nmaximum is `65,536`. The default value is `500` for `pivot` transforms and `5000` for `latest` transforms."},"use_point_in_time":{"type":"boolean","description":"Specifies whether the transform checkpoint will use the Point In Time API while searching over the source index.\nIn general, Point In Time is an optimization that will reduce pressure on the source index by reducing the amount\nof refreshes and merges, but it can be expensive if a large number of Point In Times are opened and closed for a\ngiven index. The benefits and impact depend on the data being searched, the ingest rate into the source index, and\nthe amount of other consumers searching the same source index."},"num_failure_retries":{"type":"number","description":"Defines the number of retries on a recoverable failure before the transform task is marked as `failed`.\nThe minimum value is `0` and the maximum is `100`, where `-1` indicates that the transform retries indefinitely.\nIf unset, the cluster-level setting `num_transform_failure_retries` is used.\n\nThis setting cannot be specified when `unattended` is `true`, because unattended transforms always retry\nindefinitely.","x-availability":{"stack":{"since":"8.4.0"},"serverless":{}}},"unattended":{"type":"boolean","description":"If `true`, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case\nof an error which means the transform never fails. Setting the number of retries other than infinite fails in\nvalidation.","x-availability":{"stack":{"since":"8.5.0"},"serverless":{}}}},"description":"The source of the data for the transform."},"transform._types__Source":{"type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"The source indices for the transform. It can be a single index, an index pattern (for example, `\"my-index-*\"\"`), an\narray of indices (for example, `[\"my-index-000001\", \"my-index-000002\"]`), or an array of index patterns (for\nexample, `[\"my-index-*\", \"my-other-index-*\"]`. For remote indices use the syntax `\"remote_name:index_name\"`. If\nany indices are in remote clusters then the master node and at least one transform node must have the `remote_cluster_client` node role."},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"A query clause that retrieves a subset of data from the source index."},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data\nnodes, including remote nodes, must be 7.12 or later.","x-availability":{"stack":{"since":"7.12.0"},"serverless":{}}}},"required":["index"]},"transform._types__SyncContainer":{"type":"object","properties":{"time":{"$ref":"./transform._types.json#/$defs/transform._types__TimeSync","description":"Specifies that the transform uses a time field to synchronize the source and destination indices."}}},"transform._types__TimeSync":{"type":"object","properties":{"delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time delay between the current time and the latest input data time."},"field":{"type":"string","description":"The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field\nthat contains the ingest timestamp. If you use a different field, you might need to set the delay such that it\naccounts for data transmission delays."}},"required":["field"]},"transform._types__Destination":{"type":"object","properties":{"index":{"type":"string","description":"The destination index for the transform. The mappings of the destination index are deduced based on the source\nfields when possible. If alternate mappings are required, use the create index API prior to starting the\ntransform."},"pipeline":{"type":"string","description":"The unique identifier for an ingest pipeline."}}}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"transform._types__Destination":{"type":"object","properties":{"index":{"type":"string","description":"The destination index for the transform. The mappings of the destination index are deduced based on the source\nfields when possible. If alternate mappings are required, use the create index API prior to starting the\ntransform."},"aliases":{"type":"array","items":{"$ref":"./transform._types.json#/$defs/transform._types__DestinationAlias"},"description":"The aliases that the destination index for the transform should have.\nAliases are manipulated using the stored credentials of the transform, which means the secondary credentials\nsupplied at creation time (if both primary and secondary credentials are specified).\n\nThe destination index is added to the aliases regardless of whether the destination index was created by the\ntransform or pre-created by the user.","x-availability":{"stack":{"since":"8.8.0"},"serverless":{}}},"pipeline":{"type":"string","description":"The unique identifier for an ingest pipeline."}}},"transform._types__DestinationAlias":{"type":"object","properties":{"alias":{"type":"string","description":"The name of the alias."},"move_on_creation":{"type":"boolean","description":"Whether the destination index should be the only index in this alias.\nIf `true`, all the other indices will be removed from this alias before adding the destination index to this\nalias. This does not delete the removed indices; it only removes them from the alias."}},"required":["alias"]},"transform._types__Latest":{"type":"object","properties":{"sort":{"type":"string","description":"Specifies the date field that is used to identify the latest documents."},"unique_key":{"type":"array","items":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"description":"Specifies an array of one or more fields that are used to group the data."}},"required":["sort","unique_key"]},"transform._types__Pivot":{"type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"description":"Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket\nscript, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation,\nmin, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted\naverage."},"group_by":{"type":"object","additionalProperties":{"$ref":"./transform._types.json#/$defs/transform._types__PivotGroupByContainer"},"description":"Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are\ncurrently supported: date histogram, geotile grid, histogram, terms."}}},"transform._types__PivotGroupByContainer":{"type":"object","properties":{"date_histogram":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__DateHistogramAggregation"},"geotile_grid":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__GeoTileGridAggregation"},"histogram":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__HistogramAggregation"},"terms":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__TermsAggregation"}}},"transform._types__RetentionPolicyContainer":{"type":"object","properties":{"time":{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicy","description":"Specifies that the transform uses a time field to set the retention policy."}}},"transform._types__RetentionPolicy":{"type":"object","properties":{"field":{"type":"string","description":"The date field that is used to calculate the age of the document."},"max_age":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the maximum age of a document in the destination index. Documents that are older than the configured\nvalue are removed from the destination index."}},"required":["field","max_age"]},"transform._types__Settings":{"type":"object","properties":{"align_checkpoints":{"type":"boolean","description":"Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align\ncheckpoint ranges with the date histogram interval when date histogram is specified as a group source in the\ntransform config. As a result, less document updates in the destination index will be performed thus improving\noverall performance."},"dates_as_epoch_millis":{"type":"boolean","description":"Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was\nthe default for transforms created before version 7.11. For compatible output set this value to `true`."},"deduce_mappings":{"type":"boolean","description":"Specifies whether the transform should deduce the destination index mappings from the transform configuration."},"docs_per_second":{"type":"number","description":"Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a\nwait time between search requests. The default value is null, which disables throttling."},"max_page_search_size":{"type":"number","description":"Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker\nexceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is `10` and the\nmaximum is `65,536`. The default value is `500` for `pivot` transforms and `5000` for `latest` transforms."},"use_point_in_time":{"type":"boolean","description":"Specifies whether the transform checkpoint will use the Point In Time API while searching over the source index.\nIn general, Point In Time is an optimization that will reduce pressure on the source index by reducing the amount\nof refreshes and merges, but it can be expensive if a large number of Point In Times are opened and closed for a\ngiven index. The benefits and impact depend on the data being searched, the ingest rate into the source index, and\nthe amount of other consumers searching the same source index."},"num_failure_retries":{"type":"number","description":"Defines the number of retries on a recoverable failure before the transform task is marked as `failed`.\nThe minimum value is `0` and the maximum is `100`, where `-1` indicates that the transform retries indefinitely.\nIf unset, the cluster-level setting `num_transform_failure_retries` is used.\n\nThis setting cannot be specified when `unattended` is `true`, because unattended transforms always retry\nindefinitely.","x-availability":{"stack":{"since":"8.4.0"},"serverless":{}}},"unattended":{"type":"boolean","description":"If `true`, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case\nof an error which means the transform never fails. Setting the number of retries other than infinite fails in\nvalidation.","x-availability":{"stack":{"since":"8.5.0"},"serverless":{}}}},"description":"The source of the data for the transform."},"transform._types__Source":{"type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"The source indices for the transform. It can be a single index, an index pattern (for example, `\"my-index-*\"\"`), an\narray of indices (for example, `[\"my-index-000001\", \"my-index-000002\"]`), or an array of index patterns (for\nexample, `[\"my-index-*\", \"my-other-index-*\"]`. For remote indices use the syntax `\"remote_name:index_name\"`. If\nany indices are in remote clusters then the master node and at least one transform node must have the `remote_cluster_client` node role."},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"A query clause that retrieves a subset of data from the source index."},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data\nnodes, including remote nodes, must be 7.12 or later.","x-availability":{"stack":{"since":"7.12.0"},"serverless":{}}}},"required":["index"]},"transform._types__SyncContainer":{"type":"object","properties":{"time":{"$ref":"./transform._types.json#/$defs/transform._types__TimeSync","description":"Specifies that the transform uses a time field to synchronize the source and destination indices."}}},"transform._types__TimeSync":{"type":"object","properties":{"delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time delay between the current time and the latest input data time."},"field":{"type":"string","description":"The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field\nthat contains the ingest timestamp. If you use a different field, you might need to set the delay such that it\naccounts for data transmission delays."}},"required":["field"]}}}

package/src/es/json/transform.delete_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.delete_transform","description":"Delete a transform.","x-api":{"id":"transform.delete_transform","name":"delete-transform","namespace":"transform"},"x-method":"DELETE","x-path":"/_transform/{transform_id}","x-urls":[{"path":"/_transform/{transform_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"force":{"type":"boolean","description":"If this value is false, the transform must be stopped before it can be deleted. If true, the transform is\ndeleted regardless of its current state.","x-found-in":"query"},"delete_dest_index":{"type":"boolean","description":"If this value is true, the destination index is deleted together with the transform. If false, the destination\nindex will not be deleted","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"}},"required":["transform_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.delete_transform","description":"Delete a transform.","x-api":{"id":"transform.delete_transform","name":"delete-transform","namespace":"transform"},"x-method":"DELETE","x-path":"/_transform/{transform_id}","x-urls":[{"path":"/_transform/{transform_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"force":{"type":"boolean","description":"If this value is false, the transform must be stopped before it can be deleted. If true, the transform is\ndeleted regardless of its current state.","x-found-in":"query"},"delete_dest_index":{"type":"boolean","description":"If this value is true, the destination index is deleted together with the transform. If false, the destination\nindex will not be deleted","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["transform_id"]}

package/src/es/json/transform.get_node_stats.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"transform.get_node_stats__TransformNodeFullStats":{"type":"object","additionalProperties":{}}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"transform.get_node_stats__TransformNodeFullStats":{"type":"object","x-behavior":"AdditionalProperties","properties":{"total":{"$ref":"./transform.get_node_stats.json#/$defs/transform.get_node_stats__TransformNodeStats"}},"required":["total"],"additionalProperties":{"$ref":"./transform.get_node_stats.json#/$defs/transform.get_node_stats__TransformNodeStats","description":"Per node statistics"}},"transform.get_node_stats__TransformNodeStats":{"type":"object","properties":{"scheduler":{"$ref":"./transform.get_node_stats.json#/$defs/transform.get_node_stats__TransformSchedulerStats"}},"required":["scheduler"]},"transform.get_node_stats__TransformSchedulerStats":{"type":"object","properties":{"registered_transform_count":{"type":"number"},"peek_transform":{"type":"string"}},"required":["registered_transform_count"]}}}

package/src/es/json/transform.get_node_stats.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.get_node_stats","description":"Get node stats.\n\nGet per-node information about transform usage.","x-api":{"id":"transform.get_node_stats","name":"get-node-stats","namespace":"transform"},"x-method":"GET","x-path":"/_transform/_node_stats","x-urls":[{"path":"/_transform/_node_stats","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.15.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.get_node_stats","description":"Get node stats.\n\nGet per-node information about transform usage.","x-api":{"id":"transform.get_node_stats","name":"get-node-stats","namespace":"transform"},"x-method":"GET","x-path":"/_transform/_node_stats","x-urls":[{"path":"/_transform/_node_stats","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.15.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

package/src/es/json/transform.get_transform.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"transform.get_transform__TransformSummary":{"type":"object","properties":{"authorization":{"$ref":"./ml._types.json#/$defs/ml._types__TransformAuthorization","description":"The security privileges that the transform uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the transform, this property is omitted."},"create_time":{"description":"The time the transform was created."},"create_time_string":{"$ref":"./_types.json#/$defs/_types__DateTime"},"description":{"type":"string","description":"Free text description of the transform."},"dest":{"$ref":"./_global.reindex.json#/$defs/_global.reindex__Destination","description":"The destination for the transform."},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration"},"id":{"type":"string"},"latest":{"$ref":"./transform._types.json#/$defs/transform._types__Latest"},"pivot":{"$ref":"./transform._types.json#/$defs/transform._types__Pivot","description":"The pivot method transforms the data by aggregating and grouping it."},"retention_policy":{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings."},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform."},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously."},"version":{"type":"string","description":"The version of Elasticsearch that existed on the node when the transform was created."},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata"}},"required":["dest","id","source"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"transform.get_transform__TransformSummary":{"type":"object","properties":{"authorization":{"$ref":"./ml._types.json#/$defs/ml._types__TransformAuthorization","description":"The security privileges that the transform uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the transform, this property is omitted."},"create_time":{"description":"The time the transform was created."},"create_time_string":{"$ref":"./_types.json#/$defs/_types__DateTime"},"description":{"type":"string","description":"Free text description of the transform."},"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination","description":"The destination for the transform."},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration"},"id":{"type":"string"},"latest":{"$ref":"./transform._types.json#/$defs/transform._types__Latest"},"pivot":{"$ref":"./transform._types.json#/$defs/transform._types__Pivot","description":"The pivot method transforms the data by aggregating and grouping it."},"retention_policy":{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings."},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform."},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously."},"version":{"type":"string","description":"The version of Elasticsearch that existed on the node when the transform was created."},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata"}},"required":["dest","id","source"]}}}

package/src/es/json/transform.get_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.get_transform","description":"Get transforms.\n\nGet configuration information for transforms.","x-api":{"id":"transform.get_transform","name":"get-transform","namespace":"transform"},"x-method":"GET","x-path":"/_transform/{transform_id}","x-urls":[{"path":"/_transform/{transform_id}","methods":["GET"]},{"path":"/_transform","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no transforms that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf this parameter is false, the request returns a 404 status code when\nthere are no matches or only partial matches.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of transforms.","x-found-in":"query"},"size":{"type":"number","description":"Specifies the maximum number of transforms to obtain.","x-found-in":"query"},"exclude_generated":{"type":"boolean","description":"Excludes fields that were automatically added when creating the\ntransform. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.","x-found-in":"query"},"transform_id":{"$ref":"./_types.json#/$defs/_types__Names","description":"Identifier for the transform. It can be a transform identifier or a\nwildcard expression. You can get information for all transforms by using\n`_all`, by specifying `*` as the `<transform_id>`, or by omitting the\n`<transform_id>`.","x-found-in":"path"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.get_transform","description":"Get transforms.\n\nGet configuration information for transforms.","x-api":{"id":"transform.get_transform","name":"get-transform","namespace":"transform"},"x-method":"GET","x-path":"/_transform/{transform_id}","x-urls":[{"path":"/_transform/{transform_id}","methods":["GET"]},{"path":"/_transform","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no transforms that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf this parameter is false, the request returns a 404 status code when\nthere are no matches or only partial matches.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of transforms.","x-found-in":"query"},"size":{"type":"number","description":"Specifies the maximum number of transforms to obtain.","x-found-in":"query"},"exclude_generated":{"type":"boolean","description":"Excludes fields that were automatically added when creating the\ntransform. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.","x-found-in":"query"},"transform_id":{"$ref":"./_types.json#/$defs/_types__Names","description":"Identifier for the transform. It can be a transform identifier or a\nwildcard expression. You can get information for all transforms by using\n`_all`, by specifying `*` as the `<transform_id>`, or by omitting the\n`<transform_id>`.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

package/src/es/json/transform.get_transform_stats.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.get_transform_stats","description":"Get transform stats.\n\nGet usage information for transforms.","x-api":{"id":"transform.get_transform_stats","name":"get-transform-stats","namespace":"transform"},"x-method":"GET","x-path":"/_transform/{transform_id}/_stats","x-urls":[{"path":"/_transform/{transform_id}/_stats","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no transforms that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf this parameter is false, the request returns a 404 status code when\nthere are no matches or only partial matches.","x-found-in":"query"},"basic":{"type":"boolean","description":"If true, the response includes `id`, `state`, `node`, `stats`, `health`,\nand basic `checkpointing` information (the last and next checkpoint\nnumbers, and the next checkpoint's `position` and `progress`). Skips\nstatistics that require heavy computations to calculate:\n`operations_behind`, `changes_last_detected_at`, `last_search_time`, and\nthe checkpoint timestamps.","x-found-in":"query","x-availability":{"stack":{"since":"8.13.0"}}},"from":{"type":"number","description":"Skips the specified number of transforms.","x-found-in":"query"},"size":{"type":"number","description":"Specifies the maximum number of transforms to obtain.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Controls the time to wait for the stats","x-found-in":"query"},"transform_id":{"$ref":"./_types.json#/$defs/_types__Names","description":"Identifier for the transform. It can be a transform identifier or a\nwildcard expression. You can get information for all transforms by using\n`_all`, by specifying `*` as the `<transform_id>`, or by omitting the\n`<transform_id>`.","x-found-in":"path"}},"required":["transform_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.get_transform_stats","description":"Get transform stats.\n\nGet usage information for transforms.","x-api":{"id":"transform.get_transform_stats","name":"get-transform-stats","namespace":"transform"},"x-method":"GET","x-path":"/_transform/{transform_id}/_stats","x-urls":[{"path":"/_transform/{transform_id}/_stats","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no transforms that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf this parameter is false, the request returns a 404 status code when\nthere are no matches or only partial matches.","x-found-in":"query"},"basic":{"type":"boolean","description":"If true, the response includes `id`, `state`, `node`, `stats`, `health`,\nand basic `checkpointing` information (the last and next checkpoint\nnumbers, and the next checkpoint's `position` and `progress`). Skips\nstatistics that require heavy computations to calculate:\n`operations_behind`, `changes_last_detected_at`, `last_search_time`, and\nthe checkpoint timestamps.","x-found-in":"query","x-availability":{"stack":{"since":"8.13.0"}}},"from":{"type":"number","description":"Skips the specified number of transforms.","x-found-in":"query"},"size":{"type":"number","description":"Specifies the maximum number of transforms to obtain.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Controls the time to wait for the stats","x-found-in":"query"},"transform_id":{"$ref":"./_types.json#/$defs/_types__Names","description":"Identifier for the transform. It can be a transform identifier or a\nwildcard expression. You can get information for all transforms by using\n`_all`, by specifying `*` as the `<transform_id>`, or by omitting the\n`<transform_id>`.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["transform_id"]}

package/src/es/json/transform.preview_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.preview_transform","description":"Preview a transform.\n\nGenerates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.","x-api":{"id":"transform.preview_transform","name":"preview-transform","namespace":"transform"},"x-method":"GET","x-path":"/_transform/{transform_id}/_preview","x-urls":[{"path":"/_transform/{transform_id}/_preview","methods":["GET","POST"]},{"path":"/_transform/_preview","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.2.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.","x-found-in":"query"},"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination","description":"The destination for the transform.","x-found-in":"body"},"description":{"type":"string","description":"Free text description of the transform.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.","x-found-in":"body"},"pivot":{"$ref":"./transform._types.json#/$defs/transform._types__Pivot","description":"The pivot method transforms the data by aggregating and grouping it.\nThese objects define the group by fields and the aggregation to reduce\nthe data.","x-found-in":"body"},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform.","x-found-in":"body"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings.","x-found-in":"body"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously.","x-found-in":"body"},"retention_policy":{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer","description":"Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.","x-found-in":"body"},"latest":{"$ref":"./transform._types.json#/$defs/transform._types__Latest","description":"The latest method transforms the data by finding the latest document for\neach unique key.","x-found-in":"body"},"transform_id":{"type":"string","description":"Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform\nconfiguration details in the request body.","x-found-in":"path"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.preview_transform","description":"Preview a transform.\n\nGenerates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.","x-api":{"id":"transform.preview_transform","name":"preview-transform","namespace":"transform"},"x-method":"GET","x-path":"/_transform/{transform_id}/_preview","x-urls":[{"path":"/_transform/{transform_id}/_preview","methods":["GET","POST"]},{"path":"/_transform/_preview","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.2.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.","x-found-in":"query"},"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination","description":"The destination for the transform.","x-found-in":"body"},"description":{"type":"string","description":"Free text description of the transform.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.","x-found-in":"body"},"pivot":{"$ref":"./transform._types.json#/$defs/transform._types__Pivot","description":"The pivot method transforms the data by aggregating and grouping it.\nThese objects define the group by fields and the aggregation to reduce\nthe data.","x-found-in":"body"},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform.","x-found-in":"body"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings.","x-found-in":"body"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously.","x-found-in":"body"},"retention_policy":{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer","description":"Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.","x-found-in":"body"},"latest":{"$ref":"./transform._types.json#/$defs/transform._types__Latest","description":"The latest method transforms the data by finding the latest document for\neach unique key.","x-found-in":"body"},"transform_id":{"type":"string","description":"Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform\nconfiguration details in the request body.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

package/src/es/json/transform.put_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.put_transform","description":"Create a transform.\n\nCreates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.","x-api":{"id":"transform.put_transform","name":"put-transform","namespace":"transform"},"x-method":"PUT","x-path":"/_transform/{transform_id}","x-urls":[{"path":"/_transform/{transform_id}","methods":["PUT"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.2.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"defer_validation":{"type":"boolean","description":"When the transform is created, a series of validations occur to ensure its success. For example, there is a\ncheck for the existence of the source indices and a check that the destination index is not part of the source\nindex pattern. You can use this parameter to skip the checks, for example when the source index does not exist\nuntil after the transform is created. The validations are always run when you start the transform, however, with\nthe exception of privilege checks.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination","description":"The destination for the transform.","x-found-in":"body"},"description":{"type":"string","description":"Free text description of the transform.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval between checks for changes in the source indices when the transform is running continuously. Also\ndetermines the retry interval in the event of transient failures while the transform is searching or indexing.\nThe minimum value is `1s` and the maximum is `1h`.","x-found-in":"body"},"latest":{"$ref":"./transform._types.json#/$defs/transform._types__Latest","description":"The latest method transforms the data by finding the latest document for each unique key.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Defines optional transform metadata.","x-found-in":"body"},"pivot":{"$ref":"./transform._types.json#/$defs/transform._types__Pivot","description":"The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields\nand the aggregation to reduce the data.","x-found-in":"body"},"retention_policy":{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer","description":"Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the\ndestination index.","x-found-in":"body"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings.","x-found-in":"body"},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform.","x-found-in":"body"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously.","x-found-in":"body"},"transform_id":{"type":"string","description":"Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.","x-found-in":"path"}},"required":["transform_id","dest","source"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.put_transform","description":"Create a transform.\n\nCreates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.","x-api":{"id":"transform.put_transform","name":"put-transform","namespace":"transform"},"x-method":"PUT","x-path":"/_transform/{transform_id}","x-urls":[{"path":"/_transform/{transform_id}","methods":["PUT"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.2.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"defer_validation":{"type":"boolean","description":"When the transform is created, a series of validations occur to ensure its success. For example, there is a\ncheck for the existence of the source indices and a check that the destination index is not part of the source\nindex pattern. You can use this parameter to skip the checks, for example when the source index does not exist\nuntil after the transform is created. The validations are always run when you start the transform, however, with\nthe exception of privilege checks.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination","description":"The destination for the transform.","x-found-in":"body"},"description":{"type":"string","description":"Free text description of the transform.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval between checks for changes in the source indices when the transform is running continuously. Also\ndetermines the retry interval in the event of transient failures while the transform is searching or indexing.\nThe minimum value is `1s` and the maximum is `1h`.","x-found-in":"body"},"latest":{"$ref":"./transform._types.json#/$defs/transform._types__Latest","description":"The latest method transforms the data by finding the latest document for each unique key.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Defines optional transform metadata.","x-found-in":"body"},"pivot":{"$ref":"./transform._types.json#/$defs/transform._types__Pivot","description":"The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields\nand the aggregation to reduce the data.","x-found-in":"body"},"retention_policy":{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer","description":"Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the\ndestination index.","x-found-in":"body"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings.","x-found-in":"body"},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform.","x-found-in":"body"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously.","x-found-in":"body"},"transform_id":{"type":"string","description":"Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["transform_id","dest","source"]}

package/src/es/json/transform.reset_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.reset_transform","description":"Reset a transform.\n\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.","x-api":{"id":"transform.reset_transform","name":"reset-transform","namespace":"transform"},"x-method":"POST","x-path":"/_transform/{transform_id}/_reset","x-urls":[{"path":"/_transform/{transform_id}/_reset","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.1.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"force":{"type":"boolean","description":"If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform\nmust be stopped before it can be reset.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"transform_id":{"type":"string","description":"Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.","x-found-in":"path"}},"required":["transform_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.reset_transform","description":"Reset a transform.\n\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.","x-api":{"id":"transform.reset_transform","name":"reset-transform","namespace":"transform"},"x-method":"POST","x-path":"/_transform/{transform_id}/_reset","x-urls":[{"path":"/_transform/{transform_id}/_reset","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.1.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"force":{"type":"boolean","description":"If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform\nmust be stopped before it can be reset.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"transform_id":{"type":"string","description":"Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["transform_id"]}

package/src/es/json/transform.schedule_now_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.schedule_now_transform","description":"Schedule a transform to start now.\n\nInstantly run a transform to process data.\nIf you run this API, the transform will process the new data instantly,\nwithout waiting for the configured frequency interval. After the API is called,\nthe transform will be processed again at `now + frequency` unless the API\nis called again in the meantime.","x-api":{"id":"transform.schedule_now_transform","name":"schedule-now-transform","namespace":"transform"},"x-method":"POST","x-path":"/_transform/{transform_id}/_schedule_now","x-urls":[{"path":"/_transform/{transform_id}/_schedule_now","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.7.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Controls the time to wait for the scheduling to take place","x-found-in":"query"},"defer":{"type":"boolean","description":"When true, defers the scheduling by the transform's configured sync delay\ninstead of triggering immediately. The transform will process new data after\nthe delay elapses rather than right away.","x-found-in":"query","x-availability":{"stack":{"since":"9.4.0"},"serverless":{}}},"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"}},"required":["transform_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.schedule_now_transform","description":"Schedule a transform to start now.\n\nInstantly run a transform to process data.\nIf you run this API, the transform will process the new data instantly,\nwithout waiting for the configured frequency interval. After the API is called,\nthe transform will be processed again at `now + frequency` unless the API\nis called again in the meantime.","x-api":{"id":"transform.schedule_now_transform","name":"schedule-now-transform","namespace":"transform"},"x-method":"POST","x-path":"/_transform/{transform_id}/_schedule_now","x-urls":[{"path":"/_transform/{transform_id}/_schedule_now","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.7.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Controls the time to wait for the scheduling to take place","x-found-in":"query"},"defer":{"type":"boolean","description":"When true, defers the scheduling by the transform's configured sync delay\ninstead of triggering immediately. The transform will process new data after\nthe delay elapses rather than right away.","x-found-in":"query","x-availability":{"stack":{"since":"9.4.0"},"serverless":{}}},"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["transform_id"]}

package/src/es/json/transform.set_upgrade_mode.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.set_upgrade_mode","description":"Set upgrade_mode for transform indices.\n\nSets a cluster wide upgrade_mode setting that prepares transform\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your transform indices. In those circumstances,\nthere must be no transforms running. You can close the transforms,\ndo the upgrade, then open all the transforms again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the transforms\nand prevent new transforms from opening. You can also use this API\nduring upgrades that do not require you to reindex your transform\nindices, though stopping transforms is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\ntransform info API.","x-api":{"id":"transform.set_upgrade_mode","name":"set-upgrade-mode","namespace":"transform"},"x-method":"POST","x-path":"/_transform/set_upgrade_mode","x-urls":[{"path":"/_transform/set_upgrade_mode","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.18.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"enabled":{"type":"boolean","description":"When `true`, it enables `upgrade_mode` which temporarily halts all\ntransform tasks and prohibits new transform tasks from\nstarting.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time to wait for the request to be completed.","x-found-in":"query"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.set_upgrade_mode","description":"Set upgrade_mode for transform indices.\n\nSets a cluster wide upgrade_mode setting that prepares transform\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your transform indices. In those circumstances,\nthere must be no transforms running. You can close the transforms,\ndo the upgrade, then open all the transforms again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the transforms\nand prevent new transforms from opening. You can also use this API\nduring upgrades that do not require you to reindex your transform\nindices, though stopping transforms is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\ntransform info API.","x-api":{"id":"transform.set_upgrade_mode","name":"set-upgrade-mode","namespace":"transform"},"x-method":"POST","x-path":"/_transform/set_upgrade_mode","x-urls":[{"path":"/_transform/set_upgrade_mode","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.18.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"enabled":{"type":"boolean","description":"When `true`, it enables `upgrade_mode` which temporarily halts all\ntransform tasks and prohibits new transform tasks from\nstarting.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time to wait for the request to be completed.","x-found-in":"query"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

package/src/es/json/transform.start_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.start_transform","description":"Start a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.","x-api":{"id":"transform.start_transform","name":"start-transform","namespace":"transform"},"x-method":"POST","x-path":"/_transform/{transform_id}/_start","x-urls":[{"path":"/_transform/{transform_id}/_start","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"from":{"type":"string","description":"Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms.","x-found-in":"query"},"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"}},"required":["transform_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.start_transform","description":"Start a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.","x-api":{"id":"transform.start_transform","name":"start-transform","namespace":"transform"},"x-method":"POST","x-path":"/_transform/{transform_id}/_start","x-urls":[{"path":"/_transform/{transform_id}/_start","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"from":{"type":"string","description":"Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms.","x-found-in":"query"},"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["transform_id"]}

package/src/es/json/transform.stop_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.stop_transform","description":"Stop transforms.\n\nStops one or more transforms.","x-api":{"id":"transform.stop_transform","name":"stop-transform","namespace":"transform"},"x-method":"POST","x-path":"/_transform/{transform_id}/_stop","x-urls":[{"path":"/_transform/{transform_id}/_stop","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request: contains wildcard expressions and there are no transforms that match;\ncontains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there\nare only partial matches.\n\nIf it is true, the API returns a successful acknowledgement message when there are no matches. When there are\nonly partial matches, the API stops the appropriate transforms.\n\nIf it is false, the request returns a 404 status code when there are no matches or only partial matches.","x-found-in":"query"},"force":{"type":"boolean","description":"If it is true, the API forcefully stops the transforms.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the\ntimeout expires, the request returns a timeout exception. However, the request continues processing and\neventually moves the transform to a STOPPED state.","x-found-in":"query"},"wait_for_checkpoint":{"type":"boolean","description":"If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false,\nthe transform stops as soon as possible.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns\nimmediately and the indexer is stopped asynchronously in the background.","x-found-in":"query"},"transform_id":{"type":"string","description":"Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression.\nTo stop all transforms, use `_all` or `*` as the identifier.","x-found-in":"path"}},"required":["transform_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.stop_transform","description":"Stop transforms.\n\nStops one or more transforms.","x-api":{"id":"transform.stop_transform","name":"stop-transform","namespace":"transform"},"x-method":"POST","x-path":"/_transform/{transform_id}/_stop","x-urls":[{"path":"/_transform/{transform_id}/_stop","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request: contains wildcard expressions and there are no transforms that match;\ncontains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there\nare only partial matches.\n\nIf it is true, the API returns a successful acknowledgement message when there are no matches. When there are\nonly partial matches, the API stops the appropriate transforms.\n\nIf it is false, the request returns a 404 status code when there are no matches or only partial matches.","x-found-in":"query"},"force":{"type":"boolean","description":"If it is true, the API forcefully stops the transforms.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the\ntimeout expires, the request returns a timeout exception. However, the request continues processing and\neventually moves the transform to a STOPPED state.","x-found-in":"query"},"wait_for_checkpoint":{"type":"boolean","description":"If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false,\nthe transform stops as soon as possible.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns\nimmediately and the indexer is stopped asynchronously in the background.","x-found-in":"query"},"transform_id":{"type":"string","description":"Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression.\nTo stop all transforms, use `_all` or `*` as the identifier.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["transform_id"]}

package/src/es/json/transform.update_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.update_transform","description":"Update a transform.\n\nUpdates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.","x-api":{"id":"transform.update_transform","name":"update-transform","namespace":"transform"},"x-method":"POST","x-path":"/_transform/{transform_id}/_update","x-urls":[{"path":"/_transform/{transform_id}/_update","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.2.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"defer_validation":{"type":"boolean","description":"When true, deferrable validations are not run. This behavior may be\ndesired if the source index does not exist until after the transform is\ncreated.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.","x-found-in":"query"},"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination","description":"The destination for the transform.","x-found-in":"body"},"description":{"type":"string","description":"Free text description of the transform.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Defines optional transform metadata.","x-found-in":"body"},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform.","x-found-in":"body"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings.","x-found-in":"body"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously.","x-found-in":"body"},"retention_policy":{"anyOf":[{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer"},{"type":"null"}],"description":"Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.","x-found-in":"body"},"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"}},"required":["transform_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.update_transform","description":"Update a transform.\n\nUpdates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.","x-api":{"id":"transform.update_transform","name":"update-transform","namespace":"transform"},"x-method":"POST","x-path":"/_transform/{transform_id}/_update","x-urls":[{"path":"/_transform/{transform_id}/_update","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.2.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"defer_validation":{"type":"boolean","description":"When true, deferrable validations are not run. This behavior may be\ndesired if the source index does not exist until after the transform is\ncreated.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.","x-found-in":"query"},"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination","description":"The destination for the transform.","x-found-in":"body"},"description":{"type":"string","description":"Free text description of the transform.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Defines optional transform metadata.","x-found-in":"body"},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform.","x-found-in":"body"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings.","x-found-in":"body"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously.","x-found-in":"body"},"retention_policy":{"anyOf":[{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer"},{"type":"null"}],"description":"Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.","x-found-in":"body"},"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["transform_id"]}

package/src/es/json/transform.update_transform.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.update_transform","x-api":{"id":"transform.update_transform","name":"update-transform","namespace":"transform"},"type":"object","properties":{"authorization":{"$ref":"./ml._types.json#/$defs/ml._types__TransformAuthorization"},"create_time":{"type":"number"},"description":{"type":"string"},"dest":{"$ref":"./_global.reindex.json#/$defs/_global.reindex__Destination"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration"},"id":{"type":"string"},"latest":{"$ref":"./transform._types.json#/$defs/transform._types__Latest"},"pivot":{"$ref":"./transform._types.json#/$defs/transform._types__Pivot"},"retention_policy":{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings"},"source":{"$ref":"./_global.reindex.json#/$defs/_global.reindex__Source"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer"},"version":{"type":"string"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata"}},"required":["create_time","description","dest","id","settings","source","version"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.update_transform","x-api":{"id":"transform.update_transform","name":"update-transform","namespace":"transform"},"type":"object","properties":{"authorization":{"$ref":"./ml._types.json#/$defs/ml._types__TransformAuthorization"},"create_time":{"type":"number"},"description":{"type":"string"},"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration"},"id":{"type":"string"},"latest":{"$ref":"./transform._types.json#/$defs/transform._types__Latest"},"pivot":{"$ref":"./transform._types.json#/$defs/transform._types__Pivot"},"retention_policy":{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings"},"source":{"$ref":"./_global.reindex.json#/$defs/_global.reindex__Source"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer"},"version":{"type":"string"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata"}},"required":["create_time","description","dest","id","settings","source","version"]}

package/src/es/json/transform.upgrade_transforms.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.upgrade_transforms","description":"Upgrade all transforms.\n\nTransforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.\nYou may want to perform a recent cluster backup prior to the upgrade.","x-api":{"id":"transform.upgrade_transforms","name":"upgrade-transforms","namespace":"transform"},"x-method":"POST","x-path":"/_transform/_upgrade","x-urls":[{"path":"/_transform/_upgrade","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.16.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"dry_run":{"type":"boolean","description":"When true, the request checks for updates but does not run them.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and\nreturns an error.","x-found-in":"query"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.upgrade_transforms","description":"Upgrade all transforms.\n\nTransforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.\nYou may want to perform a recent cluster backup prior to the upgrade.","x-api":{"id":"transform.upgrade_transforms","name":"upgrade-transforms","namespace":"transform"},"x-method":"POST","x-path":"/_transform/_upgrade","x-urls":[{"path":"/_transform/_upgrade","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.16.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"dry_run":{"type":"boolean","description":"When true, the request checks for updates but does not run them.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and\nreturns an error.","x-found-in":"query"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}