@elastic/schemas 0.4.4 → 0.4.5

package/src/es/json/tasks._types.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"tasks._types__TaskListResponseBase":{"type":"object","properties":{"node_failures":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__ErrorCause"}},"task_failures":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__TaskFailure"}},"nodes":{"type":"object","additionalProperties":{"$ref":"./tasks._types.json#/$defs/tasks._types__NodeTasks"},"description":"Task information grouped by node, if `group_by` was set to `node` (the default)."},"tasks":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfos","description":"Either a flat list of tasks if `group_by` was set to `none`, or grouped by parents if\n`group_by` was set to `parents`."}}},"tasks._types__NodeTasks":{"type":"object","properties":{"name":{"type":"string"},"transport_address":{"type":"string"},"host":{"type":"string"},"ip":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"tasks":{"type":"object","additionalProperties":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfo"}}},"required":["tasks"]},"tasks._types__TaskInfo":{"type":"object","properties":{"action":{"type":"string"},"cancelled":{"type":"boolean"},"cancellable":{"type":"boolean"},"description":{"type":"string","description":"Human readable text that identifies the particular request that the task is performing.\nFor example, it might identify the search request being performed by a search task.\nOther kinds of tasks have different descriptions, like `_reindex` which has the source and the destination, or `_bulk` which just has the number of requests and the destination indices.\nMany requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request."},"headers":{"type":"object","additionalProperties":{"type":"string"}},"id":{"type":"number"},"node":{"type":"string"},"running_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"running_time_in_nanos":{},"start_time_in_millis":{},"status":{"description":"The internal status of the task, which varies from task to task.\nThe format also varies.\nWhile the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes.\nFields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases."},"type":{"type":"string"},"parent_task_id":{"type":"string"},"original_task_id":{"type":"string","description":"The task ID of the original task. Only present when the task is continuing the work of an earlier task that was running on a node which has since shut down (i.e. a relocatable task).\nFor tasks that have not been relocated this is always equal to the task's own ID and is omitted from the response."},"original_start_time_in_millis":{"description":"The time at which the original task started, in milliseconds since the Unix epoch. Only present together with `original_task_id`."},"original_start_time":{"type":"string","description":"The time at which the original task started, as an ISO 8601 formatted string. Only present together with `original_task_id` and when the request includes the `?human=true` query parameter."}},"required":["action","cancellable","headers","id","node","running_time_in_nanos","start_time_in_millis","type"]},"tasks._types__TaskInfos":{"oneOf":[{"type":"array","items":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfo"}},{"type":"object","additionalProperties":{"$ref":"./tasks._types.json#/$defs/tasks._types__ParentTaskInfo"}}]},"tasks._types__ParentTaskInfo":{"type":"object","properties":{"action":{"type":"string"},"cancelled":{"type":"boolean"},"cancellable":{"type":"boolean"},"description":{"type":"string","description":"Human readable text that identifies the particular request that the task is performing.\nFor example, it might identify the search request being performed by a search task.\nOther kinds of tasks have different descriptions, like `_reindex` which has the source and the destination, or `_bulk` which just has the number of requests and the destination indices.\nMany requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request."},"headers":{"type":"object","additionalProperties":{"type":"string"}},"id":{"type":"number"},"node":{"type":"string"},"running_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"running_time_in_nanos":{},"start_time_in_millis":{},"status":{"description":"The internal status of the task, which varies from task to task.\nThe format also varies.\nWhile the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes.\nFields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases."},"type":{"type":"string"},"parent_task_id":{"type":"string"},"original_task_id":{"type":"string","description":"The task ID of the original task. Only present when the task is continuing the work of an earlier task that was running on a node which has since shut down (i.e. a relocatable task).\nFor tasks that have not been relocated this is always equal to the task's own ID and is omitted from the response."},"original_start_time_in_millis":{"description":"The time at which the original task started, in milliseconds since the Unix epoch. Only present together with `original_task_id`."},"original_start_time":{"type":"string","description":"The time at which the original task started, as an ISO 8601 formatted string. Only present together with `original_task_id` and when the request includes the `?human=true` query parameter."},"children":{"type":"array","items":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfo"}}},"required":["action","cancellable","headers","id","node","running_time_in_nanos","start_time_in_millis","type"]},"tasks._types__GroupBy":{"enum":["nodes","parents","none"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"tasks._types__TaskListResponseBase":{"type":"object","properties":{"node_failures":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__ErrorCause"}},"task_failures":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__TaskFailure"}},"nodes":{"type":"object","additionalProperties":{"$ref":"./tasks._types.json#/$defs/tasks._types__NodeTasks"},"description":"Task information grouped by node, if `group_by` was set to `node` (the default)."},"tasks":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfos","description":"Either a flat list of tasks if `group_by` was set to `none`, or grouped by parents if\n`group_by` was set to `parents`."}}},"tasks._types__NodeTasks":{"type":"object","properties":{"name":{"type":"string"},"transport_address":{"type":"string"},"host":{"type":"string"},"ip":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"tasks":{"type":"object","additionalProperties":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfo"}}},"required":["tasks"]},"tasks._types__TaskInfo":{"type":"object","properties":{"action":{"type":"string"},"cancelled":{"type":"boolean"},"cancellable":{"type":"boolean"},"description":{"type":"string","description":"Human readable text that identifies the particular request that the task is performing.\nFor example, it might identify the search request being performed by a search task.\nOther kinds of tasks have different descriptions, like `_reindex` which has the source and the destination, or `_bulk` which just has the number of requests and the destination indices.\nMany requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request."},"headers":{"type":"object","additionalProperties":{"type":"string"}},"id":{"type":"number"},"node":{"type":"string"},"running_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"running_time_in_nanos":{},"start_time_in_millis":{},"status":{"description":"The internal status of the task, which varies from task to task.\nThe format also varies.\nWhile the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes.\nFields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases."},"type":{"type":"string"},"parent_task_id":{"type":"string"},"original_task_id":{"type":"string","description":"The task ID of the original task. Only present when the task is continuing the work of an earlier task that was running on a node which has since shut down (i.e. a relocatable task).\nFor tasks that have not been relocated this is always equal to the task's own ID and is omitted from the response."},"original_start_time_in_millis":{"description":"The time at which the original task started, in milliseconds since the Unix epoch. Only present together with `original_task_id`."},"original_start_time":{"type":"string","description":"The time at which the original task started, as an ISO 8601 formatted string. Only present together with `original_task_id` and when the request includes the `?human=true` query parameter."}},"required":["action","cancellable","headers","id","node","running_time_in_nanos","start_time_in_millis","type"]},"tasks._types__TaskInfos":{"anyOf":[{"type":"array","items":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfo"}},{"type":"object","additionalProperties":{"$ref":"./tasks._types.json#/$defs/tasks._types__ParentTaskInfo"}}]},"tasks._types__ParentTaskInfo":{"type":"object","properties":{"action":{"type":"string"},"cancelled":{"type":"boolean"},"cancellable":{"type":"boolean"},"description":{"type":"string","description":"Human readable text that identifies the particular request that the task is performing.\nFor example, it might identify the search request being performed by a search task.\nOther kinds of tasks have different descriptions, like `_reindex` which has the source and the destination, or `_bulk` which just has the number of requests and the destination indices.\nMany requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request."},"headers":{"type":"object","additionalProperties":{"type":"string"}},"id":{"type":"number"},"node":{"type":"string"},"running_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"running_time_in_nanos":{},"start_time_in_millis":{},"status":{"description":"The internal status of the task, which varies from task to task.\nThe format also varies.\nWhile the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes.\nFields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases."},"type":{"type":"string"},"parent_task_id":{"type":"string"},"original_task_id":{"type":"string","description":"The task ID of the original task. Only present when the task is continuing the work of an earlier task that was running on a node which has since shut down (i.e. a relocatable task).\nFor tasks that have not been relocated this is always equal to the task's own ID and is omitted from the response."},"original_start_time_in_millis":{"description":"The time at which the original task started, in milliseconds since the Unix epoch. Only present together with `original_task_id`."},"original_start_time":{"type":"string","description":"The time at which the original task started, as an ISO 8601 formatted string. Only present together with `original_task_id` and when the request includes the `?human=true` query parameter."},"children":{"type":"array","items":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfo"}}},"required":["action","cancellable","headers","id","node","running_time_in_nanos","start_time_in_millis","type"]},"tasks._types__GroupBy":{"enum":["nodes","parents","none"]}}}

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":{"oneOf":[{"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","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."}

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":{"oneOf":[{"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","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."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"termvectors","type":"object","properties":{"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"},"fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A comma-separated list or wildcard expressions 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":"query"},"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":"query"},"offsets":{"type":"boolean","description":"If `true`, the response includes term offsets.","x-found-in":"query"},"payloads":{"type":"boolean","description":"If `true`, the response includes term payloads.","x-found-in":"query"},"positions":{"type":"boolean","description":"If `true`, the response includes term positions.","x-found-in":"query"},"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":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value that is used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"version":{"type":"number","description":"If `true`, returns the document version as part of a hit.","x-found-in":"query"},"version_type":{"$ref":"./_types.json#/$defs/_types__VersionType","description":"The version type.","x-found-in":"query"},"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"},"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","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."}

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":{"oneOf":[{"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","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."}

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":{"messages":{"type":"array","items":{"type":"string"},"description":"The list of messages you want to analyze.","x-found-in":"body"},"column_names":{"oneOf":[{"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"}},"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","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."}

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":{"oneOf":[{"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"}},"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","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."}

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

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.preview_transform","type":"object","properties":{"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination","description":"The destination for the transform.","x-found-in":"body"},"description":{"type":"string","description":"Free text description of the transform.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.","x-found-in":"body"},"pivot":{"$ref":"./transform._types.json#/$defs/transform._types__Pivot","description":"The pivot method transforms the data by aggregating and grouping it.\nThese objects define the group by fields and the aggregation to reduce\nthe data.","x-found-in":"body"},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform.","x-found-in":"body"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings.","x-found-in":"body"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously.","x-found-in":"body"},"retention_policy":{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer","description":"Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.","x-found-in":"body"},"latest":{"$ref":"./transform._types.json#/$defs/transform._types__Latest","description":"The latest method transforms the data by finding the latest document for\neach unique key.","x-found-in":"body"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.","x-found-in":"query"},"transform_id":{"type":"string","description":"Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform\nconfiguration details in the request body.","x-found-in":"path"}},"description":"Preview a transform.\n\nGenerates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.preview_transform","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.","x-found-in":"query"},"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination","description":"The destination for the transform.","x-found-in":"body"},"description":{"type":"string","description":"Free text description of the transform.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.","x-found-in":"body"},"pivot":{"$ref":"./transform._types.json#/$defs/transform._types__Pivot","description":"The pivot method transforms the data by aggregating and grouping it.\nThese objects define the group by fields and the aggregation to reduce\nthe data.","x-found-in":"body"},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform.","x-found-in":"body"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings.","x-found-in":"body"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously.","x-found-in":"body"},"retention_policy":{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer","description":"Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.","x-found-in":"body"},"latest":{"$ref":"./transform._types.json#/$defs/transform._types__Latest","description":"The latest method transforms the data by finding the latest document for\neach unique key.","x-found-in":"body"},"transform_id":{"type":"string","description":"Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform\nconfiguration details in the request body.","x-found-in":"path"}},"description":"Preview a transform.\n\nGenerates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations."}

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

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

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.update_transform","type":"object","properties":{"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination","description":"The destination for the transform.","x-found-in":"body"},"description":{"type":"string","description":"Free text description of the transform.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Defines optional transform metadata.","x-found-in":"body"},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform.","x-found-in":"body"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings.","x-found-in":"body"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously.","x-found-in":"body"},"retention_policy":{"oneOf":[{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer"},{"type":"null"}],"description":"Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.","x-found-in":"body"},"defer_validation":{"type":"boolean","description":"When true, deferrable validations are not run. This behavior may be\ndesired if the source index does not exist until after the transform is\ncreated.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.","x-found-in":"query"},"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"}},"required":["transform_id"],"description":"Update a transform.\n\nUpdates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.update_transform","type":"object","properties":{"defer_validation":{"type":"boolean","description":"When true, deferrable validations are not run. This behavior may be\ndesired if the source index does not exist until after the transform is\ncreated.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.","x-found-in":"query"},"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination","description":"The destination for the transform.","x-found-in":"body"},"description":{"type":"string","description":"Free text description of the transform.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Defines optional transform metadata.","x-found-in":"body"},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform.","x-found-in":"body"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings.","x-found-in":"body"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously.","x-found-in":"body"},"retention_policy":{"anyOf":[{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer"},{"type":"null"}],"description":"Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.","x-found-in":"body"},"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"}},"required":["transform_id"],"description":"Update a transform.\n\nUpdates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges."}

package/src/es/json/update.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"update","type":"object","properties":{"detect_noop":{"type":"boolean","description":"If `true`, the `result` in the response is set to `noop` (no operation) when there are no changes to the document.","x-found-in":"body"},"doc":{"description":"A partial update to an existing document.\nIf both `doc` and `script` are specified, `doc` is ignored.","x-found-in":"body"},"doc_as_upsert":{"type":"boolean","description":"If `true`, use the contents of 'doc' as the value of 'upsert'.\nNOTE: Using ingest pipelines with `doc_as_upsert` is not supported.","x-found-in":"body"},"script":{"$ref":"./_types.json#/$defs/_types__Script","description":"The script to run to update the document.","x-found-in":"body"},"scripted_upsert":{"type":"boolean","description":"If `true`, run the script whether or not the document exists.","x-found-in":"body"},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam","description":"If `false`, source retrieval is turned off.\nYou can also specify a comma-separated list of the fields you want to retrieve.","x-found-in":"query"},"upsert":{"description":"If the document does not already exist, the contents of 'upsert' are inserted as a new document.\nIf the document exists, the 'script' is run.","x-found-in":"body"},"if_primary_term":{"type":"number","description":"Only perform the operation if the document has this primary term.","x-found-in":"query"},"if_seq_no":{"type":"number","description":"Only perform the operation if the document has this sequence number.","x-found-in":"query"},"include_source_on_error":{"type":"boolean","description":"True or false if to include the document source in the error message in case of parsing errors.","x-found-in":"query"},"lang":{"type":"string","description":"The script language.","x-found-in":"query"},"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', it does nothing with refreshes.","x-found-in":"query"},"require_alias":{"type":"boolean","description":"If `true`, the destination must be an index alias.","x-found-in":"query"},"retry_on_conflict":{"type":"number","description":"The number of times the operation should be retried when a conflict occurs.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the following operations: dynamic mapping updates and waiting for active shards.\nElasticsearch waits for at least the timeout period before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"The number of copies of each shard that must be active before proceeding with the operation.\nSet to 'all' or any positive integer up to the total number of shards in the index (`number_of_replicas`+1).\nThe default value of `1` means it waits for each primary shard to be active.","x-found-in":"query"},"_source_excludes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"The source fields you want to exclude.","x-found-in":"query"},"_source_includes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"The source fields you want to retrieve.","x-found-in":"query"},"id":{"type":"string","description":"A unique identifier for the document to be updated.","x-found-in":"path"},"index":{"type":"string","description":"The name of the target index.\nBy default, the index is created automatically if it doesn't exist.","x-found-in":"path"}},"required":["id","index"],"description":"Update a document.\n\nUpdate a document by running a script or passing a partial document.\n\nIf the Elasticsearch security features are enabled, you must have the `index` or `write` index privilege for the target index or index alias.\n\nThe script can update, delete, or skip modifying the document.\nThe API also supports passing a partial document, which is merged into the existing document.\nTo fully replace an existing document, use the index API.\nThis operation:\n\n* Gets the document (collocated with the shard) from the index.\n* Runs the specified script.\n* Indexes the result.\n\nThe document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation.\n\nThe `_source` field must be enabled to use this API.\nIn addition to `_source`, you can access the following variables through the `ctx` map: `_index`, `_type`, `_id`, `_version`, `_routing`, and `_now` (the current timestamp).\nFor usage examples such as partial updates, upserts, and scripted updates, see the External documentation."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"update","type":"object","properties":{"if_primary_term":{"type":"number","description":"Only perform the operation if the document has this primary term.","x-found-in":"query"},"if_seq_no":{"type":"number","description":"Only perform the operation if the document has this sequence number.","x-found-in":"query"},"include_source_on_error":{"type":"boolean","description":"True or false if to include the document source in the error message in case of parsing errors.","x-found-in":"query"},"lang":{"type":"string","description":"The script language.","x-found-in":"query"},"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', it does nothing with refreshes.","x-found-in":"query"},"require_alias":{"type":"boolean","description":"If `true`, the destination must be an index alias.","x-found-in":"query"},"retry_on_conflict":{"type":"number","description":"The number of times the operation should be retried when a conflict occurs.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the following operations: dynamic mapping updates and waiting for active shards.\nElasticsearch waits for at least the timeout period before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"The number of copies of each shard that must be active before proceeding with the operation.\nSet to 'all' or any positive integer up to the total number of shards in the index (`number_of_replicas`+1).\nThe default value of `1` means it waits for each primary shard to be active.","x-found-in":"query"},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfig","description":"If `false`, turn off source retrieval.\nYou can also specify a comma-separated list of the fields you want to retrieve.","x-found-in":"body"},"_source_excludes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"The source fields you want to exclude.","x-found-in":"query"},"_source_includes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"The source fields you want to retrieve.","x-found-in":"query"},"detect_noop":{"type":"boolean","description":"If `true`, the `result` in the response is set to `noop` (no operation) when there are no changes to the document.","x-found-in":"body"},"doc":{"description":"A partial update to an existing document.\nIf both `doc` and `script` are specified, `doc` is ignored.","x-found-in":"body"},"doc_as_upsert":{"type":"boolean","description":"If `true`, use the contents of 'doc' as the value of 'upsert'.\nNOTE: Using ingest pipelines with `doc_as_upsert` is not supported.","x-found-in":"body"},"script":{"$ref":"./_types.json#/$defs/_types__Script","description":"The script to run to update the document.","x-found-in":"body"},"scripted_upsert":{"type":"boolean","description":"If `true`, run the script whether or not the document exists.","x-found-in":"body"},"upsert":{"description":"If the document does not already exist, the contents of 'upsert' are inserted as a new document.\nIf the document exists, the 'script' is run.","x-found-in":"body"},"id":{"type":"string","description":"A unique identifier for the document to be updated.","x-found-in":"path"},"index":{"type":"string","description":"The name of the target index.\nBy default, the index is created automatically if it doesn't exist.","x-found-in":"path"}},"required":["id","index"],"description":"Update a document.\n\nUpdate a document by running a script or passing a partial document.\n\nIf the Elasticsearch security features are enabled, you must have the `index` or `write` index privilege for the target index or index alias.\n\nThe script can update, delete, or skip modifying the document.\nThe API also supports passing a partial document, which is merged into the existing document.\nTo fully replace an existing document, use the index API.\nThis operation:\n\n* Gets the document (collocated with the shard) from the index.\n* Runs the specified script.\n* Indexes the result.\n\nThe document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation.\n\nThe `_source` field must be enabled to use this API.\nIn addition to `_source`, you can access the following variables through the `ctx` map: `_index`, `_type`, `_id`, `_version`, `_routing`, and `_now` (the current timestamp).\nFor usage examples such as partial updates, upserts, and scripted updates, see the External documentation."}

package/src/es/json/update_by_query.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"update_by_query","type":"object","properties":{"max_docs":{"type":"number","description":"The maximum number of documents to process.\nIt defaults to all documents.\nWhen set to a value less than or equal to `scroll_size` and `conflicts` is set to `abort`, a scroll will not be used to retrieve the results for the operation.","x-found-in":"query"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The documents to update using the Query DSL.","x-found-in":"body"},"script":{"$ref":"./_types.json#/$defs/_types__Script","description":"The script to run to update the document source or metadata when updating.","x-found-in":"body"},"slice":{"$ref":"./_types.json#/$defs/_types__SlicedScroll","description":"Slice the request manually using the provided slice ID and total number of slices.","x-found-in":"body"},"conflicts":{"$ref":"./_types.json#/$defs/_types__Conflicts","description":"The preferred behavior when update by query hits version conflicts: `abort` or `proceed`.","x-found-in":"query"},"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"analyzer":{"type":"string","description":"The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"analyze_wildcard":{"type":"boolean","description":"If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"default_operator":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__Operator","description":"The default operator for query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"df":{"type":"string","description":"The field to use as default where no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of documents.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"lenient":{"type":"boolean","description":"If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"pipeline":{"type":"string","description":"The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.","x-found-in":"query"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"q":{"type":"string","description":"A query in the Lucene query string syntax.","x-found-in":"query"},"refresh":{"type":"boolean","description":"If `true`, Elasticsearch refreshes affected shards to make the operation visible to search after the request completes.\nThis is different than the update API's `refresh` parameter, which causes just the shard that received the request to be refreshed.","x-found-in":"query"},"request_cache":{"type":"boolean","description":"If `true`, the request cache is used for this request.\nIt defaults to the index-level setting.","x-found-in":"query"},"requests_per_second":{"type":"number","description":"The maximum number of documents to update per second, across the entire update_by_query operation (including slices).\nIt can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"scroll":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to retain the search context for scrolling.","x-found-in":"query"},"scroll_size":{"type":"number","description":"The size of the scroll request that powers the operation.","x-found-in":"query"},"search_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"An explicit timeout for each search request.\nBy default, there is no timeout.","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`.","x-found-in":"query"},"slices":{"$ref":"./_types.json#/$defs/_types__Slices","description":"The number of slices this task should be divided into.","x-found-in":"query"},"sort":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of <field>:<direction> pairs.","x-found-in":"query"},"stats":{"type":"array","items":{"type":"string"},"description":"The specific `tag` of the request for logging and statistical purposes.","x-found-in":"query"},"terminate_after":{"type":"number","description":"The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.\nBy default, it is one minute.\nThis guarantees Elasticsearch waits for at least the timeout before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.","x-found-in":"query"},"version":{"type":"boolean","description":"If `true`, returns the document version as part of a hit.","x-found-in":"query"},"version_type":{"type":"boolean","description":"Should the document increment the version number (internal) on hit or not (reindex)","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe `timeout` parameter controls how long each write request waits for unavailable shards to become available.\nBoth work exactly the way they work in the bulk API.\nUpdate by query uses scrolled searches, so you can also specify the `scroll` parameter to control how long it keeps the search context alive, for example `?scroll=10m`.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the operation is complete.\nIf `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task ID that you can use to cancel or get the status of the task.\nElasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}},"required":["index"],"description":"Update documents.\n\nUpdates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:\n\n* `read`\n* `index` or `write`\n\nYou can specify the query criteria in the request URI or the request body using the same syntax as the search API.\n\nWhen you submit an update by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and updates matching documents using internal versioning.\nWhen the versions match, the document is updated and the version number is incremented.\nIf a document changes between the time that the snapshot is taken and the update operation is processed, it results in a version conflict and the operation fails.\nYou can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`.\nNote that if you opt to count version conflicts, the operation could attempt to update more documents from the source than `max_docs` until it has successfully updated `max_docs` documents or it has gone through every document in the source query.\n\nNOTE: Documents with a version equal to 0 cannot be updated using update by query because internal versioning does not support 0 as a valid version number.\n\nWhile processing an update by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents.\nA bulk update request is performed for each batch of matching documents.\nAny query or update failures cause the update by query request to fail and the failures are shown in the response.\nAny update requests that completed successfully still stick, they are not rolled back.\n\n**Refreshing shards**\n\nSpecifying the `refresh` parameter refreshes all shards once the request completes.\nThis is different to the update API's `refresh` parameter, which causes only the shard\nthat received the request to be refreshed. Unlike the update API, it does not support\n`wait_for`.\n\n**Running update by query asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch\nperforms some preflight checks, launches the request, and returns a\n[task](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks) you can use to cancel or get the status of the task.\nElasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`.\n\n**Throttling update requests**\n\nTo control the rate at which update by query issues batches of update operations, you can set `requests_per_second` to any positive decimal number.\nThis pads each batch with a wait time to throttle the rate.\nSet `requests_per_second` to `-1` to turn off throttling.\n\nThrottling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account.\nThe padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing.\nBy default the batch size is 1000, so if `requests_per_second` is set to `500`:\n\n```\ntarget_time = 1000 / 500 per second = 2 seconds\nwait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds\n```\n\nSince the batch is issued as a single _bulk request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\n\nUpdate by query supports sliced scroll to parallelize the update process.\nThis can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nSetting `slices` to `auto` chooses a reasonable number for most data streams and indices.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.\n\nAdding `slices` to `_update_by_query` just automates the manual process of creating sub-requests, which means it has some quirks:\n\n* You can see these requests in the tasks APIs. These sub-requests are \"child\" tasks of the task for the request with slices.\n* Fetching the status of the task for the request with `slices` only contains the status of completed slices.\n* These sub-requests are individually addressable for things like cancellation and rethrottling.\n* Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally.\n* Canceling the request with slices will cancel each sub-request.\n* Due to the nature of slices each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.\n* Parameters like `requests_per_second` and `max_docs` on a request with slices are distributed proportionally to each sub-request. Combine that with the point above about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being updated.\n* Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.\n\nIf you're slicing manually or otherwise tuning automatic slicing, keep in mind that:\n\n* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many slices hurts performance. Setting slices higher than the number of shards generally does not improve efficiency and adds overhead.\n* Update performance scales linearly across available resources with the number of slices.\n\nWhether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources.\nRefer to the linked documentation for examples of how to update documents using the `_update_by_query` API:"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"update_by_query","type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"analyzer":{"type":"string","description":"The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"analyze_wildcard":{"type":"boolean","description":"If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"conflicts":{"$ref":"./_types.json#/$defs/_types__Conflicts","description":"The preferred behavior when update by query hits version conflicts: `abort` or `proceed`.","x-found-in":"body"},"default_operator":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__Operator","description":"The default operator for query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"df":{"type":"string","description":"The field to use as default where no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of documents.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"lenient":{"type":"boolean","description":"If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"max_docs":{"type":"number","description":"The maximum number of documents to update.","x-found-in":"body"},"pipeline":{"type":"string","description":"The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.","x-found-in":"query"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"q":{"type":"string","description":"A query in the Lucene query string syntax.","x-found-in":"query"},"refresh":{"type":"boolean","description":"If `true`, Elasticsearch refreshes affected shards to make the operation visible to search after the request completes.\nThis is different than the update API's `refresh` parameter, which causes just the shard that received the request to be refreshed.","x-found-in":"query"},"request_cache":{"type":"boolean","description":"If `true`, the request cache is used for this request.\nIt defaults to the index-level setting.","x-found-in":"query"},"requests_per_second":{"type":"number","description":"The maximum number of documents to update per second, across the entire update_by_query operation (including slices).\nIt can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"scroll":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to retain the search context for scrolling.","x-found-in":"query"},"scroll_size":{"type":"number","description":"The size of the scroll request that powers the operation.","x-found-in":"query"},"search_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"An explicit timeout for each search request.\nBy default, there is no timeout.","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`.","x-found-in":"query"},"slices":{"$ref":"./_types.json#/$defs/_types__Slices","description":"The number of slices this task should be divided into.","x-found-in":"query"},"sort":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of <field>:<direction> pairs.","x-found-in":"query"},"stats":{"type":"array","items":{"type":"string"},"description":"The specific `tag` of the request for logging and statistical purposes.","x-found-in":"query"},"terminate_after":{"type":"number","description":"The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.\nBy default, it is one minute.\nThis guarantees Elasticsearch waits for at least the timeout before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.","x-found-in":"query"},"version":{"type":"boolean","description":"If `true`, returns the document version as part of a hit.","x-found-in":"query"},"version_type":{"type":"boolean","description":"Should the document increment the version number (internal) on hit or not (reindex)","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe `timeout` parameter controls how long each write request waits for unavailable shards to become available.\nBoth work exactly the way they work in the bulk API.\nUpdate by query uses scrolled searches, so you can also specify the `scroll` parameter to control how long it keeps the search context alive, for example `?scroll=10m`.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the operation is complete.\nIf `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task ID that you can use to cancel or get the status of the task.\nElasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`.","x-found-in":"query"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The documents to update using the Query DSL.","x-found-in":"body"},"script":{"$ref":"./_types.json#/$defs/_types__Script","description":"The script to run to update the document source or metadata when updating.","x-found-in":"body"},"slice":{"$ref":"./_types.json#/$defs/_types__SlicedScroll","description":"Slice the request manually using the provided slice ID and total number of slices.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}},"required":["index"],"description":"Update documents.\n\nUpdates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:\n\n* `read`\n* `index` or `write`\n\nYou can specify the query criteria in the request URI or the request body using the same syntax as the search API.\n\nWhen you submit an update by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and updates matching documents using internal versioning.\nWhen the versions match, the document is updated and the version number is incremented.\nIf a document changes between the time that the snapshot is taken and the update operation is processed, it results in a version conflict and the operation fails.\nYou can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`.\nNote that if you opt to count version conflicts, the operation could attempt to update more documents from the source than `max_docs` until it has successfully updated `max_docs` documents or it has gone through every document in the source query.\n\nNOTE: Documents with a version equal to 0 cannot be updated using update by query because internal versioning does not support 0 as a valid version number.\n\nWhile processing an update by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents.\nA bulk update request is performed for each batch of matching documents.\nAny query or update failures cause the update by query request to fail and the failures are shown in the response.\nAny update requests that completed successfully still stick, they are not rolled back.\n\n**Refreshing shards**\n\nSpecifying the `refresh` parameter refreshes all shards once the request completes.\nThis is different to the update API's `refresh` parameter, which causes only the shard\nthat received the request to be refreshed. Unlike the update API, it does not support\n`wait_for`.\n\n**Running update by query asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch\nperforms some preflight checks, launches the request, and returns a\n[task](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks) you can use to cancel or get the status of the task.\nElasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`.\n\n**Throttling update requests**\n\nTo control the rate at which update by query issues batches of update operations, you can set `requests_per_second` to any positive decimal number.\nThis pads each batch with a wait time to throttle the rate.\nSet `requests_per_second` to `-1` to turn off throttling.\n\nThrottling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account.\nThe padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing.\nBy default the batch size is 1000, so if `requests_per_second` is set to `500`:\n\n```\ntarget_time = 1000 / 500 per second = 2 seconds\nwait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds\n```\n\nSince the batch is issued as a single _bulk request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\n\nUpdate by query supports sliced scroll to parallelize the update process.\nThis can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nSetting `slices` to `auto` chooses a reasonable number for most data streams and indices.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.\n\nAdding `slices` to `_update_by_query` just automates the manual process of creating sub-requests, which means it has some quirks:\n\n* You can see these requests in the tasks APIs. These sub-requests are \"child\" tasks of the task for the request with slices.\n* Fetching the status of the task for the request with `slices` only contains the status of completed slices.\n* These sub-requests are individually addressable for things like cancellation and rethrottling.\n* Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally.\n* Canceling the request with slices will cancel each sub-request.\n* Due to the nature of slices each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.\n* Parameters like `requests_per_second` and `max_docs` on a request with slices are distributed proportionally to each sub-request. Combine that with the point above about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being updated.\n* Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.\n\nIf you're slicing manually or otherwise tuning automatic slicing, keep in mind that:\n\n* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many slices hurts performance. Setting slices higher than the number of shards generally does not improve efficiency and adds overhead.\n* Update performance scales linearly across available resources with the number of slices.\n\nWhether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources.\nRefer to the linked documentation for examples of how to update documents using the `_update_by_query` API:"}