@elastic/schemas 0.5.1 → 0.6.0

package/lib/es/json/dangling_indices.list_dangling_indices.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "dangling_indices.list_dangling_indices", "description": "Get the dangling indices.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.\n\nUse this API to list dangling indices, which you can then import or delete.", "x-api": { "id": "dangling-indices.list_dangling_indices", "name": "list-dangling-indices", "namespace": "dangling-indices" }, "x-method": "GET", "x-path": "/_dangling", "x-urls": [{ "path": "/_dangling", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" } }, "type": "object", "properties": {} }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "dangling_indices.list_dangling_indices", "description": "Get the dangling indices.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.\n\nUse this API to list dangling indices, which you can then import or delete.", "x-api": { "id": "dangling-indices.list_dangling_indices", "name": "list-dangling-indices", "namespace": "dangling-indices" }, "x-method": "GET", "x-path": "/_dangling", "x-urls": [{ "path": "/_dangling", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" } }, "type": "object", "properties": { "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/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" } }, "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" }, "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" } }, "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" }, "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/delete_by_query_rethrottle.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete_by_query_rethrottle", "description": "Throttle a delete by query operation.\n\nChange the number of requests per second for a particular delete by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.", "x-api": { "id": "delete_by_query_rethrottle", "name": "delete-by-query-rethrottle", "namespace": null }, "x-method": "POST", "x-path": "/_delete_by_query/{task_id}/_rethrottle", "x-urls": [{ "path": "/_delete_by_query/{task_id}/_rethrottle", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "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" }, "task_id": { "type": "string", "description": "The ID for the task.", "x-found-in": "path" } }, "required": ["task_id", "requests_per_second"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete_by_query_rethrottle", "description": "Throttle a delete by query operation.\n\nChange the number of requests per second for a particular delete by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.", "x-api": { "id": "delete_by_query_rethrottle", "name": "delete-by-query-rethrottle", "namespace": null }, "x-method": "POST", "x-path": "/_delete_by_query/{task_id}/_rethrottle", "x-urls": [{ "path": "/_delete_by_query/{task_id}/_rethrottle", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "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" }, "task_id": { "type": "string", "description": "The ID for the task.", "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": ["task_id", "requests_per_second"] }

package/lib/es/json/delete_script.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete_script", "description": "Delete a script or search template.\n\nDeletes a stored script or search template.", "x-api": { "id": "delete_script", "name": "delete-script", "namespace": null }, "x-method": "DELETE", "x-path": "/_scripts/{id}", "x-urls": [{ "path": "/_scripts/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "id": { "type": "string", "description": "The identifier for the stored script or search template.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete_script", "description": "Delete a script or search template.\n\nDeletes a stored script or search template.", "x-api": { "id": "delete_script", "name": "delete-script", "namespace": null }, "x-method": "DELETE", "x-path": "/_scripts/{id}", "x-urls": [{ "path": "/_scripts/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "id": { "type": "string", "description": "The identifier for the stored script or search template.", "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"] }

package/lib/es/json/encryption.reset.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "encryption.reset", "description": "Reset the project encryption key.\n\nDestroy the current project encryption key (PEK) and generate a new one.\nThis is the recovery path for when the on-disk encrypted PEK becomes permanently\ninaccessible, for example because the key encryption material protecting it was lost.\n\nAll data that was encrypted under the destroyed key becomes permanently unrecoverable.\nEach feature that stores encrypted data decides how to handle its own data during the\nreset: some features drop the encrypted values entirely, while others preserve the rest\nof the affected data and only clear the values that can no longer be decrypted.\n\nBecause this operation causes permanent data loss, it requires the `accept_data_loss`\nquery parameter to be set to `true`.", "x-api": { "id": "encryption.reset", "name": "reset", "namespace": "encryption" }, "x-method": "POST", "x-path": "/_encryption/_reset", "x-urls": [{ "path": "/_encryption/_reset", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "9.5.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "private" } }, "type": "object", "properties": { "accept_data_loss": { "type": "boolean", "description": "Acknowledge that resetting the project encryption key permanently destroys all data\nthat was encrypted under the current key.\nThe request fails if this is not set to `true`.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "required": ["accept_data_loss"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "encryption.reset", "description": "Reset the project encryption key.\n\nDestroy the current project encryption key (PEK) and generate a new one.\nThis is the recovery path for when the on-disk encrypted PEK becomes permanently\ninaccessible, for example because the key encryption material protecting it was lost.\n\nAll data that was encrypted under the destroyed key becomes permanently unrecoverable.\nEach feature that stores encrypted data decides how to handle its own data during the\nreset: some features drop the encrypted values entirely, while others preserve the rest\nof the affected data and only clear the values that can no longer be decrypted.\n\nBecause this operation causes permanent data loss, it requires the `accept_data_loss`\nquery parameter to be set to `true`.", "x-api": { "id": "encryption.reset", "name": "reset", "namespace": "encryption" }, "x-method": "POST", "x-path": "/_encryption/_reset", "x-urls": [{ "path": "/_encryption/_reset", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "9.5.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "private" } }, "type": "object", "properties": { "accept_data_loss": { "type": "boolean", "description": "Acknowledge that resetting the project encryption key permanently destroys all data\nthat was encrypted under the current key.\nThe request fails if this is not set to `true`.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "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": ["accept_data_loss"] }

package/lib/es/json/enrich.delete_policy.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.delete_policy", "description": "Delete an enrich policy.\n\nDeletes an existing enrich policy and its enrich index.", "x-api": { "id": "enrich.delete_policy", "name": "delete-policy", "namespace": "enrich" }, "x-method": "DELETE", "x-path": "/_enrich/policy/{name}", "x-urls": [{ "path": "/_enrich/policy/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "name": { "type": "string", "description": "Enrich policy to delete.", "x-found-in": "path" } }, "required": ["name"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.delete_policy", "description": "Delete an enrich policy.\n\nDeletes an existing enrich policy and its enrich index.", "x-api": { "id": "enrich.delete_policy", "name": "delete-policy", "namespace": "enrich" }, "x-method": "DELETE", "x-path": "/_enrich/policy/{name}", "x-urls": [{ "path": "/_enrich/policy/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "name": { "type": "string", "description": "Enrich policy to delete.", "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": ["name"] }

package/lib/es/json/enrich.execute_policy.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.execute_policy", "description": "Run an enrich policy.\n\nCreate the enrich index for an existing enrich policy.", "x-api": { "id": "enrich.execute_policy", "name": "execute-policy", "namespace": "enrich" }, "x-method": "PUT", "x-path": "/_enrich/policy/{name}/_execute", "x-urls": [{ "path": "/_enrich/policy/{name}/_execute", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request blocks other enrich policy execution requests until complete.", "x-found-in": "query" }, "name": { "type": "string", "description": "Enrich policy to execute.", "x-found-in": "path" } }, "required": ["name"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.execute_policy", "description": "Run an enrich policy.\n\nCreate the enrich index for an existing enrich policy.", "x-api": { "id": "enrich.execute_policy", "name": "execute-policy", "namespace": "enrich" }, "x-method": "PUT", "x-path": "/_enrich/policy/{name}/_execute", "x-urls": [{ "path": "/_enrich/policy/{name}/_execute", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request blocks other enrich policy execution requests until complete.", "x-found-in": "query" }, "name": { "type": "string", "description": "Enrich policy to execute.", "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": ["name"] }

package/lib/es/json/enrich.get_policy.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.get_policy", "description": "Get an enrich policy.\n\nReturns information about an enrich policy.", "x-api": { "id": "enrich.get_policy", "name": "get-policy", "namespace": "enrich" }, "x-method": "GET", "x-path": "/_enrich/policy/{name}", "x-urls": [{ "path": "/_enrich/policy/{name}", "methods": ["GET"] }, { "path": "/_enrich/policy", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list of enrich policy names used to limit the request.\nTo return information for all enrich policies, omit this parameter.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.get_policy", "description": "Get an enrich policy.\n\nReturns information about an enrich policy.", "x-api": { "id": "enrich.get_policy", "name": "get-policy", "namespace": "enrich" }, "x-method": "GET", "x-path": "/_enrich/policy/{name}", "x-urls": [{ "path": "/_enrich/policy/{name}", "methods": ["GET"] }, { "path": "/_enrich/policy", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list of enrich policy names used to limit the request.\nTo return information for all enrich policies, omit this parameter.", "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/enrich.put_policy.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.put_policy", "description": "Create an enrich policy.\n\nCreates an enrich policy.", "x-api": { "id": "enrich.put_policy", "name": "put-policy", "namespace": "enrich" }, "x-method": "PUT", "x-path": "/_enrich/policy/{name}", "x-urls": [{ "path": "/_enrich/policy/{name}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "geo_match": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches enrich data to incoming documents based on a `geo_shape` query.", "x-found-in": "body" }, "match": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches enrich data to incoming documents based on a `term` query.", "x-found-in": "body" }, "range": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query.", "x-found-in": "body" }, "name": { "type": "string", "description": "Name of the enrich policy to create or update.", "x-found-in": "path" } }, "required": ["name"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.put_policy", "description": "Create an enrich policy.\n\nCreates an enrich policy.", "x-api": { "id": "enrich.put_policy", "name": "put-policy", "namespace": "enrich" }, "x-method": "PUT", "x-path": "/_enrich/policy/{name}", "x-urls": [{ "path": "/_enrich/policy/{name}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "geo_match": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches enrich data to incoming documents based on a `geo_shape` query.", "x-found-in": "body" }, "match": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches enrich data to incoming documents based on a `term` query.", "x-found-in": "body" }, "range": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query.", "x-found-in": "body" }, "name": { "type": "string", "description": "Name of the enrich policy to create or update.", "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": ["name"] }

package/lib/es/json/enrich.stats.request.json

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

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.delete", "description": "Delete an async EQL search.\n\nDelete an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", "x-api": { "id": "eql.delete", "name": "delete", "namespace": "eql" }, "x-method": "DELETE", "x-path": "/_eql/search/{id}", "x-urls": [{ "path": "/_eql/search/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the search to delete.\nA search ID is provided in the EQL search API's response for an async search.\nA search ID is also provided if the request’s `keep_on_completion` parameter is `true`.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.delete", "description": "Delete an async EQL search.\n\nDelete an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", "x-api": { "id": "eql.delete", "name": "delete", "namespace": "eql" }, "x-method": "DELETE", "x-path": "/_eql/search/{id}", "x-urls": [{ "path": "/_eql/search/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the search to delete.\nA search ID is provided in the EQL search API's response for an async search.\nA search ID is also provided if the request’s `keep_on_completion` parameter is `true`.", "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"] }

package/lib/es/json/eql.get.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.get", "description": "Get async EQL search results.\n\nGet the current status and available results for an async EQL search or a stored synchronous EQL search.", "x-api": { "id": "eql.get", "name": "get", "namespace": "eql" }, "x-method": "GET", "x-path": "/_eql/search/{id}", "x-urls": [{ "path": "/_eql/search/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period for which the search and its results are stored on the cluster.\nDefaults to the keep_alive value set by the search’s EQL search API request.", "x-found-in": "query" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Timeout duration to wait for the request to finish.\nDefaults to no timeout, meaning the request waits for complete search results.", "x-found-in": "query" }, "id": { "type": "string", "description": "Identifier for the search.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.get", "description": "Get async EQL search results.\n\nGet the current status and available results for an async EQL search or a stored synchronous EQL search.", "x-api": { "id": "eql.get", "name": "get", "namespace": "eql" }, "x-method": "GET", "x-path": "/_eql/search/{id}", "x-urls": [{ "path": "/_eql/search/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period for which the search and its results are stored on the cluster.\nDefaults to the keep_alive value set by the search’s EQL search API request.", "x-found-in": "query" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Timeout duration to wait for the request to finish.\nDefaults to no timeout, meaning the request waits for complete search results.", "x-found-in": "query" }, "id": { "type": "string", "description": "Identifier for the search.", "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"] }

package/lib/es/json/eql.get_status.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.get_status", "description": "Get the async EQL status.\n\nGet the current status for an async EQL search or a stored synchronous EQL search without returning results.", "x-api": { "id": "eql.get_status", "name": "get-status", "namespace": "eql" }, "x-method": "GET", "x-path": "/_eql/search/status/{id}", "x-urls": [{ "path": "/_eql/search/status/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the search.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.get_status", "description": "Get the async EQL status.\n\nGet the current status for an async EQL search or a stored synchronous EQL search without returning results.", "x-api": { "id": "eql.get_status", "name": "get-status", "namespace": "eql" }, "x-method": "GET", "x-path": "/_eql/search/status/{id}", "x-urls": [{ "path": "/_eql/search/status/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the search.", "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"] }

package/lib/es/json/eql.search.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.search", "description": "Get EQL search results.\n\nReturns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", "x-api": { "id": "eql.search", "name": "search", "namespace": "eql" }, "x-method": "GET", "x-path": "/{index}/_eql/search", "x-urls": [{ "path": "/{index}/_eql/search", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.9.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" }, "allow_partial_search_results": { "type": "boolean", "description": "Allow query execution also in case of shard failures.\nIf true, the query will keep running and will return results based on the available shards.\nFor sequences, the behavior can be further refined using allow_partial_sequence_results", "x-found-in": "body" }, "allow_partial_sequence_results": { "type": "boolean", "description": "This flag applies only to sequences and has effect only if allow_partial_search_results=true.\nIf true, the sequence query will return results based on the available shards, ignoring the others.\nIf false, the sequence query will return successfully, but will always have empty results.", "x-found-in": "body" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", "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" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "keep_on_completion": { "type": "boolean", "x-found-in": "body" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "query": { "type": "string", "description": "EQL query you wish to run.", "x-found-in": "body" }, "case_sensitive": { "type": "boolean", "x-found-in": "body" }, "event_category_field": { "type": "string", "description": "Field containing the event classification, such as process, file, or network.", "x-found-in": "body" }, "tiebreaker_field": { "type": "string", "description": "Field used to sort hits with the same timestamp in ascending order", "x-found-in": "body" }, "timestamp_field": { "type": "string", "description": "Field containing event timestamp.", "x-found-in": "body" }, "fetch_size": { "type": "number", "description": "Maximum number of events to search at a time for sequence queries.", "x-found-in": "body" }, "filter": { "anyOf": [{ "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer" }, { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer" } }], "description": "Query, written in Query DSL, used to filter the events on which the EQL query runs.", "x-found-in": "body" }, "size": { "type": "number", "description": "For basic queries, the maximum number of matching events to return. Defaults to 10", "x-found-in": "body" }, "fields": { "anyOf": [{ "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" } }], "description": "Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit.", "x-found-in": "body" }, "result_position": { "$ref": "./eql.search.json#/$defs/eql.search__ResultPosition", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "x-found-in": "body", "x-availability": { "stack": { "since": "8.0.0" }, "serverless": {} } }, "max_samples_per_key": { "type": "number", "description": "By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size`\nparameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the\n`max_samples_per_key` parameter. Pipes are not supported for sample queries.", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of index names to scope the operation", "x-found-in": "path" } }, "required": ["index", "query"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.search", "description": "Get EQL search results.\n\nReturns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", "x-api": { "id": "eql.search", "name": "search", "namespace": "eql" }, "x-method": "GET", "x-path": "/{index}/_eql/search", "x-urls": [{ "path": "/{index}/_eql/search", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.9.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" }, "allow_partial_search_results": { "type": "boolean", "description": "Allow query execution also in case of shard failures.\nIf true, the query will keep running and will return results based on the available shards.\nFor sequences, the behavior can be further refined using allow_partial_sequence_results", "x-found-in": "body" }, "allow_partial_sequence_results": { "type": "boolean", "description": "This flag applies only to sequences and has effect only if allow_partial_search_results=true.\nIf true, the sequence query will return results based on the available shards, ignoring the others.\nIf false, the sequence query will return successfully, but will always have empty results.", "x-found-in": "body" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", "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" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "keep_on_completion": { "type": "boolean", "x-found-in": "body" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "query": { "type": "string", "description": "EQL query you wish to run.", "x-found-in": "body" }, "case_sensitive": { "type": "boolean", "x-found-in": "body" }, "event_category_field": { "type": "string", "description": "Field containing the event classification, such as process, file, or network.", "x-found-in": "body" }, "tiebreaker_field": { "type": "string", "description": "Field used to sort hits with the same timestamp in ascending order", "x-found-in": "body" }, "timestamp_field": { "type": "string", "description": "Field containing event timestamp.", "x-found-in": "body" }, "fetch_size": { "type": "number", "description": "Maximum number of events to search at a time for sequence queries.", "x-found-in": "body" }, "filter": { "anyOf": [{ "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer" }, { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer" } }], "description": "Query, written in Query DSL, used to filter the events on which the EQL query runs.", "x-found-in": "body" }, "size": { "type": "number", "description": "For basic queries, the maximum number of matching events to return. Defaults to 10", "x-found-in": "body" }, "fields": { "anyOf": [{ "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" } }], "description": "Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit.", "x-found-in": "body" }, "result_position": { "$ref": "./eql.search.json#/$defs/eql.search__ResultPosition", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "x-found-in": "body", "x-availability": { "stack": { "since": "8.0.0" }, "serverless": {} } }, "max_samples_per_key": { "type": "number", "description": "By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size`\nparameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the\n`max_samples_per_key` parameter. Pipes are not supported for sample queries.", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of index names to scope the operation", "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", "query"] }

package/lib/es/json/esql.async_query.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query", "description": "Run an async ES|QL query.\n\nAsynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available.\n\nThe API accepts the same parameters and request body as the synchronous query API, along with additional async related properties.", "x-api": { "id": "esql.async_query", "name": "async-query", "namespace": "esql" }, "x-method": "POST", "x-path": "/_query/async", "x-urls": [{ "path": "/_query/async", "methods": ["POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.13.0", "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_partial_results": { "type": "boolean", "description": "If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.\nIf `false`, the query will fail if there are any failures.\n\nTo override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`.", "x-found-in": "query" }, "delimiter": { "type": "string", "description": "The character to use between values within a CSV row.\nIt is valid only for the CSV format.", "x-found-in": "query" }, "drop_null_columns": { "type": "boolean", "description": "Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.\nIf `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.", "x-found-in": "query" }, "format": { "$ref": "./esql._types.json#/$defs/esql._types__EsqlFormat", "description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.\n\nFor async requests, nothing will be returned if the async query doesn't finish within the timeout.\nThe query ID and running status are available in the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively.", "x-found-in": "query" }, "columnar": { "type": "boolean", "description": "By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results.", "x-found-in": "body" }, "filter": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on.", "x-found-in": "body" }, "time_zone": { "type": "string", "description": "Sets the default timezone of the query.", "x-found-in": "body", "x-availability": { "stack": { "since": "9.4.0", "stability": "stable" }, "serverless": { "stability": "stable" } } }, "locale": { "type": "string", "description": "Returns results (especially dates) formatted per the conventions of the locale.", "x-found-in": "body" }, "params": { "$ref": "./esql._types.json#/$defs/esql._types__ESQLParams", "description": "To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.", "x-found-in": "body" }, "profile": { "type": "boolean", "description": "If provided and `true` the response will include an extra `profile` object\nwith information on how the query was executed. This information is for human debugging\nand its format can change at any time but it can give some insight into the performance\nof each part of the query.", "x-found-in": "body" }, "query": { "type": "string", "description": "The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results.", "x-found-in": "body" }, "tables": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "./esql._types.json#/$defs/esql._types__TableValuesContainer" } }, "description": "Tables to use with the LOOKUP operation. The top level key is the table\nname and the next level key is the column name.", "x-found-in": "body" }, "include_ccs_metadata": { "type": "boolean", "description": "When set to `true` and performing a cross-cluster/cross-project query, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.", "x-found-in": "body" }, "include_execution_metadata": { "type": "boolean", "description": "When set to `true`, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.\nThis is similar to `include_ccs_metadata`, but it also returns metadata when the query is not CCS/CPS", "x-found-in": "body" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the request to finish.\nBy default, the request waits for 1 second for the query results.\nIf the query completes during this period, results are returned\nOtherwise, a query ID is returned that can later be used to retrieve the results.", "x-found-in": "body" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period for which the query and its results are stored in the cluster.\nThe default period is five days.\nWhen this period expires, the query and its results are deleted, even if the query is still ongoing.\nIf the `keep_on_completion` parameter is false, Elasticsearch only stores async queries that do not complete within the period set by the `wait_for_completion_timeout` parameter, regardless of this value.", "x-found-in": "body" }, "keep_on_completion": { "type": "boolean", "description": "Indicates whether the query and its results are stored in the cluster.\nIf false, the query and its results are stored in the cluster only if the request does not complete during the period set by the `wait_for_completion_timeout` parameter.", "x-found-in": "body" }, "settings": { "$ref": "./esql._types.json#/$defs/esql._types__EsqlQuerySettings", "description": "Per-query settings, the request-body equivalent of the in-query `SET` command.\nFor example, `time_zone` can be supplied here instead of as a top-level field.", "x-found-in": "body", "x-availability": { "stack": { "since": "9.5.0", "stability": "stable" }, "serverless": { "stability": "stable" } } } }, "required": ["query"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query", "description": "Run an async ES|QL query.\n\nAsynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available.\n\nThe API accepts the same parameters and request body as the synchronous query API, along with additional async related properties.", "x-api": { "id": "esql.async_query", "name": "async-query", "namespace": "esql" }, "x-method": "POST", "x-path": "/_query/async", "x-urls": [{ "path": "/_query/async", "methods": ["POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.13.0", "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_partial_results": { "type": "boolean", "description": "If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.\nIf `false`, the query will fail if there are any failures.\n\nTo override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`.", "x-found-in": "query" }, "delimiter": { "type": "string", "description": "The character to use between values within a CSV row.\nIt is valid only for the CSV format.", "x-found-in": "query" }, "drop_null_columns": { "type": "boolean", "description": "Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.\nIf `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.", "x-found-in": "query" }, "format": { "$ref": "./esql._types.json#/$defs/esql._types__EsqlFormat", "description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.\n\nFor async requests, nothing will be returned if the async query doesn't finish within the timeout.\nThe query ID and running status are available in the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively.", "x-found-in": "query" }, "columnar": { "type": "boolean", "description": "By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results.", "x-found-in": "body" }, "filter": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on.", "x-found-in": "body" }, "time_zone": { "type": "string", "description": "Sets the default timezone of the query.", "x-found-in": "body", "x-availability": { "stack": { "since": "9.4.0", "stability": "stable" }, "serverless": { "stability": "stable" } } }, "locale": { "type": "string", "description": "Returns results (especially dates) formatted per the conventions of the locale.", "x-found-in": "body" }, "params": { "$ref": "./esql._types.json#/$defs/esql._types__ESQLParams", "description": "To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.", "x-found-in": "body" }, "profile": { "type": "boolean", "description": "If provided and `true` the response will include an extra `profile` object\nwith information on how the query was executed. This information is for human debugging\nand its format can change at any time but it can give some insight into the performance\nof each part of the query.", "x-found-in": "body" }, "query": { "type": "string", "description": "The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results.", "x-found-in": "body" }, "tables": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "./esql._types.json#/$defs/esql._types__TableValuesContainer" } }, "description": "Tables to use with the LOOKUP operation. The top level key is the table\nname and the next level key is the column name.", "x-found-in": "body" }, "include_ccs_metadata": { "type": "boolean", "description": "When set to `true` and performing a cross-cluster/cross-project query, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.", "x-found-in": "body" }, "include_execution_metadata": { "type": "boolean", "description": "When set to `true`, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.\nThis is similar to `include_ccs_metadata`, but it also returns metadata when the query is not CCS/CPS", "x-found-in": "body" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the request to finish.\nBy default, the request waits for 1 second for the query results.\nIf the query completes during this period, results are returned\nOtherwise, a query ID is returned that can later be used to retrieve the results.", "x-found-in": "body" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period for which the query and its results are stored in the cluster.\nThe default period is five days.\nWhen this period expires, the query and its results are deleted, even if the query is still ongoing.\nIf the `keep_on_completion` parameter is false, Elasticsearch only stores async queries that do not complete within the period set by the `wait_for_completion_timeout` parameter, regardless of this value.", "x-found-in": "body" }, "keep_on_completion": { "type": "boolean", "description": "Indicates whether the query and its results are stored in the cluster.\nIf false, the query and its results are stored in the cluster only if the request does not complete during the period set by the `wait_for_completion_timeout` parameter.", "x-found-in": "body" }, "settings": { "$ref": "./esql._types.json#/$defs/esql._types__EsqlQuerySettings", "description": "Per-query settings, the request-body equivalent of the in-query `SET` command.\nFor example, `time_zone` can be supplied here instead of as a top-level field.", "x-found-in": "body", "x-availability": { "stack": { "since": "9.5.0", "stability": "stable" }, "serverless": { "stability": "stable" } } }, "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": ["query"] }

package/lib/es/json/esql.async_query_delete.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query_delete", "description": "Delete an async ES|QL query.\n\nIf the query is still running, it is cancelled.\nOtherwise, the stored results are deleted.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a query:\n\n* The authenticated user that submitted the original query request\n* Users with the `cancel_task` cluster privilege", "x-api": { "id": "esql.async_query_delete", "name": "async-query-delete", "namespace": "esql" }, "x-method": "DELETE", "x-path": "/_query/async/{id}", "x-urls": [{ "path": "/_query/async/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.13.0", "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the query.\nA query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.\nA query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query_delete", "description": "Delete an async ES|QL query.\n\nIf the query is still running, it is cancelled.\nOtherwise, the stored results are deleted.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a query:\n\n* The authenticated user that submitted the original query request\n* Users with the `cancel_task` cluster privilege", "x-api": { "id": "esql.async_query_delete", "name": "async-query-delete", "namespace": "esql" }, "x-method": "DELETE", "x-path": "/_query/async/{id}", "x-urls": [{ "path": "/_query/async/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.13.0", "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the query.\nA query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.\nA query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`.", "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"] }

package/lib/es/json/esql.async_query_get.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query_get", "description": "Get async ES|QL query results.\n\nGet the current status and available results or stored results for an ES|QL asynchronous query.\nIf the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API.", "x-api": { "id": "esql.async_query_get", "name": "async-query-get", "namespace": "esql" }, "x-method": "GET", "x-path": "/_query/async/{id}", "x-urls": [{ "path": "/_query/async/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.13.0", "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "drop_null_columns": { "type": "boolean", "description": "Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.\nIf `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.", "x-found-in": "query" }, "format": { "$ref": "./esql._types.json#/$defs/esql._types__EsqlFormat", "description": "A short version of the Accept header, for example `json` or `yaml`.", "x-found-in": "query" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period for which the query and its results are stored in the cluster.\nWhen this period expires, the query and its results are deleted, even if the query is still ongoing.", "x-found-in": "query" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the request to finish.\nBy default, the request waits for complete query results.\nIf the request completes during the period specified in this parameter, complete query results are returned.\nOtherwise, the response returns an `is_running` value of `true` and no results.", "x-found-in": "query" }, "id": { "type": "string", "description": "The unique identifier of the query.\nA query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.\nA query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query_get", "description": "Get async ES|QL query results.\n\nGet the current status and available results or stored results for an ES|QL asynchronous query.\nIf the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API.", "x-api": { "id": "esql.async_query_get", "name": "async-query-get", "namespace": "esql" }, "x-method": "GET", "x-path": "/_query/async/{id}", "x-urls": [{ "path": "/_query/async/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.13.0", "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "drop_null_columns": { "type": "boolean", "description": "Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.\nIf `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.", "x-found-in": "query" }, "format": { "$ref": "./esql._types.json#/$defs/esql._types__EsqlFormat", "description": "A short version of the Accept header, for example `json` or `yaml`.", "x-found-in": "query" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period for which the query and its results are stored in the cluster.\nWhen this period expires, the query and its results are deleted, even if the query is still ongoing.", "x-found-in": "query" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the request to finish.\nBy default, the request waits for complete query results.\nIf the request completes during the period specified in this parameter, complete query results are returned.\nOtherwise, the response returns an `is_running` value of `true` and no results.", "x-found-in": "query" }, "id": { "type": "string", "description": "The unique identifier of the query.\nA query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.\nA query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`.", "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"] }

package/lib/es/json/esql.async_query_stop.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query_stop", "description": "Stop async ES|QL query.\n\nThis API interrupts the query execution and returns the results so far.\nIf the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it.", "x-api": { "id": "esql.async_query_stop", "name": "async-query-stop", "namespace": "esql" }, "x-method": "POST", "x-path": "/_query/async/{id}/stop", "x-urls": [{ "path": "/_query/async/{id}/stop", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.18.0", "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "drop_null_columns": { "type": "boolean", "description": "Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.\nIf `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.", "x-found-in": "query" }, "id": { "type": "string", "description": "The unique identifier of the query.\nA query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.\nA query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query_stop", "description": "Stop async ES|QL query.\n\nThis API interrupts the query execution and returns the results so far.\nIf the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it.", "x-api": { "id": "esql.async_query_stop", "name": "async-query-stop", "namespace": "esql" }, "x-method": "POST", "x-path": "/_query/async/{id}/stop", "x-urls": [{ "path": "/_query/async/{id}/stop", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.18.0", "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "drop_null_columns": { "type": "boolean", "description": "Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.\nIf `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.", "x-found-in": "query" }, "id": { "type": "string", "description": "The unique identifier of the query.\nA query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.\nA query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`.", "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"] }

package/lib/es/json/esql.delete_view.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.delete_view", "description": "Delete an ES|QL view.\n\nDeletes a stored ES|QL view.", "x-api": { "id": "esql.delete_view", "name": "delete-view", "namespace": "esql" }, "x-method": "DELETE", "x-path": "/_query/view/{name}", "x-urls": [{ "path": "/_query/view/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "9.4.0", "stability": "experimental", "visibility": "public" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "type": "object", "properties": { "name": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "The view name to remove.", "x-found-in": "path" } }, "required": ["name"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.delete_view", "description": "Delete an ES|QL view.\n\nDeletes a stored ES|QL view.", "x-api": { "id": "esql.delete_view", "name": "delete-view", "namespace": "esql" }, "x-method": "DELETE", "x-path": "/_query/view/{name}", "x-urls": [{ "path": "/_query/view/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "9.4.0", "stability": "experimental", "visibility": "public" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "type": "object", "properties": { "name": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "The view name to remove.", "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": ["name"] }

package/lib/es/json/esql.get_query.request.json

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

package/lib/es/json/esql.get_view.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.get_view", "description": "Get an ES|QL view.\n\nReturns a stored ES|QL view.", "x-api": { "id": "esql.get_view", "name": "get-view", "namespace": "esql" }, "x-method": "GET", "x-path": "/_query/view/{name}", "x-urls": [{ "path": "/_query/view", "methods": ["GET"] }, { "path": "/_query/view/{name}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.4.0", "stability": "experimental", "visibility": "public" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "type": "object", "properties": { "name": { "type": "string", "description": "The comma-separated view names to retrieve.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.get_view", "description": "Get an ES|QL view.\n\nReturns a stored ES|QL view.", "x-api": { "id": "esql.get_view", "name": "get-view", "namespace": "esql" }, "x-method": "GET", "x-path": "/_query/view/{name}", "x-urls": [{ "path": "/_query/view", "methods": ["GET"] }, { "path": "/_query/view/{name}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.4.0", "stability": "experimental", "visibility": "public" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "type": "object", "properties": { "name": { "type": "string", "description": "The comma-separated view names to retrieve.", "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/esql.list_queries.request.json

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

package/lib/es/json/esql.put_view.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.put_view", "description": "Create or update an ES|QL view.", "x-api": { "id": "esql.put_view", "name": "put-view", "namespace": "esql" }, "x-method": "PUT", "x-path": "/_query/view/{name}", "x-urls": [{ "path": "/_query/view/{name}", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "9.4.0", "stability": "experimental", "visibility": "public" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "type": "object", "properties": { "query": { "type": "string", "description": "The ES|QL query string from which to create a view.", "x-found-in": "body" }, "name": { "type": "string", "description": "The view name to create or update.", "x-found-in": "path" } }, "required": ["name", "query"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.put_view", "description": "Create or update an ES|QL view.", "x-api": { "id": "esql.put_view", "name": "put-view", "namespace": "esql" }, "x-method": "PUT", "x-path": "/_query/view/{name}", "x-urls": [{ "path": "/_query/view/{name}", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "9.4.0", "stability": "experimental", "visibility": "public" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "type": "object", "properties": { "query": { "type": "string", "description": "The ES|QL query string from which to create a view.", "x-found-in": "body" }, "description": { "type": "string", "description": "A free-text description of the view.", "x-found-in": "body" }, "name": { "type": "string", "description": "The view name to create or update.", "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": ["name", "query"] }

package/lib/es/json/esql.query.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.query", "description": "Run an ES|QL query.\n\nGet search results for an ES|QL (Elasticsearch query language) query.", "x-api": { "id": "esql.query", "name": "query", "namespace": "esql" }, "x-method": "POST", "x-path": "/_query", "x-urls": [{ "path": "/_query", "methods": ["POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.11.0" }, "serverless": {} }, "type": "object", "properties": { "format": { "$ref": "./esql._types.json#/$defs/esql._types__EsqlFormat", "description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.", "x-found-in": "query" }, "delimiter": { "type": "string", "description": "The character to use between values within a CSV row. Only valid for the CSV format.", "x-found-in": "query" }, "drop_null_columns": { "type": "boolean", "description": "Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?\nDefaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns.", "x-found-in": "query" }, "allow_partial_results": { "type": "boolean", "description": "If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.\nIf `false`, the query will fail if there are any failures.\n\nTo override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`.", "x-found-in": "query" }, "columnar": { "type": "boolean", "description": "By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results.", "x-found-in": "body" }, "filter": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on.", "x-found-in": "body" }, "time_zone": { "type": "string", "description": "Sets the default timezone of the query.", "x-found-in": "body", "x-availability": { "stack": { "since": "9.4.0", "stability": "stable" }, "serverless": { "stability": "stable" } } }, "locale": { "type": "string", "description": "Returns results (especially dates) formatted per the conventions of the locale.", "x-found-in": "body" }, "params": { "$ref": "./esql._types.json#/$defs/esql._types__ESQLParams", "description": "To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.", "x-found-in": "body" }, "profile": { "type": "boolean", "description": "If provided and `true` the response will include an extra `profile` object\nwith information on how the query was executed. This information is for human debugging\nand its format can change at any time but it can give some insight into the performance\nof each part of the query.", "x-found-in": "body" }, "query": { "type": "string", "description": "The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results.", "x-found-in": "body" }, "tables": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "./esql._types.json#/$defs/esql._types__TableValuesContainer" } }, "description": "Tables to use with the LOOKUP operation. The top level key is the table\nname and the next level key is the column name.", "x-found-in": "body" }, "include_ccs_metadata": { "type": "boolean", "description": "When set to `true` and performing a cross-cluster/cross-project query, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.", "x-found-in": "body" }, "include_execution_metadata": { "type": "boolean", "description": "When set to `true`, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.\nThis is similar to `include_ccs_metadata`, but it also returns metadata when the query is not CCS/CPS", "x-found-in": "body" }, "settings": { "$ref": "./esql._types.json#/$defs/esql._types__EsqlQuerySettings", "description": "Per-query settings, the request-body equivalent of the in-query `SET` command.\nFor example, `time_zone` can be supplied here instead of as a top-level field.", "x-found-in": "body", "x-availability": { "stack": { "since": "9.5.0", "stability": "stable" }, "serverless": { "stability": "stable" } } } }, "required": ["query"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.query", "description": "Run an ES|QL query.\n\nGet search results for an ES|QL (Elasticsearch query language) query.", "x-api": { "id": "esql.query", "name": "query", "namespace": "esql" }, "x-method": "POST", "x-path": "/_query", "x-urls": [{ "path": "/_query", "methods": ["POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.11.0" }, "serverless": {} }, "type": "object", "properties": { "format": { "$ref": "./esql._types.json#/$defs/esql._types__EsqlFormat", "description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.", "x-found-in": "query" }, "delimiter": { "type": "string", "description": "The character to use between values within a CSV row. Only valid for the CSV format.", "x-found-in": "query" }, "drop_null_columns": { "type": "boolean", "description": "Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?\nDefaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns.", "x-found-in": "query" }, "allow_partial_results": { "type": "boolean", "description": "If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.\nIf `false`, the query will fail if there are any failures.\n\nTo override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`.", "x-found-in": "query" }, "columnar": { "type": "boolean", "description": "By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results.", "x-found-in": "body" }, "filter": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on.", "x-found-in": "body" }, "time_zone": { "type": "string", "description": "Sets the default timezone of the query.", "x-found-in": "body", "x-availability": { "stack": { "since": "9.4.0", "stability": "stable" }, "serverless": { "stability": "stable" } } }, "locale": { "type": "string", "description": "Returns results (especially dates) formatted per the conventions of the locale.", "x-found-in": "body" }, "params": { "$ref": "./esql._types.json#/$defs/esql._types__ESQLParams", "description": "To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.", "x-found-in": "body" }, "profile": { "type": "boolean", "description": "If provided and `true` the response will include an extra `profile` object\nwith information on how the query was executed. This information is for human debugging\nand its format can change at any time but it can give some insight into the performance\nof each part of the query.", "x-found-in": "body" }, "query": { "type": "string", "description": "The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results.", "x-found-in": "body" }, "tables": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "./esql._types.json#/$defs/esql._types__TableValuesContainer" } }, "description": "Tables to use with the LOOKUP operation. The top level key is the table\nname and the next level key is the column name.", "x-found-in": "body" }, "include_ccs_metadata": { "type": "boolean", "description": "When set to `true` and performing a cross-cluster/cross-project query, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.", "x-found-in": "body" }, "include_execution_metadata": { "type": "boolean", "description": "When set to `true`, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.\nThis is similar to `include_ccs_metadata`, but it also returns metadata when the query is not CCS/CPS", "x-found-in": "body" }, "settings": { "$ref": "./esql._types.json#/$defs/esql._types__EsqlQuerySettings", "description": "Per-query settings, the request-body equivalent of the in-query `SET` command.\nFor example, `time_zone` can be supplied here instead of as a top-level field.", "x-found-in": "body", "x-availability": { "stack": { "since": "9.5.0", "stability": "stable" }, "serverless": { "stability": "stable" } } }, "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": ["query"] }