@elastic/schemas 0.4.5 → 0.5.1

package/src/es/json/synonyms.delete_synonym_rule.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.delete_synonym_rule","$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymsUpdateResult"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.delete_synonym_rule","x-api":{"id":"synonyms.delete_synonym_rule","name":"delete-synonym-rule","namespace":"synonyms"},"$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymsUpdateResult"}

package/src/es/json/synonyms.get_synonym.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonym","type":"object","properties":{"from":{"type":"number","description":"The starting offset for synonym rules to retrieve.","x-found-in":"query"},"size":{"type":"number","description":"The max number of synonym rules to retrieve.","x-found-in":"query"},"search_after":{"type":"string","description":"The synonym rule ID to use as a cursor for pagination.\nThe next page of results will start after this rule ID.\nThis parameter cannot be used with `from`.","x-found-in":"query"},"id":{"type":"string","description":"The synonyms set identifier to retrieve.","x-found-in":"path"}},"required":["id"],"description":"Get a synonym set."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonym","description":"Get a synonym set.","x-api":{"id":"synonyms.get_synonym","name":"get-synonym","namespace":"synonyms"},"x-method":"GET","x-path":"/_synonyms/{id}","x-urls":[{"path":"/_synonyms/{id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"from":{"type":"number","description":"The starting offset for synonym rules to retrieve.","x-found-in":"query"},"size":{"type":"number","description":"The max number of synonym rules to retrieve.","x-found-in":"query"},"search_after":{"type":"string","description":"The synonym rule ID to use as a cursor for pagination.\nThe next page of results will start after this rule ID.\nThis parameter cannot be used with `from`.","x-found-in":"query","x-availability":{"stack":{"since":"9.5.0"},"serverless":{}}},"id":{"type":"string","description":"The synonyms set identifier to retrieve.","x-found-in":"path"}},"required":["id"]}

package/src/es/json/synonyms.get_synonym.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonym","type":"object","properties":{"count":{"type":"number","description":"The total number of synonyms rules that the synonyms set contains."},"synonyms_set":{"type":"array","items":{"$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymRuleRead"},"description":"Synonym rule details."}},"required":["count","synonyms_set"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonym","x-api":{"id":"synonyms.get_synonym","name":"get-synonym","namespace":"synonyms"},"type":"object","properties":{"count":{"type":"number","description":"The total number of synonyms rules that the synonyms set contains."},"synonyms_set":{"type":"array","items":{"$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymRuleRead"},"description":"Synonym rule details."}},"required":["count","synonyms_set"]}

package/src/es/json/synonyms.get_synonym_rule.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonym_rule","type":"object","properties":{"set_id":{"type":"string","description":"The ID of the synonym set to retrieve the synonym rule from.","x-found-in":"path"},"rule_id":{"type":"string","description":"The ID of the synonym rule to retrieve.","x-found-in":"path"}},"required":["set_id","rule_id"],"description":"Get a synonym rule.\n\nGet a synonym rule from a synonym set."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonym_rule","description":"Get a synonym rule.\n\nGet a synonym rule from a synonym set.","x-api":{"id":"synonyms.get_synonym_rule","name":"get-synonym-rule","namespace":"synonyms"},"x-method":"GET","x-path":"/_synonyms/{set_id}/{rule_id}","x-urls":[{"path":"/_synonyms/{set_id}/{rule_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"set_id":{"type":"string","description":"The ID of the synonym set to retrieve the synonym rule from.","x-found-in":"path"},"rule_id":{"type":"string","description":"The ID of the synonym rule to retrieve.","x-found-in":"path"}},"required":["set_id","rule_id"]}

package/src/es/json/synonyms.get_synonym_rule.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonym_rule","$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymRuleRead"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonym_rule","x-api":{"id":"synonyms.get_synonym_rule","name":"get-synonym-rule","namespace":"synonyms"},"$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymRuleRead"}

package/src/es/json/synonyms.get_synonyms_sets.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonyms_sets","type":"object","properties":{"from":{"type":"number","description":"The starting offset for synonyms sets to retrieve.","x-found-in":"query"},"size":{"type":"number","description":"The maximum number of synonyms sets to retrieve.","x-found-in":"query"}},"description":"Get all synonym sets.\n\nGet a summary of all defined synonym sets."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonyms_sets","description":"Get all synonym sets.\n\nGet a summary of all defined synonym sets.","x-api":{"id":"synonyms.get_synonyms_sets","name":"get-synonyms-sets","namespace":"synonyms"},"x-method":"GET","x-path":"/_synonyms","x-urls":[{"path":"/_synonyms","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"from":{"type":"number","description":"The starting offset for synonyms sets to retrieve.","x-found-in":"query"},"size":{"type":"number","description":"The maximum number of synonyms sets to retrieve.","x-found-in":"query"}}}

package/src/es/json/synonyms.get_synonyms_sets.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonyms_sets","type":"object","properties":{"count":{"type":"number","description":"The total number of synonyms sets defined."},"results":{"type":"array","items":{"$ref":"./synonyms.get_synonyms_sets.json#/$defs/synonyms.get_synonyms_sets__SynonymsSetItem"},"description":"The identifier and total number of defined synonym rules for each synonyms set."}},"required":["count","results"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonyms_sets","x-api":{"id":"synonyms.get_synonyms_sets","name":"get-synonyms-sets","namespace":"synonyms"},"type":"object","properties":{"count":{"type":"number","description":"The total number of synonyms sets defined."},"results":{"type":"array","items":{"$ref":"./synonyms.get_synonyms_sets.json#/$defs/synonyms.get_synonyms_sets__SynonymsSetItem"},"description":"The identifier and total number of defined synonym rules for each synonyms set."}},"required":["count","results"]}

package/src/es/json/synonyms.put_synonym.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.put_synonym","type":"object","properties":{"refresh":{"type":"boolean","description":"If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym set","x-found-in":"query"},"append":{"type":"boolean","description":"If `true`, the provided synonym rules are appended to the existing set, with matching IDs overwriting existing rules.\nIf `false`, the entire synonyms set is replaced with the new synonym rules definitions.","x-found-in":"query"},"synonyms_set":{"anyOf":[{"$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymRule"},{"type":"array","items":{"$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymRule"}}],"description":"The synonym rules definitions for the synonyms set.","x-found-in":"body"},"id":{"type":"string","description":"The ID of the synonyms set to be created or updated.","x-found-in":"path"}},"required":["id","synonyms_set"],"description":"Create or update a synonym set.\n\nSynonym sets are limited to a maximum of 100,000 synonym rules per set by default.\nThis limit is configurable using the `synonyms.max_synonym_rules` cluster setting.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\n\nFor practical examples of how to create or update a synonyms set, refer to the External documentation."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.put_synonym","description":"Create or update a synonym set.\n\nSynonym sets are limited to a maximum of 100,000 synonym rules per set by default.\nThis limit is configurable using the `synonyms.max_synonym_rules` cluster setting.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\n\nFor practical examples of how to create or update a synonyms set, refer to the External documentation.","x-api":{"id":"synonyms.put_synonym","name":"put-synonym","namespace":"synonyms"},"x-method":"PUT","x-path":"/_synonyms/{id}","x-urls":[{"path":"/_synonyms/{id}","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"refresh":{"type":"boolean","description":"If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym set","x-found-in":"query","x-availability":{"stack":{"since":"9.1.0"}}},"append":{"type":"boolean","description":"If `true`, the provided synonym rules are appended to the existing set, with matching IDs overwriting existing rules.\nIf `false`, the entire synonyms set is replaced with the new synonym rules definitions.","x-found-in":"query","x-availability":{"stack":{"since":"9.5.0"},"serverless":{}}},"synonyms_set":{"anyOf":[{"$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymRule"},{"type":"array","items":{"$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymRule"}}],"description":"The synonym rules definitions for the synonyms set.","x-found-in":"body"},"id":{"type":"string","description":"The ID of the synonyms set to be created or updated.","x-found-in":"path"}},"required":["id","synonyms_set"]}

package/src/es/json/synonyms.put_synonym.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.put_synonym","type":"object","properties":{"result":{"$ref":"./_types.json#/$defs/_types__Result","description":"The update operation result."},"reload_analyzers_details":{"$ref":"./indices.reload_search_analyzers.json#/$defs/indices.reload_search_analyzers__ReloadResult","description":"Updating a synonyms set can reload the associated analyzers in case refresh is set to true.\nThis information is the analyzers reloading result."}},"required":["result"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.put_synonym","x-api":{"id":"synonyms.put_synonym","name":"put-synonym","namespace":"synonyms"},"type":"object","properties":{"result":{"$ref":"./_types.json#/$defs/_types__Result","description":"The update operation result."},"reload_analyzers_details":{"$ref":"./indices.reload_search_analyzers.json#/$defs/indices.reload_search_analyzers__ReloadResult","description":"Updating a synonyms set can reload the associated analyzers in case refresh is set to true.\nThis information is the analyzers reloading result."}},"required":["result"]}

package/src/es/json/synonyms.put_synonym_rule.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.put_synonym_rule","type":"object","properties":{"refresh":{"type":"boolean","description":"If `true`, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym rule","x-found-in":"query"},"synonyms":{"type":"string","description":"The synonym rule information definition, which must be in Solr format.","x-found-in":"body"},"set_id":{"type":"string","description":"The ID of the synonym set.","x-found-in":"path"},"rule_id":{"type":"string","description":"The ID of the synonym rule to be updated or created.","x-found-in":"path"}},"required":["set_id","rule_id","synonyms"],"description":"Create or update a synonym rule.\n\nCreate or update a synonym rule in a synonym set.\n\nIf any of the synonym rules included is invalid, the API returns an error.\n\nWhen you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.put_synonym_rule","description":"Create or update a synonym rule.\n\nCreate or update a synonym rule in a synonym set.\n\nIf any of the synonym rules included is invalid, the API returns an error.\n\nWhen you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.","x-api":{"id":"synonyms.put_synonym_rule","name":"put-synonym-rule","namespace":"synonyms"},"x-method":"PUT","x-path":"/_synonyms/{set_id}/{rule_id}","x-urls":[{"path":"/_synonyms/{set_id}/{rule_id}","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"refresh":{"type":"boolean","description":"If `true`, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym rule","x-found-in":"query","x-availability":{"stack":{"since":"9.1.0"}}},"synonyms":{"type":"string","description":"The synonym rule information definition, which must be in Solr format.","x-found-in":"body"},"set_id":{"type":"string","description":"The ID of the synonym set.","x-found-in":"path"},"rule_id":{"type":"string","description":"The ID of the synonym rule to be updated or created.","x-found-in":"path"}},"required":["set_id","rule_id","synonyms"]}

package/src/es/json/synonyms.put_synonym_rule.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.put_synonym_rule","$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymsUpdateResult"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.put_synonym_rule","x-api":{"id":"synonyms.put_synonym_rule","name":"put-synonym-rule","namespace":"synonyms"},"$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymsUpdateResult"}

package/src/es/json/tasks.cancel.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.cancel","type":"object","properties":{"actions":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list or wildcard expression of actions that is used to limit the request.","x-found-in":"query"},"nodes":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of node IDs or names that is used to limit the request.","x-found-in":"query"},"parent_task_id":{"type":"string","description":"A parent task ID that is used to limit the tasks.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If true, the request blocks until all found tasks are complete.","x-found-in":"query"},"task_id":{"type":"string","description":"The task identifier.","x-found-in":"path"}},"description":"Cancel a task.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nA task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away.\nIt is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation.\nThe get task information API will continue to list these cancelled tasks until they complete.\nThe cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.\n\nTo troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running.\nYou can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.cancel","description":"Cancel a task.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nA task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away.\nIt is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation.\nThe get task information API will continue to list these cancelled tasks until they complete.\nThe cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.\n\nTo troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running.\nYou can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task.","x-api":{"id":"tasks.cancel","name":"cancel","namespace":"tasks"},"x-method":"POST","x-path":"/_tasks/{task_id}/_cancel","x-urls":[{"path":"/_tasks/_cancel","methods":["POST"]},{"path":"/_tasks/{task_id}/_cancel","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"2.3.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"private"}},"type":"object","properties":{"actions":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list or wildcard expression of actions that is used to limit the request.","x-found-in":"query"},"nodes":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of node IDs or names that is used to limit the request.","x-found-in":"query"},"parent_task_id":{"type":"string","description":"A parent task ID that is used to limit the tasks.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If true, the request blocks until all found tasks are complete.","x-found-in":"query"},"task_id":{"type":"string","description":"The task identifier.","x-found-in":"path"}}}

package/src/es/json/tasks.cancel.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.cancel","$ref":"./tasks._types.json#/$defs/tasks._types__TaskListResponseBase"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.cancel","x-api":{"id":"tasks.cancel","name":"cancel","namespace":"tasks"},"$ref":"./tasks._types.json#/$defs/tasks._types__TaskListResponseBase"}

package/src/es/json/tasks.get.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.get","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the task has completed.","x-found-in":"query"},"task_id":{"type":"string","description":"The task identifier.","x-found-in":"path"}},"required":["task_id"],"description":"Get task information.\n\nGet information about a task currently running in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nIf the task identifier is not found, a 404 response code indicates that there are no resources that match the request.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.get","description":"Get task information.\n\nGet information about a task currently running in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nIf the task identifier is not found, a 404 response code indicates that there are no resources that match the request.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task.","x-api":{"id":"tasks.get","name":"get","namespace":"tasks"},"x-method":"GET","x-path":"/_tasks/{task_id}","x-urls":[{"path":"/_tasks/{task_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"5.0.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the task has completed.","x-found-in":"query"},"task_id":{"type":"string","description":"The task identifier.","x-found-in":"path"}},"required":["task_id"]}

package/src/es/json/tasks.get.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.get","type":"object","properties":{"completed":{"type":"boolean"},"task":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfo"},"response":{},"error":{"$ref":"./_types.json#/$defs/_types__ErrorCause"}},"required":["completed","task"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.get","x-api":{"id":"tasks.get","name":"get","namespace":"tasks"},"type":"object","properties":{"completed":{"type":"boolean"},"task":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfo"},"response":{},"error":{"$ref":"./_types.json#/$defs/_types__ErrorCause"}},"required":["completed","task"]}

package/src/es/json/tasks.list.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.list","type":"object","properties":{"actions":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list or wildcard expression of actions used to limit the request.\nFor example, you can use `cluser:*` to retrieve all cluster-related tasks.","x-found-in":"query"},"detailed":{"type":"boolean","description":"If `true`, the response includes detailed information about the running tasks.\nThis information is useful to distinguish tasks from each other but is more costly to run.","x-found-in":"query"},"group_by":{"$ref":"./tasks._types.json#/$defs/tasks._types__GroupBy","description":"A key that is used to group tasks in the response.\nThe task lists can be grouped either by nodes or by parent tasks.","x-found-in":"query"},"nodes":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"A comma-separated list of node IDs or names that is used to limit the returned information.","x-found-in":"query"},"parent_task_id":{"type":"string","description":"A parent task identifier that is used to limit returned information.\nTo return all tasks, omit this parameter or use a value of `-1`.\nIf the parent task is not found, the API does not return a 404 response code.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for each node to respond.\nIf a node does not respond before its timeout expires, the response does not include its information.\nHowever, timed out nodes are included in the `node_failures` property.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the operation is complete.","x-found-in":"query"}},"description":"Get all tasks.\n\nGet information about the tasks currently running on one or more nodes in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task.\n\n**Identifying running tasks**\n\nThe `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information.\nThis enables you to track certain calls or associate certain tasks with the client that started them.\nFor example:\n\n```\ncurl -i -H \"X-Opaque-Id: 123456\" \"http://localhost:9200/_tasks?group_by=parents\"\n```\n\nThe API returns the following result:\n\n```\nHTTP/1.1 200 OK\nX-Opaque-Id: 123456\ncontent-type: application/json; charset=UTF-8\ncontent-length: 831\n\n{\n  \"tasks\" : {\n    \"u5lcZHqcQhu-rUoFaqDphA:45\" : {\n      \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n      \"id\" : 45,\n      \"type\" : \"transport\",\n      \"action\" : \"cluster:monitor/tasks/lists\",\n      \"start_time_in_millis\" : 1513823752749,\n      \"running_time_in_nanos\" : 293139,\n      \"cancellable\" : false,\n      \"headers\" : {\n        \"X-Opaque-Id\" : \"123456\"\n      },\n      \"children\" : [\n        {\n          \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n          \"id\" : 46,\n          \"type\" : \"direct\",\n          \"action\" : \"cluster:monitor/tasks/lists[n]\",\n          \"start_time_in_millis\" : 1513823752750,\n          \"running_time_in_nanos\" : 92133,\n          \"cancellable\" : false,\n          \"parent_task_id\" : \"u5lcZHqcQhu-rUoFaqDphA:45\",\n          \"headers\" : {\n            \"X-Opaque-Id\" : \"123456\"\n          }\n        }\n      ]\n    }\n  }\n }\n```\nIn this example, `X-Opaque-Id: 123456` is the ID as a part of the response header.\nThe `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request.\nThe `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.list","description":"Get all tasks.\n\nGet information about the tasks currently running on one or more nodes in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task.\n\n**Identifying running tasks**\n\nThe `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information.\nThis enables you to track certain calls or associate certain tasks with the client that started them.\nFor example:\n\n```\ncurl -i -H \"X-Opaque-Id: 123456\" \"http://localhost:9200/_tasks?group_by=parents\"\n```\n\nThe API returns the following result:\n\n```\nHTTP/1.1 200 OK\nX-Opaque-Id: 123456\ncontent-type: application/json; charset=UTF-8\ncontent-length: 831\n\n{\n  \"tasks\" : {\n    \"u5lcZHqcQhu-rUoFaqDphA:45\" : {\n      \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n      \"id\" : 45,\n      \"type\" : \"transport\",\n      \"action\" : \"cluster:monitor/tasks/lists\",\n      \"start_time_in_millis\" : 1513823752749,\n      \"running_time_in_nanos\" : 293139,\n      \"cancellable\" : false,\n      \"headers\" : {\n        \"X-Opaque-Id\" : \"123456\"\n      },\n      \"children\" : [\n        {\n          \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n          \"id\" : 46,\n          \"type\" : \"direct\",\n          \"action\" : \"cluster:monitor/tasks/lists[n]\",\n          \"start_time_in_millis\" : 1513823752750,\n          \"running_time_in_nanos\" : 92133,\n          \"cancellable\" : false,\n          \"parent_task_id\" : \"u5lcZHqcQhu-rUoFaqDphA:45\",\n          \"headers\" : {\n            \"X-Opaque-Id\" : \"123456\"\n          }\n        }\n      ]\n    }\n  }\n }\n```\nIn this example, `X-Opaque-Id: 123456` is the ID as a part of the response header.\nThe `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request.\nThe `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request.","x-api":{"id":"tasks.list","name":"list","namespace":"tasks"},"x-method":"GET","x-path":"/_tasks","x-urls":[{"path":"/_tasks","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"2.3.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"private"}},"type":"object","properties":{"actions":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list or wildcard expression of actions used to limit the request.\nFor example, you can use `cluser:*` to retrieve all cluster-related tasks.","x-found-in":"query"},"detailed":{"type":"boolean","description":"If `true`, the response includes detailed information about the running tasks.\nThis information is useful to distinguish tasks from each other but is more costly to run.","x-found-in":"query"},"group_by":{"$ref":"./tasks._types.json#/$defs/tasks._types__GroupBy","description":"A key that is used to group tasks in the response.\nThe task lists can be grouped either by nodes or by parent tasks.","x-found-in":"query"},"nodes":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"A comma-separated list of node IDs or names that is used to limit the returned information.","x-found-in":"query"},"parent_task_id":{"type":"string","description":"A parent task identifier that is used to limit returned information.\nTo return all tasks, omit this parameter or use a value of `-1`.\nIf the parent task is not found, the API does not return a 404 response code.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for each node to respond.\nIf a node does not respond before its timeout expires, the response does not include its information.\nHowever, timed out nodes are included in the `node_failures` property.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the operation is complete.","x-found-in":"query"}}}

package/src/es/json/tasks.list.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.list","$ref":"./tasks._types.json#/$defs/tasks._types__TaskListResponseBase"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.list","x-api":{"id":"tasks.list","name":"list","namespace":"tasks"},"$ref":"./tasks._types.json#/$defs/tasks._types__TaskListResponseBase"}

package/src/es/json/terms_enum.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"terms_enum","type":"object","properties":{"field":{"type":"string","description":"The string to match at the start of indexed terms. If not provided, all terms in the field are considered.","x-found-in":"body"},"size":{"type":"number","description":"The number of matching terms to return.","x-found-in":"body"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum length of time to spend collecting results.\nIf the timeout is exceeded the `complete` flag set to `false` in the response and the results may be partial or empty.","x-found-in":"body"},"case_insensitive":{"type":"boolean","description":"When `true`, the provided search string is matched against index terms without case sensitivity.","x-found-in":"body"},"index_filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Filter an index shard if the provided query rewrites to `match_none`.","x-found-in":"body"},"string":{"type":"string","description":"The string to match at the start of indexed terms.\nIf it is not provided, all terms in the field are considered.\n\n> info\n> The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766.","x-found-in":"body"},"search_after":{"type":"string","description":"The string after which terms in the index should be returned.\nIt allows for a form of pagination if the last result from one request is passed as the `search_after` parameter for a subsequent request.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and index aliases to search.\nWildcard (`*`) expressions are supported.\nTo search all data streams or indices, omit this parameter or use `*`  or `_all`.","x-found-in":"path"}},"required":["index","field"],"description":"Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis API is designed for low-latency look-ups used in auto-complete scenarios.\n\n> info\n> The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"terms_enum","description":"Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis API is designed for low-latency look-ups used in auto-complete scenarios.\n\n> info\n> The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.","x-api":{"id":"terms_enum","name":"terms-enum","namespace":null},"x-method":"GET","x-path":"/{index}/_terms_enum","x-urls":[{"path":"/{index}/_terms_enum","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.14.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"field":{"type":"string","description":"The string to match at the start of indexed terms. If not provided, all terms in the field are considered.","x-found-in":"body"},"size":{"type":"number","description":"The number of matching terms to return.","x-found-in":"body"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum length of time to spend collecting results.\nIf the timeout is exceeded the `complete` flag set to `false` in the response and the results may be partial or empty.","x-found-in":"body"},"case_insensitive":{"type":"boolean","description":"When `true`, the provided search string is matched against index terms without case sensitivity.","x-found-in":"body"},"index_filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Filter an index shard if the provided query rewrites to `match_none`.","x-found-in":"body"},"string":{"type":"string","description":"The string to match at the start of indexed terms.\nIf it is not provided, all terms in the field are considered.\n\n> info\n> The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766.","x-found-in":"body"},"search_after":{"type":"string","description":"The string after which terms in the index should be returned.\nIt allows for a form of pagination if the last result from one request is passed as the `search_after` parameter for a subsequent request.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and index aliases to search.\nWildcard (`*`) expressions are supported.\nTo search all data streams or indices, omit this parameter or use `*`  or `_all`.","x-found-in":"path"}},"required":["index","field"]}

package/src/es/json/terms_enum.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"terms_enum","type":"object","properties":{"_shards":{"$ref":"./_types.json#/$defs/_types__ShardStatistics"},"terms":{"type":"array","items":{"type":"string"}},"complete":{"type":"boolean","description":"If `false`, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error."}},"required":["_shards","terms","complete"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"terms_enum","x-api":{"id":"terms_enum","name":"terms-enum","namespace":null},"type":"object","properties":{"_shards":{"$ref":"./_types.json#/$defs/_types__ShardStatistics"},"terms":{"type":"array","items":{"type":"string"}},"complete":{"type":"boolean","description":"If `false`, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error."}},"required":["_shards","terms","complete"]}

package/src/es/json/termvectors.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"termvectors","type":"object","properties":{"fields":{"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":"A list of fields to include in the statistics.\nIt is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.","x-found-in":"body"},"field_statistics":{"type":"boolean","description":"If `true`, the response includes:\n\n* The document count (how many documents contain this field).\n* The sum of document frequencies (the sum of document frequencies for all terms in this field).\n* The sum of total term frequencies (the sum of total term frequencies of each term in this field).","x-found-in":"body"},"offsets":{"type":"boolean","description":"If `true`, the response includes term offsets.","x-found-in":"body"},"payloads":{"type":"boolean","description":"If `true`, the response includes term payloads.","x-found-in":"body"},"positions":{"type":"boolean","description":"If `true`, the response includes term positions.","x-found-in":"body"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"realtime":{"type":"boolean","description":"If true, the request is real-time as opposed to near-real-time.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value that is used to route operations to a specific shard.","x-found-in":"body"},"term_statistics":{"type":"boolean","description":"If `true`, the response includes:\n\n* The total term frequency (how often a term occurs in all documents).\n* The document frequency (the number of documents containing the current term).\n\nBy default these values are not returned since term statistics can have a serious performance impact.","x-found-in":"body"},"version":{"type":"number","description":"If `true`, returns the document version as part of a hit.","x-found-in":"body"},"version_type":{"$ref":"./_types.json#/$defs/_types__VersionType","description":"The version type.","x-found-in":"body"},"doc":{"description":"An artificial document (a document not present in the index) for which you want to retrieve term vectors.","x-found-in":"body"},"filter":{"$ref":"./_global.termvectors.json#/$defs/_global.termvectors__Filter","description":"Filter terms based on their tf-idf scores.\nThis could be useful in order find out a good characteristic vector of a document.\nThis feature works in a similar manner to the second phase of the More Like This Query.","x-found-in":"body"},"per_field_analyzer":{"type":"object","additionalProperties":{"type":"string"},"description":"Override the default per-field analyzer.\nThis is useful in order to generate term vectors in any fashion, especially when using artificial documents.\nWhen providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated.","x-found-in":"body"},"index":{"type":"string","description":"The name of the index that contains the document.","x-found-in":"path"},"id":{"type":"string","description":"A unique identifier for the document.","x-found-in":"path"}},"required":["index"],"description":"Get term vector information.\n\nGet information and statistics about terms in the fields of a particular document.\n\nYou can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.\nYou can specify the fields you are interested in through the `fields` parameter or by adding the fields to the request body.\nFor example:\n\n```\nGET /my-index-000001/_termvectors/1?fields=message\n```\n\nFields can be specified using wildcards, similar to the multi match query.\n\nTerm vectors are real-time by default, not near real-time.\nThis can be changed by setting `realtime` parameter to `false`.\n\nYou can request three types of values: _term information_, _term statistics_, and _field statistics_.\nBy default, all term information and field statistics are returned for all fields but term statistics are excluded.\n\n**Term information**\n\n* term frequency in the field (always returned)\n* term positions (`positions: true`)\n* start and end offsets (`offsets: true`)\n* term payloads (`payloads: true`), as base64 encoded bytes\n\nIf the requested information wasn't stored in the index, it will be computed on the fly if possible.\nAdditionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.\n\n> warn\n> Start and end offsets assume UTF-16 encoding is being used. If you want to use these offsets in order to get the original text that produced this token, you should make sure that the string you are taking a sub-string of is also encoded using UTF-16.\n\n**Behaviour**\n\nThe term and field statistics are not accurate.\nDeleted documents are not taken into account.\nThe information is only retrieved for the shard the requested document resides in.\nThe term and field statistics are therefore only useful as relative measures whereas the absolute numbers have no meaning in this context.\nBy default, when requesting term vectors of artificial documents, a shard to get the statistics from is randomly selected.\nUse `routing` only to hit a particular shard.\nRefer to the linked documentation for detailed examples of how to use this API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"termvectors","description":"Get term vector information.\n\nGet information and statistics about terms in the fields of a particular document.\n\nYou can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.\nYou can specify the fields you are interested in through the `fields` parameter or by adding the fields to the request body.\nFor example:\n\n```\nGET /my-index-000001/_termvectors/1?fields=message\n```\n\nFields can be specified using wildcards, similar to the multi match query.\n\nTerm vectors are real-time by default, not near real-time.\nThis can be changed by setting `realtime` parameter to `false`.\n\nYou can request three types of values: _term information_, _term statistics_, and _field statistics_.\nBy default, all term information and field statistics are returned for all fields but term statistics are excluded.\n\n**Term information**\n\n* term frequency in the field (always returned)\n* term positions (`positions: true`)\n* start and end offsets (`offsets: true`)\n* term payloads (`payloads: true`), as base64 encoded bytes\n\nIf the requested information wasn't stored in the index, it will be computed on the fly if possible.\nAdditionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.\n\n> warn\n> Start and end offsets assume UTF-16 encoding is being used. If you want to use these offsets in order to get the original text that produced this token, you should make sure that the string you are taking a sub-string of is also encoded using UTF-16.\n\n**Behaviour**\n\nThe term and field statistics are not accurate.\nDeleted documents are not taken into account.\nThe information is only retrieved for the shard the requested document resides in.\nThe term and field statistics are therefore only useful as relative measures whereas the absolute numbers have no meaning in this context.\nBy default, when requesting term vectors of artificial documents, a shard to get the statistics from is randomly selected.\nUse `routing` only to hit a particular shard.\nRefer to the linked documentation for detailed examples of how to use this API.","x-api":{"id":"termvectors","name":"termvectors","namespace":null},"x-method":"GET","x-path":"/{index}/_termvectors/{id}","x-urls":[{"path":"/{index}/_termvectors/{id}","methods":["GET","POST"]},{"path":"/{index}/_termvectors","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"fields":{"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":"A list of fields to include in the statistics.\nIt is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.","x-found-in":"body"},"field_statistics":{"type":"boolean","description":"If `true`, the response includes:\n\n* The document count (how many documents contain this field).\n* The sum of document frequencies (the sum of document frequencies for all terms in this field).\n* The sum of total term frequencies (the sum of total term frequencies of each term in this field).","x-found-in":"body"},"offsets":{"type":"boolean","description":"If `true`, the response includes term offsets.","x-found-in":"body"},"payloads":{"type":"boolean","description":"If `true`, the response includes term payloads.","x-found-in":"body"},"positions":{"type":"boolean","description":"If `true`, the response includes term positions.","x-found-in":"body"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"realtime":{"type":"boolean","description":"If true, the request is real-time as opposed to near-real-time.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value that is used to route operations to a specific shard.","x-found-in":"body"},"term_statistics":{"type":"boolean","description":"If `true`, the response includes:\n\n* The total term frequency (how often a term occurs in all documents).\n* The document frequency (the number of documents containing the current term).\n\nBy default these values are not returned since term statistics can have a serious performance impact.","x-found-in":"body"},"version":{"type":"number","description":"If `true`, returns the document version as part of a hit.","x-found-in":"body"},"version_type":{"$ref":"./_types.json#/$defs/_types__VersionType","description":"The version type.","x-found-in":"body"},"doc":{"description":"An artificial document (a document not present in the index) for which you want to retrieve term vectors.","x-found-in":"body"},"filter":{"$ref":"./_global.termvectors.json#/$defs/_global.termvectors__Filter","description":"Filter terms based on their tf-idf scores.\nThis could be useful in order find out a good characteristic vector of a document.\nThis feature works in a similar manner to the second phase of the More Like This Query.","x-found-in":"body"},"per_field_analyzer":{"type":"object","additionalProperties":{"type":"string"},"description":"Override the default per-field analyzer.\nThis is useful in order to generate term vectors in any fashion, especially when using artificial documents.\nWhen providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated.","x-found-in":"body"},"index":{"type":"string","description":"The name of the index that contains the document.","x-found-in":"path"},"id":{"type":"string","description":"A unique identifier for the document.","x-found-in":"path"}},"required":["index"]}

package/src/es/json/termvectors.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"termvectors","type":"object","properties":{"found":{"type":"boolean"},"_id":{"type":"string"},"_index":{"type":"string"},"term_vectors":{"type":"object","additionalProperties":{"$ref":"./_global.termvectors.json#/$defs/_global.termvectors__TermVector"}},"took":{"type":"number"},"_version":{"type":"number"}},"required":["found","_index","took","_version"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"termvectors","x-api":{"id":"termvectors","name":"termvectors","namespace":null},"type":"object","properties":{"found":{"type":"boolean"},"_id":{"type":"string"},"_index":{"type":"string"},"term_vectors":{"type":"object","additionalProperties":{"$ref":"./_global.termvectors.json#/$defs/_global.termvectors__TermVector"}},"took":{"type":"number"},"_version":{"type":"number"}},"required":["found","_index","took","_version"]}

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","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"],"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."}
+{"$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"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_field_structure","type":"object","properties":{"charset":{"type":"string"},"ecs_compatibility":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__EcsCompatibilityType"},"field_stats":{"type":"object","additionalProperties":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FieldStat"}},"format":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FormatType"},"grok_pattern":{"type":"string"},"java_timestamp_formats":{"type":"array","items":{"type":"string"}},"joda_timestamp_formats":{"type":"array","items":{"type":"string"}},"ingest_pipeline":{"$ref":"./ingest._types.json#/$defs/ingest._types__PipelineConfig"},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping"},"multiline_start_pattern":{"type":"string"},"need_client_timezone":{"type":"boolean"},"num_lines_analyzed":{"type":"number"},"num_messages_analyzed":{"type":"number"},"sample_start":{"type":"string"},"timestamp_field":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."}},"required":["charset","field_stats","format","ingest_pipeline","mappings","need_client_timezone","num_lines_analyzed","num_messages_analyzed","sample_start"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_field_structure","x-api":{"id":"text-structure.find_field_structure","name":"find-field-structure","namespace":"text-structure"},"type":"object","properties":{"charset":{"type":"string"},"ecs_compatibility":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__EcsCompatibilityType"},"field_stats":{"type":"object","additionalProperties":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FieldStat"}},"format":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FormatType"},"grok_pattern":{"type":"string"},"java_timestamp_formats":{"type":"array","items":{"type":"string"}},"joda_timestamp_formats":{"type":"array","items":{"type":"string"}},"ingest_pipeline":{"$ref":"./ingest._types.json#/$defs/ingest._types__PipelineConfig"},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping"},"multiline_start_pattern":{"type":"string"},"need_client_timezone":{"type":"boolean"},"num_lines_analyzed":{"type":"number"},"num_messages_analyzed":{"type":"number"},"sample_start":{"type":"string"},"timestamp_field":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."}},"required":["charset","field_stats","format","ingest_pipeline","mappings","need_client_timezone","num_lines_analyzed","num_messages_analyzed","sample_start"]}

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","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"],"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."}
+{"$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"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_message_structure","type":"object","properties":{"charset":{"type":"string"},"ecs_compatibility":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__EcsCompatibilityType"},"field_stats":{"type":"object","additionalProperties":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FieldStat"}},"format":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FormatType"},"grok_pattern":{"type":"string"},"java_timestamp_formats":{"type":"array","items":{"type":"string"}},"joda_timestamp_formats":{"type":"array","items":{"type":"string"}},"ingest_pipeline":{"$ref":"./ingest._types.json#/$defs/ingest._types__PipelineConfig"},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping"},"multiline_start_pattern":{"type":"string"},"need_client_timezone":{"type":"boolean"},"num_lines_analyzed":{"type":"number"},"num_messages_analyzed":{"type":"number"},"sample_start":{"type":"string"},"timestamp_field":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."}},"required":["charset","field_stats","format","ingest_pipeline","mappings","need_client_timezone","num_lines_analyzed","num_messages_analyzed","sample_start"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_message_structure","x-api":{"id":"text-structure.find_message_structure","name":"find-message-structure","namespace":"text-structure"},"type":"object","properties":{"charset":{"type":"string"},"ecs_compatibility":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__EcsCompatibilityType"},"field_stats":{"type":"object","additionalProperties":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FieldStat"}},"format":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FormatType"},"grok_pattern":{"type":"string"},"java_timestamp_formats":{"type":"array","items":{"type":"string"}},"joda_timestamp_formats":{"type":"array","items":{"type":"string"}},"ingest_pipeline":{"$ref":"./ingest._types.json#/$defs/ingest._types__PipelineConfig"},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping"},"multiline_start_pattern":{"type":"string"},"need_client_timezone":{"type":"boolean"},"num_lines_analyzed":{"type":"number"},"num_messages_analyzed":{"type":"number"},"sample_start":{"type":"string"},"timestamp_field":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."}},"required":["charset","field_stats","format","ingest_pipeline","mappings","need_client_timezone","num_lines_analyzed","num_messages_analyzed","sample_start"]}

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","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"}},"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."}
+{"$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.find_structure.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_structure","type":"object","properties":{"charset":{"type":"string","description":"The character encoding used to parse the text."},"has_header_row":{"type":"boolean"},"has_byte_order_marker":{"type":"boolean","description":"For UTF character encodings, it indicates whether the text begins with a byte order marker."},"format":{"type":"string","description":"Valid values include `ndjson`, `xml`, `delimited`, and `semi_structured_text`."},"field_stats":{"type":"object","additionalProperties":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FieldStat"},"description":"The most common values of each field, plus basic numeric statistics for the numeric `page_count` field.\nThis information may provide clues that the data needs to be cleaned or transformed prior to use by other Elastic Stack functionality."},"sample_start":{"type":"string","description":"The first two messages in the text verbatim.\nThis may help diagnose parse errors or accidental uploads of the wrong text."},"num_messages_analyzed":{"type":"number","description":"The number of distinct messages the lines contained.\nFor NDJSON, this value is the same as `num_lines_analyzed`.\nFor other text formats, messages can span several lines."},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","description":"Some suitable mappings for an index into which the data could be ingested."},"quote":{"type":"string"},"delimiter":{"type":"string"},"need_client_timezone":{"type":"boolean","description":"If a timestamp format is detected that does not include a timezone, `need_client_timezone` is `true`.\nThe server that parses the text must therefore be told the correct timezone by the client."},"num_lines_analyzed":{"type":"number","description":"The number of lines of the text that were analyzed."},"column_names":{"type":"array","items":{"type":"string"},"description":"If `format` is `delimited`, the `column_names` field lists the column names in the order they appear in the sample."},"explanation":{"type":"array","items":{"type":"string"}},"grok_pattern":{"type":"string"},"multiline_start_pattern":{"type":"string"},"exclude_lines_pattern":{"type":"string"},"java_timestamp_formats":{"type":"array","items":{"type":"string"},"description":"The Java time formats recognized in the time fields.\nElasticsearch mappings and ingest pipelines use this format."},"joda_timestamp_formats":{"type":"array","items":{"type":"string"},"description":"Information that is used to tell Logstash how to parse timestamps."},"timestamp_field":{"type":"string","description":"The field considered most likely to be the primary timestamp of each document."},"should_trim_fields":{"type":"boolean"},"ingest_pipeline":{"$ref":"./ingest._types.json#/$defs/ingest._types__PipelineConfig"}},"required":["charset","has_byte_order_marker","format","field_stats","sample_start","num_messages_analyzed","mappings","need_client_timezone","num_lines_analyzed","ingest_pipeline"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_structure","x-api":{"id":"text-structure.find_structure","name":"find-structure","namespace":"text-structure"},"type":"object","properties":{"charset":{"type":"string","description":"The character encoding used to parse the text."},"has_header_row":{"type":"boolean"},"has_byte_order_marker":{"type":"boolean","description":"For UTF character encodings, it indicates whether the text begins with a byte order marker."},"format":{"type":"string","description":"Valid values include `ndjson`, `xml`, `delimited`, and `semi_structured_text`."},"field_stats":{"type":"object","additionalProperties":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FieldStat"},"description":"The most common values of each field, plus basic numeric statistics for the numeric `page_count` field.\nThis information may provide clues that the data needs to be cleaned or transformed prior to use by other Elastic Stack functionality."},"sample_start":{"type":"string","description":"The first two messages in the text verbatim.\nThis may help diagnose parse errors or accidental uploads of the wrong text."},"num_messages_analyzed":{"type":"number","description":"The number of distinct messages the lines contained.\nFor NDJSON, this value is the same as `num_lines_analyzed`.\nFor other text formats, messages can span several lines."},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","description":"Some suitable mappings for an index into which the data could be ingested."},"quote":{"type":"string"},"delimiter":{"type":"string"},"need_client_timezone":{"type":"boolean","description":"If a timestamp format is detected that does not include a timezone, `need_client_timezone` is `true`.\nThe server that parses the text must therefore be told the correct timezone by the client."},"num_lines_analyzed":{"type":"number","description":"The number of lines of the text that were analyzed."},"column_names":{"type":"array","items":{"type":"string"},"description":"If `format` is `delimited`, the `column_names` field lists the column names in the order they appear in the sample."},"explanation":{"type":"array","items":{"type":"string"}},"grok_pattern":{"type":"string"},"multiline_start_pattern":{"type":"string"},"exclude_lines_pattern":{"type":"string"},"java_timestamp_formats":{"type":"array","items":{"type":"string"},"description":"The Java time formats recognized in the time fields.\nElasticsearch mappings and ingest pipelines use this format."},"joda_timestamp_formats":{"type":"array","items":{"type":"string"},"description":"Information that is used to tell Logstash how to parse timestamps."},"timestamp_field":{"type":"string","description":"The field considered most likely to be the primary timestamp of each document."},"should_trim_fields":{"type":"boolean"},"ingest_pipeline":{"$ref":"./ingest._types.json#/$defs/ingest._types__PipelineConfig"}},"required":["charset","has_byte_order_marker","format","field_stats","sample_start","num_messages_analyzed","mappings","need_client_timezone","num_lines_analyzed","ingest_pipeline"]}

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","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"],"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."}
+{"$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"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.test_grok_pattern","type":"object","properties":{"matches":{"type":"array","items":{"$ref":"./text_structure.test_grok_pattern.json#/$defs/text_structure.test_grok_pattern__MatchedText"}}},"required":["matches"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.test_grok_pattern","x-api":{"id":"text-structure.test_grok_pattern","name":"test-grok-pattern","namespace":"text-structure"},"type":"object","properties":{"matches":{"type":"array","items":{"$ref":"./text_structure.test_grok_pattern.json#/$defs/text_structure.test_grok_pattern__MatchedText"}}},"required":["matches"]}

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."},"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."}},"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."}},"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__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."}}}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.delete_transform","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"],"description":"Delete a transform."}
+{"$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"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.delete_transform","$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.delete_transform","x-api":{"id":"transform.delete_transform","name":"delete-transform","namespace":"transform"},"$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}

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","type":"object","properties":{},"description":"Get node stats.\n\nGet per-node information about transform usage."}
+{"$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":{}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.get_node_stats","$ref":"./transform.get_node_stats.json#/$defs/transform.get_node_stats__TransformNodeFullStats"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.get_node_stats","x-api":{"id":"transform.get_node_stats","name":"get-node-stats","namespace":"transform"},"$ref":"./transform.get_node_stats.json#/$defs/transform.get_node_stats__TransformNodeFullStats"}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.get_transform","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"}},"description":"Get transforms.\n\nGet configuration information for transforms."}
+{"$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"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.get_transform","type":"object","properties":{"count":{"type":"number"},"transforms":{"type":"array","items":{"$ref":"./transform.get_transform.json#/$defs/transform.get_transform__TransformSummary"}}},"required":["count","transforms"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.get_transform","x-api":{"id":"transform.get_transform","name":"get-transform","namespace":"transform"},"type":"object","properties":{"count":{"type":"number"},"transforms":{"type":"array","items":{"$ref":"./transform.get_transform.json#/$defs/transform.get_transform__TransformSummary"}}},"required":["count","transforms"]}