@elastic/schemas 0.7.0 → 0.7.2

package/lib/es/json/bulk.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "bulk", "description": "Bulk index or delete documents.\n\nPerform multiple `index`, `create`, `delete`, and `update` actions in a single request.\nThis reduces overhead and can greatly increase indexing speed.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To use the `create` action, you must have the `create_doc`, `create`, `index`, or `write` index privilege. Data streams support only the `create` action.\n* To use the `index` action, you must have the `create`, `index`, or `write` index privilege.\n* To use the `delete` action, you must have the `delete` or `write` index privilege.\n* To use the `update` action, you must have the `index` or `write` index privilege.\n* To automatically create a data stream or index with a bulk API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n* To make the result of a bulk operation visible to search using the `refresh` parameter, you must have the `maintenance` or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nThe actions are specified in the request body using a newline delimited JSON (NDJSON) structure:\n\n```\naction_and_meta_data\\n\noptional_source\\n\naction_and_meta_data\\n\noptional_source\\n\n....\naction_and_meta_data\\n\noptional_source\\n\n```\n\nThe `index` and `create` actions expect a source on the next line and have the same semantics as the `op_type` parameter in the standard index API.\nA `create` action fails if a document with the same ID already exists in the target\nAn `index` action adds or replaces a document as necessary.\n\nNOTE: Data streams support only the `create` action.\nTo update or delete a document in a data stream, you must target the backing index containing the document.\n\nAn `update` action expects that the partial doc, upsert, and script and its options are specified on the next line.\n\nA `delete` action does not expect a source on the next line and has the same semantics as the standard delete API.\n\nNOTE: The final line of data must end with a newline character (`\\n`).\nEach newline character may be preceded by a carriage return (`\\r`).\nWhen sending NDJSON data to the `_bulk` endpoint, use a `Content-Type` header of `application/json` or `application/x-ndjson`.\nBecause this format uses literal newline characters (`\\n`) as delimiters, make sure that the JSON actions and sources are not pretty printed.\n\nIf you provide a target in the request path, it is used for any actions that don't explicitly specify an `_index` argument.\n\nA note on the format: the idea here is to make processing as fast as possible.\nAs some of the actions are redirected to other shards on other nodes, only `action_meta_data` is parsed on the receiving node side.\n\nClient libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible.\n\nThere is no \"correct\" number of actions to perform in a single bulk request.\nExperiment with different settings to find the optimal size for your particular workload.\nNote that Elasticsearch limits the maximum size of a HTTP request to 100mb by default so clients must ensure that no request exceeds this size.\nIt is not possible to index a single document that exceeds the size limit, so you must pre-process any such documents into smaller pieces before sending them to Elasticsearch.\nFor instance, split documents into pages or chapters before indexing them, or store raw binary data in a system outside Elasticsearch and replace the raw data with a link to the external system in the documents that you send to Elasticsearch.\n\n**Client suppport for bulk requests**\n\nSome of the officially supported clients provide helpers to assist with bulk requests and reindexing:\n\n* Go: Check out `esutil.BulkIndexer`\n* Perl: Check out `Search::Elasticsearch::Client::5_0::Bulk` and `Search::Elasticsearch::Client::5_0::Scroll`\n* Python: Check out `elasticsearch.helpers.*`\n* JavaScript: Check out `client.helpers.*`\n* Java: Check out `co.elastic.clients.elasticsearch._helpers.bulk.BulkIngester`\n* .NET: Check out `BulkAllObservable`\n* PHP: Check out bulk indexing.\n* Ruby: Check out `Elasticsearch::Helpers::BulkHelper`\n\n**Submitting bulk requests with cURL**\n\nIf you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`.\nThe latter doesn't preserve newlines. For example:\n\n```\n$ cat requests\n{ \"index\" : { \"_index\" : \"test\", \"_id\" : \"1\" } }\n{ \"field1\" : \"value1\" }\n$ curl -s -H \"Content-Type: application/x-ndjson\" -XPOST localhost:9200/_bulk --data-binary \"@requests\"; echo\n{\"took\":7, \"errors\": false, \"items\":[{\"index\":{\"_index\":\"test\",\"_id\":\"1\",\"_version\":1,\"result\":\"created\",\"forced_refresh\":false}}]}\n```\n\n**Optimistic concurrency control**\n\nEach `index` and `delete` action within a bulk API call may include the `if_seq_no` and `if_primary_term` parameters in their respective action and meta data lines.\nThe `if_seq_no` and `if_primary_term` parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details.\n\n**Versioning**\n\nEach bulk item can include the version value using the `version` field.\nIt automatically follows the behavior of the index or delete operation based on the `_version` mapping.\nIt also support the `version_type`.\n\n**Routing**\n\nEach bulk item can include the routing value using the `routing` field.\nIt automatically follows the behavior of the index or delete operation based on the `_routing` mapping.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Refresh**\n\nControl when the changes made by this request are visible to search.\n\nNOTE: Only the shards that receive the bulk request will be affected by refresh.\nImagine a `_bulk?refresh=wait_for` request with three documents in it that happen to be routed to different shards in an index with five shards.\nThe request will only wait for those three shards to refresh.\nThe other two shards that make up the index do not participate in the `_bulk` request at all.\n\nYou might want to disable the refresh interval temporarily to improve indexing throughput for large bulk requests.\nRefer to the linked documentation for step-by-step instructions using the index settings API.", "x-api": { "id": "bulk", "name": "bulk", "namespace": null }, "x-method": "POST", "x-path": "/{index}/_bulk", "x-urls": [{ "path": "/_bulk", "methods": ["POST", "PUT"] }, { "path": "/{index}/_bulk", "methods": ["POST", "PUT"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "x-body-format": ["ndjson"], "type": "object", "properties": { "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" }, "list_executed_pipelines": { "type": "boolean", "description": "If `true`, the response will include the ingest pipelines that were run for each index or create.", "x-found-in": "query" }, "pipeline": { "type": "string", "description": "The pipeline identifier to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, setting the value to `_none` turns off 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" }, "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`, wait for a refresh to make this operation visible to search.\nIf `false`, do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", "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" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return.", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards.\nThe default is `1m` (one minute), which 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" }, "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 default is `1`, which waits for each primary shard to be active.", "x-found-in": "query", "x-availability": { "stack": {} } }, "require_alias": { "type": "boolean", "description": "If `true`, the request's actions must target an index alias.", "x-found-in": "query" }, "require_data_stream": { "type": "boolean", "description": "If `true`, the request's actions must target a data stream (existing or to be created).", "x-found-in": "query" }, "operations": { "type": "array", "items": { "anyOf": [{ "$ref": "./_global.bulk.json#/$defs/_global.bulk__OperationContainer" }, { "$ref": "./_global.bulk.json#/$defs/_global.bulk__UpdateAction" }, {}] }, "x-found-in": "body", "x-body-root": true }, "index": { "type": "string", "description": "The name of the data stream, index, or index alias to perform bulk actions on.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "bulk", "description": "Bulk index or delete documents.\n\nPerform multiple `index`, `create`, `delete`, and `update` actions in a single request.\nThis reduces overhead and can greatly increase indexing speed.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To use the `create` action, you must have the `create_doc`, `create`, `index`, or `write` index privilege. Data streams support only the `create` action.\n* To use the `index` action, you must have the `create`, `index`, or `write` index privilege.\n* To use the `delete` action, you must have the `delete` or `write` index privilege.\n* To use the `update` action, you must have the `index` or `write` index privilege.\n* To automatically create a data stream or index with a bulk API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n* To make the result of a bulk operation visible to search using the `refresh` parameter, you must have the `maintenance` or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nThe actions are specified in the request body using a newline delimited JSON (NDJSON) structure:\n\n```\naction_and_meta_data\\n\noptional_source\\n\naction_and_meta_data\\n\noptional_source\\n\n....\naction_and_meta_data\\n\noptional_source\\n\n```\n\nThe `index` and `create` actions expect a source on the next line and have the same semantics as the `op_type` parameter in the standard index API.\nA `create` action fails if a document with the same ID already exists in the target\nAn `index` action adds or replaces a document as necessary.\n\nNOTE: Data streams support only the `create` action.\nTo update or delete a document in a data stream, you must target the backing index containing the document.\n\nAn `update` action expects that the partial doc, upsert, and script and its options are specified on the next line.\n\nA `delete` action does not expect a source on the next line and has the same semantics as the standard delete API.\n\nNOTE: The final line of data must end with a newline character (`\\n`).\nEach newline character may be preceded by a carriage return (`\\r`).\nWhen sending NDJSON data to the `_bulk` endpoint, use a `Content-Type` header of `application/json` or `application/x-ndjson`.\nBecause this format uses literal newline characters (`\\n`) as delimiters, make sure that the JSON actions and sources are not pretty printed.\n\nIf you provide a target in the request path, it is used for any actions that don't explicitly specify an `_index` argument.\n\nA note on the format: the idea here is to make processing as fast as possible.\nAs some of the actions are redirected to other shards on other nodes, only `action_meta_data` is parsed on the receiving node side.\n\nClient libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible.\n\nThere is no \"correct\" number of actions to perform in a single bulk request.\nExperiment with different settings to find the optimal size for your particular workload.\nNote that Elasticsearch limits the maximum size of a HTTP request to 100mb by default so clients must ensure that no request exceeds this size.\nIt is not possible to index a single document that exceeds the size limit, so you must pre-process any such documents into smaller pieces before sending them to Elasticsearch.\nFor instance, split documents into pages or chapters before indexing them, or store raw binary data in a system outside Elasticsearch and replace the raw data with a link to the external system in the documents that you send to Elasticsearch.\n\n**Client suppport for bulk requests**\n\nSome of the officially supported clients provide helpers to assist with bulk requests and reindexing:\n\n* Go: Check out `esutil.BulkIndexer`\n* Perl: Check out `Search::Elasticsearch::Client::5_0::Bulk` and `Search::Elasticsearch::Client::5_0::Scroll`\n* Python: Check out `elasticsearch.helpers.*`\n* JavaScript: Check out `client.helpers.*`\n* Java: Check out `co.elastic.clients.elasticsearch._helpers.bulk.BulkIngester`\n* .NET: Check out `BulkAllObservable`\n* PHP: Check out bulk indexing.\n* Ruby: Check out `Elasticsearch::Helpers::BulkHelper`\n\n**Submitting bulk requests with cURL**\n\nIf you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`.\nThe latter doesn't preserve newlines. For example:\n\n```\n$ cat requests\n{ \"index\" : { \"_index\" : \"test\", \"_id\" : \"1\" } }\n{ \"field1\" : \"value1\" }\n$ curl -s -H \"Content-Type: application/x-ndjson\" -XPOST localhost:9200/_bulk --data-binary \"@requests\"; echo\n{\"took\":7, \"errors\": false, \"items\":[{\"index\":{\"_index\":\"test\",\"_id\":\"1\",\"_version\":1,\"result\":\"created\",\"forced_refresh\":false}}]}\n```\n\n**Optimistic concurrency control**\n\nEach `index` and `delete` action within a bulk API call may include the `if_seq_no` and `if_primary_term` parameters in their respective action and meta data lines.\nThe `if_seq_no` and `if_primary_term` parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details.\n\n**Versioning**\n\nEach bulk item can include the version value using the `version` field.\nIt automatically follows the behavior of the index or delete operation based on the `_version` mapping.\nIt also support the `version_type`.\n\n**Routing**\n\nEach bulk item can include the routing value using the `routing` field.\nIt automatically follows the behavior of the index or delete operation based on the `_routing` mapping.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Refresh**\n\nControl when the changes made by this request are visible to search.\n\nNOTE: Only the shards that receive the bulk request will be affected by refresh.\nImagine a `_bulk?refresh=wait_for` request with three documents in it that happen to be routed to different shards in an index with five shards.\nThe request will only wait for those three shards to refresh.\nThe other two shards that make up the index do not participate in the `_bulk` request at all.\n\nYou might want to disable the refresh interval temporarily to improve indexing throughput for large bulk requests.\nRefer to the linked documentation for step-by-step instructions using the index settings API.", "x-api": { "id": "bulk", "name": "bulk", "namespace": null }, "x-method": "POST", "x-path": "/{index}/_bulk", "x-urls": [{ "path": "/_bulk", "methods": ["POST", "PUT"] }, { "path": "/{index}/_bulk", "methods": ["POST", "PUT"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "x-body-format": ["ndjson"], "type": "object", "properties": { "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" }, "list_executed_pipelines": { "type": "boolean", "description": "If `true`, the response will include the ingest pipelines that were run for each index or create.", "x-found-in": "query" }, "pipeline": { "type": "string", "description": "The pipeline identifier to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, setting the value to `_none` turns off 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" }, "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`, wait for a refresh to make this operation visible to search.\nIf `false`, do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", "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", "x-availability": { "stack": { "stability": "stable" } } }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return.", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards.\nThe default is `1m` (one minute), which 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" }, "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 default is `1`, which waits for each primary shard to be active.", "x-found-in": "query", "x-availability": { "stack": {} } }, "require_alias": { "type": "boolean", "description": "If `true`, the request's actions must target an index alias.", "x-found-in": "query" }, "require_data_stream": { "type": "boolean", "description": "If `true`, the request's actions must target a data stream (existing or to be created).", "x-found-in": "query" }, "operations": { "type": "array", "items": { "anyOf": [{ "$ref": "./_global.bulk.json#/$defs/_global.bulk__OperationContainer" }, { "$ref": "./_global.bulk.json#/$defs/_global.bulk__UpdateAction" }, {}] }, "x-found-in": "body", "x-body-root": true }, "index": { "type": "string", "description": "The name of the data stream, index, or index alias to perform bulk actions on.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/es/json/cat.recovery.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.recovery", "description": "Get shard recovery information.\n\nGet information about ongoing and completed shard recoveries.\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.", "x-api": { "id": "cat.recovery", "name": "recovery", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/recovery/{index}", "x-urls": [{ "path": "/_cat/recovery", "methods": ["GET"] }, { "path": "/_cat/recovery/{index}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "x-response-type": ["text", "json"], "type": "object", "properties": { "active_only": { "type": "boolean", "description": "If `true`, the response only includes ongoing shard recoveries.", "x-found-in": "query" }, "detailed": { "type": "boolean", "description": "If `true`, the response includes detailed information about shard recoveries.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" }, "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatRecoveryColumns", "description": "A comma-separated list of columns names to display.\nIt supports simple wildcards.", "x-found-in": "query" }, "s": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.", "x-found-in": "query" }, "format": { "type": "string", "description": "Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "help": { "type": "boolean", "description": "When set to `true` will output available columns. This option\ncan't be combined with any other query string option.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "v": { "type": "boolean", "description": "When set to `true` will enable verbose output.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "bytes": { "$ref": "./_types.json#/$defs/_types__Bytes", "description": "Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "time": { "$ref": "./_types.json#/$defs/_types__TimeUnit", "description": "Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.recovery", "description": "Get shard recovery information.\n\nGet information about ongoing and completed shard recoveries.\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.", "x-api": { "id": "cat.recovery", "name": "recovery", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/recovery/{index}", "x-urls": [{ "path": "/_cat/recovery", "methods": ["GET"] }, { "path": "/_cat/recovery/{index}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "x-response-type": ["text", "json"], "type": "object", "properties": { "active_only": { "type": "boolean", "description": "If `true`, the response only includes shard recoveries that have not yet completed (excludes `done` stage).", "x-found-in": "query" }, "detailed": { "type": "boolean", "description": "If `true`, the response includes detailed information about shard recoveries.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" }, "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatRecoveryColumns", "description": "A comma-separated list of columns names to display.\nIt supports simple wildcards.", "x-found-in": "query" }, "s": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.", "x-found-in": "query" }, "format": { "type": "string", "description": "Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "help": { "type": "boolean", "description": "When set to `true` will output available columns. This option\ncan't be combined with any other query string option.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "v": { "type": "boolean", "description": "When set to `true` will enable verbose output.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "bytes": { "$ref": "./_types.json#/$defs/_types__Bytes", "description": "Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "time": { "$ref": "./_types.json#/$defs/_types__TimeUnit", "description": "Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/es/json/delete.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete", "description": "Delete a document.\n\nRemove a JSON document from the specified index.\n\nNOTE: You cannot send deletion requests directly to a data stream.\nTo delete a document in a data stream, you must target the backing index containing the document.\n\n**Optimistic concurrency control**\n\nDelete operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Versioning**\n\nEach document indexed is versioned.\nWhen deleting a document, the version can be specified to make sure the relevant document you are trying to delete is actually being deleted and it has not changed in the meantime.\nEvery write operation run on a document, deletes included, causes its version to be incremented.\nThe version number of a deleted document remains available for a short time after deletion to allow for control of concurrent operations.\nThe length of time for which a deleted document's version remains available is determined by the `index.gc_deletes` index setting.\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to delete a document.\n\nIf the `_routing` mapping is set to `required` and no routing value is specified, the delete API throws a `RoutingMissingException` and rejects the request.\n\nFor example:\n\n```\nDELETE /my-index-000001/_doc/1?routing=shard-1\n```\n\nThis request deletes the document with ID 1, but it is routed based on the user.\nThe document is not deleted if the correct routing is not specified.\n\n**Distributed**\n\nThe delete operation gets hashed into a specific shard ID.\nIt then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group.", "x-api": { "id": "delete", "name": "delete", "namespace": null }, "x-method": "DELETE", "x-path": "/{index}/_doc/{id}", "x-urls": [{ "path": "/{index}/_doc/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "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" }, "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 active shards.\n\nThis parameter is useful for situations where the primary shard assigned to perform the delete operation might not be available when the delete operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a store or undergoing relocation.\nBy default, the delete operation will wait on the primary shard to become available for up to 1 minute before failing and responding with an error.", "x-found-in": "query" }, "version": { "type": "number", "description": "An explicit version number for concurrency control.\nIt must match the current version of the document for the request to succeed.", "x-found-in": "query" }, "version_type": { "$ref": "./_types.json#/$defs/_types__VersionType", "description": "The version type.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "The minimum number of shard copies that must be active before proceeding with the operation.\nYou can set it 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", "x-availability": { "stack": {} } }, "id": { "type": "string", "description": "A unique identifier for the document.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the target index.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id", "index"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete", "description": "Delete a document.\n\nRemove a JSON document from the specified index.\n\nNOTE: You cannot send deletion requests directly to a data stream.\nTo delete a document in a data stream, you must target the backing index containing the document.\n\n**Optimistic concurrency control**\n\nDelete operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Versioning**\n\nEach document indexed is versioned.\nWhen deleting a document, the version can be specified to make sure the relevant document you are trying to delete is actually being deleted and it has not changed in the meantime.\nEvery write operation run on a document, deletes included, causes its version to be incremented.\nThe version number of a deleted document remains available for a short time after deletion to allow for control of concurrent operations.\nThe length of time for which a deleted document's version remains available is determined by the `index.gc_deletes` index setting.\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to delete a document.\n\nIf the `_routing` mapping is set to `required` and no routing value is specified, the delete API throws a `RoutingMissingException` and rejects the request.\n\nFor example:\n\n```\nDELETE /my-index-000001/_doc/1?routing=shard-1\n```\n\nThis request deletes the document with ID 1, but it is routed based on the user.\nThe document is not deleted if the correct routing is not specified.\n\n**Distributed**\n\nThe delete operation gets hashed into a specific shard ID.\nIt then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group.", "x-api": { "id": "delete", "name": "delete", "namespace": null }, "x-method": "DELETE", "x-path": "/{index}/_doc/{id}", "x-urls": [{ "path": "/{index}/_doc/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "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" }, "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", "x-availability": { "stack": { "stability": "stable" } } }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for active shards.\n\nThis parameter is useful for situations where the primary shard assigned to perform the delete operation might not be available when the delete operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a store or undergoing relocation.\nBy default, the delete operation will wait on the primary shard to become available for up to 1 minute before failing and responding with an error.", "x-found-in": "query" }, "version": { "type": "number", "description": "An explicit version number for concurrency control.\nIt must match the current version of the document for the request to succeed.", "x-found-in": "query" }, "version_type": { "$ref": "./_types.json#/$defs/_types__VersionType", "description": "The version type.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "The minimum number of shard copies that must be active before proceeding with the operation.\nYou can set it 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", "x-availability": { "stack": {} } }, "id": { "type": "string", "description": "A unique identifier for the document.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the target index.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id", "index"] }

package/lib/es/json/delete_by_query.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete_by_query", "description": "Delete documents.\n\nDeletes documents that match the specified query.\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* `delete` 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.\nWhen you submit a delete by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and deletes matching documents using internal versioning.\nIf a document changes between the time that the snapshot is taken and the delete operation is processed, it results in a version conflict and the delete operation fails.\n\nNOTE: Documents with a version equal to 0 cannot be deleted using delete by query because internal versioning does not support 0 as a valid version number.\n\nWhile processing a delete by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents to delete.\nA bulk delete request is performed for each batch of matching documents.\nIf a search or bulk request is rejected, the requests are retried up to 10 times, with exponential back off.\nIf the maximum retry limit is reached, processing halts and all failed requests are returned in the response.\nAny delete requests that completed successfully still stick, they are not rolled back.\n\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 delete more documents from the source than `max_docs` until it has successfully deleted `max_docs documents`, or it has gone through every document in the source query.\n\n**Throttling delete requests**\n\nTo control the rate at which delete by query issues batches of delete 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 disable 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\nDelete by query supports sliced scroll to parallelize the delete process.\nThis can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nSetting `slices` to `auto` lets Elasticsearch choose the number of slices to use.\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.\nAdding slices to the delete by query operation creates 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 earlier point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being deleted.\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* Delete performance scales linearly across available resources with the number of slices.\n\nWhether query or delete performance dominates the runtime depends on the documents being reindexed and cluster resources.\n\n**Cancel a delete by query operation**\n\nAny delete by query can be canceled using the task cancel API. For example:\n\n```\nPOST _tasks/r1A2WoRbTwKZ516z6NEs5A:36619/_cancel\n```\n\nThe task ID can be found by using the get tasks API.\n\nCancellation should happen quickly but might take a few seconds.\nThe get task status API will continue to list the delete by query task until this task checks that it has been cancelled and terminates itself.", "x-api": { "id": "delete_by_query", "name": "delete-by-query", "namespace": null }, "x-method": "POST", "x-path": "/{index}/_delete_by_query", "x-urls": [{ "path": "/{index}/_delete_by_query", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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": "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": "What to do if delete by query hits version conflicts: `abort` or `proceed`.", "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" }, "max_docs": { "type": "number", "description": "The maximum number of documents to delete.", "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" }, "refresh": { "type": "boolean", "description": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.\nThis is different than the delete API's `refresh` parameter, which causes just the shard that received the delete request to be refreshed.\nUnlike the delete API, it does not support `wait_for`.", "x-found-in": "query" }, "request_cache": { "type": "boolean", "description": "If `true`, the request cache is used for this request.\nDefaults to the index-level setting.", "x-found-in": "query" }, "requests_per_second": { "type": "number", "description": "The maximum number of documents to delete per second, across the entire delete-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" }, "q": { "type": "string", "description": "A query in the Lucene query string syntax.", "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": "The explicit timeout for each search request.\nIt defaults to no timeout.", "x-found-in": "query" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "description": "The type of the search operation.\nAvailable 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": { "$ref": "./_types.json#/$defs/_types__Sort", "description": "A sort object that specifies the order of deleted documents.", "x-found-in": "body" }, "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\nUse 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 deletion request waits for active shards.", "x-found-in": "query" }, "version": { "type": "boolean", "description": "If `true`, returns the document version as part of a hit.", "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` value controls how long each write request waits for unavailable shards to become available.", "x-found-in": "query", "x-availability": { "stack": {} } }, "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 you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space.", "x-found-in": "query" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "The documents to delete specified with Query DSL.", "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["index"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete_by_query", "description": "Delete documents.\n\nDeletes documents that match the specified query.\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* `delete` 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.\nWhen you submit a delete by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and deletes matching documents using internal versioning.\nIf a document changes between the time that the snapshot is taken and the delete operation is processed, it results in a version conflict and the delete operation fails.\n\nNOTE: Documents with a version equal to 0 cannot be deleted using delete by query because internal versioning does not support 0 as a valid version number.\n\nWhile processing a delete by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents to delete.\nA bulk delete request is performed for each batch of matching documents.\nIf a search or bulk request is rejected, the requests are retried up to 10 times, with exponential back off.\nIf the maximum retry limit is reached, processing halts and all failed requests are returned in the response.\nAny delete requests that completed successfully still stick, they are not rolled back.\n\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 delete more documents from the source than `max_docs` until it has successfully deleted `max_docs documents`, or it has gone through every document in the source query.\n\n**Throttling delete requests**\n\nTo control the rate at which delete by query issues batches of delete 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 disable 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\nDelete by query supports sliced scroll to parallelize the delete process.\nThis can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nSetting `slices` to `auto` lets Elasticsearch choose the number of slices to use.\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.\nAdding slices to the delete by query operation creates 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 earlier point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being deleted.\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* Delete performance scales linearly across available resources with the number of slices.\n\nWhether query or delete performance dominates the runtime depends on the documents being reindexed and cluster resources.\n\n**Cancel a delete by query operation**\n\nAny delete by query can be canceled using the task cancel API. For example:\n\n```\nPOST _tasks/r1A2WoRbTwKZ516z6NEs5A:36619/_cancel\n```\n\nThe task ID can be found by using the get tasks API.\n\nCancellation should happen quickly but might take a few seconds.\nThe get task status API will continue to list the delete by query task until this task checks that it has been cancelled and terminates itself.", "x-api": { "id": "delete_by_query", "name": "delete-by-query", "namespace": null }, "x-method": "POST", "x-path": "/{index}/_delete_by_query", "x-urls": [{ "path": "/{index}/_delete_by_query", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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": "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": "What to do if delete by query hits version conflicts: `abort` or `proceed`.", "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" }, "max_docs": { "type": "number", "description": "The maximum number of documents to delete.", "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" }, "refresh": { "type": "boolean", "description": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.\nThis is different than the delete API's `refresh` parameter, which causes just the shard that received the delete request to be refreshed.\nUnlike the delete API, it does not support `wait_for`.", "x-found-in": "query" }, "request_cache": { "type": "boolean", "description": "If `true`, the request cache is used for this request.\nDefaults to the index-level setting.", "x-found-in": "query" }, "requests_per_second": { "type": "number", "description": "The maximum number of documents to delete per second, across the entire delete-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", "x-availability": { "stack": { "stability": "stable" } } }, "q": { "type": "string", "description": "A query in the Lucene query string syntax.", "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": "The explicit timeout for each search request.\nIt defaults to no timeout.", "x-found-in": "query" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "description": "The type of the search operation.\nAvailable 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": { "$ref": "./_types.json#/$defs/_types__Sort", "description": "A sort object that specifies the order of deleted documents.", "x-found-in": "body" }, "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\nUse 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 deletion request waits for active shards.", "x-found-in": "query" }, "version": { "type": "boolean", "description": "If `true`, returns the document version as part of a hit.", "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` value controls how long each write request waits for unavailable shards to become available.", "x-found-in": "query", "x-availability": { "stack": {} } }, "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 you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space.", "x-found-in": "query" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "The documents to delete specified with Query DSL.", "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["index"] }

package/lib/es/json/index.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "index", "description": "Create or update a document in an index.\n\nAdd a JSON document to the specified data stream or index and make it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.\n\nNOTE: You cannot use this API to send update requests for existing documents in a data stream.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add or overwrite a document using the `PUT /<target>/_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege.\n* To add a document using the `POST /<target>/_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nNOTE: Replica shards might not all be started when an indexing operation returns successfully.\nBy default, only the primary is required. Set `wait_for_active_shards` to change this default behavior (this parameter is not available in Elasticsearch Serverless).\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Optimistic concurrency control**\n\nIndex operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter (this parameter is not available in Elasticsearch Serverless).\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.\n\n**No operation (noop) updates**\n\nWhen updating a document by using this API, a new version of the document is always created even if the document hasn't changed.\nIf this isn't acceptable use the `_update` API with `detect_noop` set to `true`.\nThe `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.\n\nThere isn't a definitive rule for when noop updates aren't acceptable.\nIt's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.\n\n**Versioning**\n\nEach indexed document is given a version number.\nBy default, internal versioning is used that starts at 1 and increments with each update, deletes included.\nOptionally, the version number can be set to an external value (for example, if maintained in a database).\nTo enable this functionality, `version_type` should be set to `external`.\nThe value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.\n\nNOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations.\nIf no version is provided, the operation runs without any version checks.\n\nWhen using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.\nIf true, the document will be indexed and the new version number used.\nIf the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:\n\n```\nPUT my-index-000001/_doc/1?version=2&version_type=external\n{\n  \"user\": {\n    \"id\": \"elkbee\"\n  }\n}\n```\n\nIn this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.\nIf the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).\n\nA nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.\nEven the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order.", "x-api": { "id": "index", "name": "index", "namespace": null }, "x-method": "PUT", "x-path": "/{index}/_doc/{id}", "x-urls": [{ "path": "/{index}/_doc/{id}", "methods": ["PUT", "POST"] }, { "path": "/{index}/_doc", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "op_type": { "$ref": "./_types.json#/$defs/_types__OpType", "description": "Set to `create` to only index the document if it does not already exist (put if absent).\nIf a document with the specified `_id` already exists, the indexing operation will fail.\nThe behavior is the same as using the `<index>/_create` endpoint.\nIf a document ID is specified, this paramater defaults to `index`.\nOtherwise, it defaults to `create`.\nIf the request targets a data stream, an `op_type` of `create` is required.", "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" }, "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" }, "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" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.\n\nThis parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation.\nBy default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error.\nThe actual wait time could be longer, particularly when multiple waits occur.", "x-found-in": "query" }, "version": { "type": "number", "description": "An explicit version number for concurrency control.\nIt must be a non-negative long number.", "x-found-in": "query" }, "version_type": { "$ref": "./_types.json#/$defs/_types__VersionType", "description": "The version type.", "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.\nYou can set it 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", "x-availability": { "stack": {} } }, "require_alias": { "type": "boolean", "description": "If `true`, the destination must be an index alias.", "x-found-in": "query" }, "require_data_stream": { "type": "boolean", "description": "If `true`, the request's actions must target a data stream (existing or to be created).", "x-found-in": "query" }, "document": { "x-found-in": "body", "x-body-root": true }, "id": { "type": "string", "description": "A unique identifier for the document.\nTo automatically generate a document ID, use the `POST /<target>/_doc/` request format and omit this parameter.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the data stream or index to target.\nIf the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.\nIf the target doesn't exist and doesn't match a data stream template, this request creates the index.\nYou can check for existing targets with the resolve index API.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["index"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "index", "description": "Create or update a document in an index.\n\nAdd a JSON document to the specified data stream or index and make it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.\n\nNOTE: You cannot use this API to send update requests for existing documents in a data stream.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add or overwrite a document using the `PUT /<target>/_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege.\n* To add a document using the `POST /<target>/_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nNOTE: Replica shards might not all be started when an indexing operation returns successfully.\nBy default, only the primary is required. Set `wait_for_active_shards` to change this default behavior (this parameter is not available in Elasticsearch Serverless).\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Optimistic concurrency control**\n\nIndex operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter (this parameter is not available in Elasticsearch Serverless).\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.\n\n**No operation (noop) updates**\n\nWhen updating a document by using this API, a new version of the document is always created even if the document hasn't changed.\nIf this isn't acceptable use the `_update` API with `detect_noop` set to `true`.\nThe `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.\n\nThere isn't a definitive rule for when noop updates aren't acceptable.\nIt's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.\n\n**Versioning**\n\nEach indexed document is given a version number.\nBy default, internal versioning is used that starts at 1 and increments with each update, deletes included.\nOptionally, the version number can be set to an external value (for example, if maintained in a database).\nTo enable this functionality, `version_type` should be set to `external`.\nThe value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.\n\nNOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations.\nIf no version is provided, the operation runs without any version checks.\n\nWhen using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.\nIf true, the document will be indexed and the new version number used.\nIf the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:\n\n```\nPUT my-index-000001/_doc/1?version=2&version_type=external\n{\n  \"user\": {\n    \"id\": \"elkbee\"\n  }\n}\n```\n\nIn this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.\nIf the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).\n\nA nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.\nEven the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order.", "x-api": { "id": "index", "name": "index", "namespace": null }, "x-method": "PUT", "x-path": "/{index}/_doc/{id}", "x-urls": [{ "path": "/{index}/_doc/{id}", "methods": ["PUT", "POST"] }, { "path": "/{index}/_doc", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "op_type": { "$ref": "./_types.json#/$defs/_types__OpType", "description": "Set to `create` to only index the document if it does not already exist (put if absent).\nIf a document with the specified `_id` already exists, the indexing operation will fail.\nThe behavior is the same as using the `<index>/_create` endpoint.\nIf a document ID is specified, this paramater defaults to `index`.\nOtherwise, it defaults to `create`.\nIf the request targets a data stream, an `op_type` of `create` is required.", "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" }, "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" }, "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", "x-availability": { "stack": { "stability": "stable" } } }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.\n\nThis parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation.\nBy default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error.\nThe actual wait time could be longer, particularly when multiple waits occur.", "x-found-in": "query" }, "version": { "type": "number", "description": "An explicit version number for concurrency control.\nIt must be a non-negative long number.", "x-found-in": "query" }, "version_type": { "$ref": "./_types.json#/$defs/_types__VersionType", "description": "The version type.", "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.\nYou can set it 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", "x-availability": { "stack": {} } }, "require_alias": { "type": "boolean", "description": "If `true`, the destination must be an index alias.", "x-found-in": "query" }, "require_data_stream": { "type": "boolean", "description": "If `true`, the request's actions must target a data stream (existing or to be created).", "x-found-in": "query" }, "document": { "x-found-in": "body", "x-body-root": true }, "id": { "type": "string", "description": "A unique identifier for the document.\nTo automatically generate a document ID, use the `POST /<target>/_doc/` request format and omit this parameter.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the data stream or index to target.\nIf the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.\nIf the target doesn't exist and doesn't match a data stream template, this request creates the index.\nYou can check for existing targets with the resolve index API.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["index"] }

package/lib/es/json/indices.recovery.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.recovery", "description": "Get index recovery information.\n\nGet information about ongoing and completed shard recoveries for one or more indices.\nFor data streams, the API returns information for the stream's backing indices.\n\nAll recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time.\n\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard.\nWhen a shard recovery completes, the recovered shard is available for search and indexing.\n\nRecovery automatically occurs during the following processes:\n\n* When creating an index for the first time.\n* When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path.\n* Creation of new replica shard copies from the primary.\n* Relocation of a shard copy to a different node in the same cluster.\n* A snapshot restore operation.\n* A clone, shrink, or split operation.\n\nYou can determine the cause of a shard recovery using the recovery or cat recovery APIs.\n\nThe index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster.\nIt only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist.\nThis means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.", "x-api": { "id": "indices.recovery", "name": "recovery", "namespace": "indices" }, "x-method": "GET", "x-path": "/{index}/_recovery", "x-urls": [{ "path": "/_recovery", "methods": ["GET"] }, { "path": "/{index}/_recovery", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "active_only": { "type": "boolean", "description": "If `true`, the response only includes ongoing shard recoveries.", "x-found-in": "query" }, "detailed": { "type": "boolean", "description": "If `true`, the response includes detailed information about shard recoveries.", "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" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "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.\nSupports comma-separated values, such as `open,hidden`.", "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" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.recovery", "description": "Get index recovery information.\n\nGet information about ongoing and completed shard recoveries for one or more indices.\nFor data streams, the API returns information for the stream's backing indices.\n\nAll recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time.\n\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard.\nWhen a shard recovery completes, the recovered shard is available for search and indexing.\n\nRecovery automatically occurs during the following processes:\n\n* When creating an index for the first time.\n* When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path.\n* Creation of new replica shard copies from the primary.\n* Relocation of a shard copy to a different node in the same cluster.\n* A snapshot restore operation.\n* A clone, shrink, or split operation.\n\nYou can determine the cause of a shard recovery using the recovery or cat recovery APIs.\n\nThe index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster.\nIt only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist.\nThis means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.", "x-api": { "id": "indices.recovery", "name": "recovery", "namespace": "indices" }, "x-method": "GET", "x-path": "/{index}/_recovery", "x-urls": [{ "path": "/_recovery", "methods": ["GET"] }, { "path": "/{index}/_recovery", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "active_only": { "type": "boolean", "description": "If `true`, the response only includes shard recoveries that have not yet completed (excludes `DONE` stage).", "x-found-in": "query" }, "detailed": { "type": "boolean", "description": "If `true`, the response includes detailed information about shard recoveries.", "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" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "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.\nSupports comma-separated values, such as `open,hidden`.", "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" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/es/json/snapshot.delete.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.delete", "description": "Delete snapshots.", "x-api": { "id": "snapshot.delete", "name": "delete", "namespace": "snapshot" }, "x-method": "DELETE", "x-path": "/_snapshot/{repository}/{snapshot}", "x-urls": [{ "path": "/_snapshot/{repository}/{snapshot}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request returns a response when the matching snapshots are all deleted.\nIf `false`, the request returns a response as soon as the deletes are scheduled.", "x-found-in": "query" }, "repository": { "type": "string", "description": "The name of the repository to delete a snapshot from.", "x-found-in": "path" }, "snapshot": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of snapshot names to delete.\nIt also accepts wildcards (`*`).", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["repository", "snapshot"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.delete", "description": "Delete snapshots.", "x-api": { "id": "snapshot.delete", "name": "delete", "namespace": "snapshot" }, "x-method": "DELETE", "x-path": "/_snapshot/{repository}/{snapshot}", "x-urls": [{ "path": "/_snapshot/{repository}/{snapshot}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `false`, the request returns a response as soon as the deletes are scheduled.\nIf `true`, the request returns a response when the matching snapshots are all deleted, and the post-deletion cleanup work associated with the request has completed.\nIf you make several requests to the delete-snapshots API targetting overlapping collections of snapshots then some of those requests may perform different parts of the associated post-deletion cleanup work, returning their responses at different times.\nFor example, if you make two requests to delete the same snapshot then sometimes all of the post-deletion cleanup work will be associated with the first request, delaying its response, while the second request has no associated post-deletion cleanup work and receives its response as soon as the snapshot has been deleted.", "x-found-in": "query" }, "repository": { "type": "string", "description": "The name of the repository to delete a snapshot from.", "x-found-in": "path" }, "snapshot": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of snapshot names to delete.\nIt also accepts wildcards (`*`).", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["repository", "snapshot"] }

package/lib/es/json/update.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "update", "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.", "x-api": { "id": "update", "name": "update", "namespace": null }, "x-method": "POST", "x-path": "/{index}/_update/{id}", "x-urls": [{ "path": "/{index}/_update/{id}", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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", "x-availability": { "stack": {} } }, "_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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id", "index"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "update", "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.", "x-api": { "id": "update", "name": "update", "namespace": null }, "x-method": "POST", "x-path": "/{index}/_update/{id}", "x-urls": [{ "path": "/{index}/_update/{id}", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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", "x-availability": { "stack": { "stability": "stable" } } }, "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", "x-availability": { "stack": {} } }, "_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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id", "index"] }

package/lib/es/json/update_by_query.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "update_by_query", "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:", "x-api": { "id": "update_by_query", "name": "update-by-query", "namespace": null }, "x-method": "POST", "x-path": "/{index}/_update_by_query", "x-urls": [{ "path": "/{index}/_update_by_query", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "2.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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", "x-availability": { "stack": {} } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["index"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "update_by_query", "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:", "x-api": { "id": "update_by_query", "name": "update-by-query", "namespace": null }, "x-method": "POST", "x-path": "/{index}/_update_by_query", "x-urls": [{ "path": "/{index}/_update_by_query", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "2.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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", "x-availability": { "stack": { "stability": "stable" } } }, "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", "x-availability": { "stack": {} } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["index"] }

package/lib/es/schemas/_types.mapping.d.ts

@@ -397,6 +397,7 @@ export declare const MappingTypeMapping: z.ZodObject<{
         mode: z.ZodOptional<z.ZodEnum<{
             disabled: "disabled";
             stored: "stored";
+            columnar_stored: "columnar_stored";
             synthetic: "synthetic";
         }>>;
     }, z.core.$strip>>>;

package/lib/es/schemas/_types.mapping.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"_types.mapping.d.ts","sourceRoot":"","sources":["../../../src/es/schemas/_types.mapping.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,KAAK,EAAE,MAAM,EAAY,YAAY,EAAwB,MAAM,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1G,OAAO,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AACjE,OAAO,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAA;AAC7D,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAkD,oBAAoB,EAAE,eAAe,EAAmF,8BAA8B,EAAE,MAAM,0BAA0B,CAAA;AAC1R,OAAO,KAAK,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAA;AAE9F,MAAM,MAAM,yBAAyB,GAAG,MAAM,CAAC,KAAK,EAAE,wBAAwB,CAAC,CAAA;AAC/E,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,yBAAyB,CAAyG,CAAA;AAC/K,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA0rB,CAAA;AACvtB,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IACnE,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAClC,OAAO,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAA;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IAC/D,qBAAqB,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAA;CACnE;AACD,eAAO,MAAM,mBAAmB;;gBAEX,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;YAG3E,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;iBAElD,CAAA;AACtC,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAErE,eAAO,MAAM,eAAe;;;;;;;;;;;iBAWM,CAAA;AAClC,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAE7D,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IACnE,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAClC,OAAO,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAA;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IAC/D,qBAAqB,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAA;IAClE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAC5B;AACD,eAAO,MAAM,uBAAuB;;gBAEf,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;YAG3E,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;iBAI9C,CAAA;AAC1C,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E,MAAM,WAAW,iCAAiC;IAChD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IACnE,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAClC,OAAO,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAA;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IAC/D,qBAAqB,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAA;IAClE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC3B,UAAU,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAA;CAC1C;AACD,eAAO,MAAM,4BAA4B;;gBAEpB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;YAG3E,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;;;;;iBAKzC,CAAA;AAC/C,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEvF,MAAM,WAAW,8BAA8B;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IACnE,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAClC,OAAO,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAA;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IAC/D,qBAAqB,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAA;IAClE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC3B,UAAU,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAA;IACzC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC5B,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC3B,eAAe,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAA;IAClD,MAAM,CAAC,EAAE,WAAW,GAAG,iBAAiB,GAAG,SAAS,CAAA;IACpD,kBAAkB,CAAC,EAAE,2BAA2B,GAAG,SAAS,CAAA;IAC5D,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAC5C;AACD,eAAO,MAAM,yBAAyB;;gBAEjB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;YAG3E,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAa5C,CAAA;AAC5C,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAEjF,eAAO,MAAM,0BAA0B;;iBAEM,CAAA;AAC7C,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF,MAAM,WAAW,6BAA6B;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IACnE,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAClC,OAAO,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAA;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IAC/D,qBAAqB,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAA;IAClE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC3B,UAAU,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAA;IACzC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC5B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAC5B;AACD,eAAO,MAAM,wBAAwB;;gBAEhB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;YAG3E,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;;;;;;;;iBAQ7C,CAAA;AAC3C,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,eAAO,MAAM,iBAAiB;;iBAEM,CAAA;AACpC,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEjE,eAAO,MAAM,gBAAgB;;iBAEM,CAAA;AACnC,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAkBM,CAAA;AACrC,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA"}
+{"version":3,"file":"_types.mapping.d.ts","sourceRoot":"","sources":["../../../src/es/schemas/_types.mapping.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,KAAK,EAAE,MAAM,EAAY,YAAY,EAAwB,MAAM,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1G,OAAO,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AACjE,OAAO,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAA;AAC7D,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAkD,oBAAoB,EAAE,eAAe,EAAmF,8BAA8B,EAAE,MAAM,0BAA0B,CAAA;AAC1R,OAAO,KAAK,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAA;AAE9F,MAAM,MAAM,yBAAyB,GAAG,MAAM,CAAC,KAAK,EAAE,wBAAwB,CAAC,CAAA;AAC/E,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,yBAAyB,CAAyG,CAAA;AAC/K,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA0rB,CAAA;AACvtB,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IACnE,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAClC,OAAO,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAA;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IAC/D,qBAAqB,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAA;CACnE;AACD,eAAO,MAAM,mBAAmB;;gBAEX,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;YAG3E,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;iBAElD,CAAA;AACtC,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAErE,eAAO,MAAM,eAAe;;;;;;;;;;;iBAWM,CAAA;AAClC,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAE7D,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IACnE,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAClC,OAAO,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAA;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IAC/D,qBAAqB,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAA;IAClE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAC5B;AACD,eAAO,MAAM,uBAAuB;;gBAEf,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;YAG3E,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;iBAI9C,CAAA;AAC1C,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E,MAAM,WAAW,iCAAiC;IAChD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IACnE,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAClC,OAAO,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAA;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IAC/D,qBAAqB,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAA;IAClE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC3B,UAAU,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAA;CAC1C;AACD,eAAO,MAAM,4BAA4B;;gBAEpB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;YAG3E,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;;;;;iBAKzC,CAAA;AAC/C,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEvF,MAAM,WAAW,8BAA8B;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IACnE,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAClC,OAAO,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAA;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IAC/D,qBAAqB,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAA;IAClE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC3B,UAAU,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAA;IACzC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC5B,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC3B,eAAe,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAA;IAClD,MAAM,CAAC,EAAE,WAAW,GAAG,iBAAiB,GAAG,SAAS,CAAA;IACpD,kBAAkB,CAAC,EAAE,2BAA2B,GAAG,SAAS,CAAA;IAC5D,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAC5C;AACD,eAAO,MAAM,yBAAyB;;gBAEjB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;YAG3E,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAa5C,CAAA;AAC5C,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAEjF,eAAO,MAAM,0BAA0B;;iBAEM,CAAA;AAC7C,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF,MAAM,WAAW,6BAA6B;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IACnE,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAClC,OAAO,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAA;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IAC/D,qBAAqB,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAA;IAClE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC3B,UAAU,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAA;IACzC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC5B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAC5B;AACD,eAAO,MAAM,wBAAwB;;gBAEhB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;YAG3E,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,YAAY,EAAE,OAAO,eAAe,CAAC,CAAC;;;;;;;;;;;;;;;iBAQ7C,CAAA;AAC3C,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,eAAO,MAAM,iBAAiB;;iBAEM,CAAA;AACpC,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEjE,eAAO,MAAM,gBAAgB;;iBAEM,CAAA;AACnC,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAkBM,CAAA;AACrC,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA"}