@elastic/schemas 0.4.3 → 0.4.4

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete_by_query", "type": "object", "properties": { "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" }, "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" }, "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" } }, "required": ["index"], "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete_by_query", "type": "object", "properties": { "max_docs": { "type": "number", "description": "The maximum number of documents to process.\nDefaults to all documents.\nWhen set to a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation.", "x-found-in": "query" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "The documents to 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" }, "sort": { "type": "array", "items": { "type": "string" }, "description": "A comma-separated list of `<field>:<direction>` pairs.", "x-found-in": "query" }, "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "analyzer": { "type": "string", "description": "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" }, "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" }, "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" }, "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" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "required": ["index"], "description": "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." }

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", "type": "object", "properties": { "task_id": { "type": "string", "description": "The ID for the task.", "x-found-in": "path" }, "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" } }, "required": ["task_id", "requests_per_second"], "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete_by_query_rethrottle", "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"], "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." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete_script", "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the stored script or search template.", "x-found-in": "path" }, "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" } }, "required": ["id"], "description": "Delete a script or search template.\n\nDeletes a stored script or search template." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete_script", "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"], "description": "Delete a script or search template.\n\nDeletes a stored script or search template." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.delete_policy", "type": "object", "properties": { "name": { "type": "string", "description": "Enrich policy to delete.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" } }, "required": ["name"], "description": "Delete an enrich policy.\n\nDeletes an existing enrich policy and its enrich index." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.delete_policy", "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"], "description": "Delete an enrich policy.\n\nDeletes an existing enrich policy and its enrich index." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.execute_policy", "type": "object", "properties": { "name": { "type": "string", "description": "Enrich policy to execute.", "x-found-in": "path" }, "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" } }, "required": ["name"], "description": "Run an enrich policy.\n\nCreate the enrich index for an existing enrich policy." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.execute_policy", "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"], "description": "Run an enrich policy.\n\nCreate the enrich index for an existing enrich policy." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.get_policy", "type": "object", "properties": { "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" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" } }, "description": "Get an enrich policy.\n\nReturns information about an enrich policy." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.get_policy", "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" } }, "description": "Get an enrich policy.\n\nReturns information about an enrich policy." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.put_policy", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the enrich policy to create or update.", "x-found-in": "path" }, "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" } }, "required": ["name"], "description": "Create an enrich policy.\n\nCreates an enrich policy." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.put_policy", "type": "object", "properties": { "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" }, "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": "Name of the enrich policy to create or update.", "x-found-in": "path" } }, "required": ["name"], "description": "Create an enrich policy.\n\nCreates an enrich policy." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.get", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the search.", "x-found-in": "path" }, "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" } }, "required": ["id"], "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.get", "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"], "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." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.search", "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of index names to scope the operation", "x-found-in": "path" }, "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": { "oneOf": [{ "$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": { "oneOf": [{ "$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" }, "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" } }, "required": ["index", "query"], "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.search", "type": "object", "properties": { "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": { "oneOf": [{ "$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" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period for which the search and its results are stored on the cluster.", "x-found-in": "query" }, "keep_on_completion": { "type": "boolean", "description": "If true, the search and its results are stored on the cluster.", "x-found-in": "query" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.", "x-found-in": "query" }, "allow_partial_search_results": { "type": "boolean", "description": "If true, returns partial results if there are shard failures. If false, returns an error with no partial results.", "x-found-in": "query" }, "allow_partial_sequence_results": { "type": "boolean", "description": "If true, sequence queries will return partial results in case of shard failures. If false, they will return no results at all.\nThis flag has effect only if allow_partial_search_results is true.", "x-found-in": "query" }, "size": { "type": "number", "description": "For basic queries, the maximum number of matching events to return. Defaults to 10", "x-found-in": "body" }, "fields": { "oneOf": [{ "$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" }, "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" }, "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "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" }, "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"], "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." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query", "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" }, "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" } }, "required": ["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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query", "type": "object", "properties": { "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" }, "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" }, "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" } }, "required": ["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." }

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", "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" }, "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" } }, "required": ["id"], "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query_get", "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"], "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." }

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", "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" }, "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" } }, "required": ["id"], "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query_stop", "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"], "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." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.put_view", "type": "object", "properties": { "name": { "type": "string", "description": "The view name to create or update.", "x-found-in": "path" }, "query": { "type": "string", "description": "The ES|QL query string from which to create a view.", "x-found-in": "body" } }, "required": ["name", "query"], "description": "Create or update an ES|QL view." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.put_view", "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"], "description": "Create or update an ES|QL view." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.query", "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" }, "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" } }, "required": ["query"], "description": "Run an ES|QL query.\n\nGet search results for an ES|QL (Elasticsearch query language) query." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.query", "type": "object", "properties": { "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" }, "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" }, "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" } }, "required": ["query"], "description": "Run an ES|QL query.\n\nGet search results for an ES|QL (Elasticsearch query language) query." }

package/lib/es/json/exists.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "exists", "type": "object", "properties": { "id": { "type": "string", "description": "A unique document identifier.", "x-found-in": "path" }, "index": { "type": "string", "description": "A comma-separated list of data streams, indices, and aliases.\nIt supports wildcards (`*`).", "x-found-in": "path" }, "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nBy default, the operation is randomized between the shard replicas.\n\nIf it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible.\nIf it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value.\nThis can help with \"jumping values\" when hitting different shards in different refresh states.\nA sample value can be something like the web session ID or the user name.", "x-found-in": "query" }, "realtime": { "type": "boolean", "description": "If `true`, the request is real-time as opposed to near-real-time.", "x-found-in": "query" }, "refresh": { "type": "boolean", "description": "If `true`, the request refreshes the relevant shards before retrieving the document.\nSetting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value used to route operations to a specific shard.", "x-found-in": "query" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "stored_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to `false`.", "x-found-in": "query" }, "version": { "type": "number", "description": "Explicit version number for concurrency control.\nThe specified version 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" } }, "required": ["id", "index"], "description": "Check a document.\n\nVerify that a document exists.\nFor example, check to see if a document with the `_id` 0 exists:\n\n```\nHEAD my-index-000001/_doc/0\n```\n\nIf the document exists, the API returns a status code of `200 - OK`.\nIf the document doesn’t exist, the API returns `404 - Not Found`.\n\n**Versioning support**\n\nYou can use the `version` parameter to check the document only if its current version is equal to the specified one.\n\nInternally, Elasticsearch has marked the old document as deleted and added an entirely new document.\nThe old version of the document doesn't disappear immediately, although you won't be able to access it.\nElasticsearch cleans up deleted documents in the background as you continue to index more data." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "exists", "type": "object", "properties": { "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nBy default, the operation is randomized between the shard replicas.\n\nIf it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible.\nIf it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value.\nThis can help with \"jumping values\" when hitting different shards in different refresh states.\nA sample value can be something like the web session ID or the user name.", "x-found-in": "query" }, "realtime": { "type": "boolean", "description": "If `true`, the request is real-time as opposed to near-real-time.", "x-found-in": "query" }, "refresh": { "type": "boolean", "description": "If `true`, the request refreshes the relevant shards before retrieving the document.\nSetting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value used to route operations to a specific shard.", "x-found-in": "query" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "stored_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to `false`.", "x-found-in": "query" }, "version": { "type": "number", "description": "Explicit version number for concurrency control.\nThe specified version 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" }, "id": { "type": "string", "description": "A unique document identifier.", "x-found-in": "path" }, "index": { "type": "string", "description": "A comma-separated list of data streams, indices, and aliases.\nIt supports wildcards (`*`).", "x-found-in": "path" } }, "required": ["id", "index"], "description": "Check a document.\n\nVerify that a document exists.\nFor example, check to see if a document with the `_id` 0 exists:\n\n```\nHEAD my-index-000001/_doc/0\n```\n\nIf the document exists, the API returns a status code of `200 - OK`.\nIf the document doesn’t exist, the API returns `404 - Not Found`.\n\n**Versioning support**\n\nYou can use the `version` parameter to check the document only if its current version is equal to the specified one.\n\nInternally, Elasticsearch has marked the old document as deleted and added an entirely new document.\nThe old version of the document doesn't disappear immediately, although you won't be able to access it.\nElasticsearch cleans up deleted documents in the background as you continue to index more data." }

package/lib/es/json/exists_source.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "exists_source", "type": "object", "properties": { "id": { "type": "string", "description": "A unique identifier for the document.", "x-found-in": "path" }, "index": { "type": "string", "description": "A comma-separated list of data streams, indices, and aliases.\nIt supports wildcards (`*`).", "x-found-in": "path" }, "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nBy default, the operation is randomized between the shard replicas.", "x-found-in": "query" }, "realtime": { "type": "boolean", "description": "If `true`, the request is real-time as opposed to near-real-time.", "x-found-in": "query" }, "refresh": { "type": "boolean", "description": "If `true`, the request refreshes the relevant shards before retrieving the document.\nSetting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value used to route operations to a specific shard.", "x-found-in": "query" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to exclude in the response.", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to include in the response.", "x-found-in": "query" }, "version": { "type": "number", "description": "The 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" } }, "required": ["id", "index"], "description": "Check for a document source.\n\nCheck whether a document source exists in an index.\nFor example:\n\n```\nHEAD my-index-000001/_source/1\n```\n\nA document's source is not available if it is disabled in the mapping." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "exists_source", "type": "object", "properties": { "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nBy default, the operation is randomized between the shard replicas.", "x-found-in": "query" }, "realtime": { "type": "boolean", "description": "If `true`, the request is real-time as opposed to near-real-time.", "x-found-in": "query" }, "refresh": { "type": "boolean", "description": "If `true`, the request refreshes the relevant shards before retrieving the document.\nSetting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value used to route operations to a specific shard.", "x-found-in": "query" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to exclude in the response.", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to include in the response.", "x-found-in": "query" }, "version": { "type": "number", "description": "The 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" }, "id": { "type": "string", "description": "A unique identifier for the document.", "x-found-in": "path" }, "index": { "type": "string", "description": "A comma-separated list of data streams, indices, and aliases.\nIt supports wildcards (`*`).", "x-found-in": "path" } }, "required": ["id", "index"], "description": "Check for a document source.\n\nCheck whether a document source exists in an index.\nFor example:\n\n```\nHEAD my-index-000001/_source/1\n```\n\nA document's source is not available if it is disabled in the mapping." }

package/lib/es/json/explain.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "explain", "type": "object", "properties": { "id": { "type": "string", "description": "The document identifier.", "x-found-in": "path" }, "index": { "type": "string", "description": "Index names that are used to limit the request.\nOnly a single index name can be provided to this parameter.", "x-found-in": "path" }, "analyzer": { "type": "string", "description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "analyze_wildcard": { "type": "boolean", "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "default_operator": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__Operator", "description": "The default operator for query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "df": { "type": "string", "description": "The field to use as default where no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "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" }, "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nIt is random by default.", "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" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "`True` or `false` to return the `_source` field or not or a list of fields to return.", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "stored_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of stored fields to return in the response.", "x-found-in": "query" }, "q": { "type": "string", "description": "The query in the Lucene query string syntax.", "x-found-in": "query" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Defines the search definition using the Query DSL.", "x-found-in": "body" } }, "required": ["id", "index"], "description": "Explain a document match result.\n\nGet information about why a specific document matches, or doesn't match, a query.\nIt computes a score explanation for a query and a specific document." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "explain", "type": "object", "properties": { "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Defines the search definition using the Query DSL.", "x-found-in": "body" }, "analyzer": { "type": "string", "description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "analyze_wildcard": { "type": "boolean", "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "default_operator": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__Operator", "description": "The default operator for query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "df": { "type": "string", "description": "The field to use as default where no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "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" }, "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nIt is random by default.", "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" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "`True` or `false` to return the `_source` field or not or a list of fields to return.", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "stored_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of stored fields to return in the response.", "x-found-in": "query" }, "q": { "type": "string", "description": "The query in the Lucene query string syntax.", "x-found-in": "query" }, "id": { "type": "string", "description": "The document identifier.", "x-found-in": "path" }, "index": { "type": "string", "description": "Index names that are used to limit the request.\nOnly a single index name can be provided to this parameter.", "x-found-in": "path" } }, "required": ["id", "index"], "description": "Explain a document match result.\n\nGet information about why a specific document matches, or doesn't match, a query.\nIt computes a score explanation for a query and a specific document." }

package/lib/es/json/field_caps.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "field_caps", "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.", "x-found-in": "path" }, "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.", "x-found-in": "body" }, "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" }, "include_unmapped": { "type": "boolean", "description": "If true, unmapped fields are included in the response.", "x-found-in": "query" }, "filters": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A comma-separated list of filters to apply to the response.", "x-found-in": "query" }, "types": { "type": "array", "items": { "type": "string" }, "description": "A comma-separated list of field types to include.\nAny fields that do not match one of these types will be excluded from the results.\nIt defaults to empty, meaning that all field types are returned.", "x-found-in": "query" }, "include_empty_fields": { "type": "boolean", "description": "If false, empty fields are not included in the response.", "x-found-in": "query" }, "index_filter": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Filter indices if the provided query rewrites to `match_none` on every shard.\n\nIMPORTANT: The filtering is done on a best-effort basis, it uses index statistics and mappings to rewrite queries to `match_none` instead of fully running the request.\nFor instance a range query over a date field can rewrite to `match_none` if all documents within a shard (including deleted documents) are outside of the provided range.\nHowever, not all queries can rewrite to `match_none` so this API may return an index even if the provided filter matches no document.", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "description": "Define ad-hoc runtime fields in the request similar to the way it is done in search requests.\nThese fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.", "x-found-in": "body" } }, "description": "Get the field capabilities.\n\nGet information about the capabilities of fields among multiple indices.\n\nFor data streams, the API returns field capabilities among the stream’s backing indices.\nIt returns runtime fields like any other field.\nFor example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "field_caps", "type": "object", "properties": { "fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.", "x-found-in": "query" }, "index_filter": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Filter indices if the provided query rewrites to `match_none` on every shard.\n\nIMPORTANT: The filtering is done on a best-effort basis, it uses index statistics and mappings to rewrite queries to `match_none` instead of fully running the request.\nFor instance a range query over a date field can rewrite to `match_none` if all documents within a shard (including deleted documents) are outside of the provided range.\nHowever, not all queries can rewrite to `match_none` so this API may return an index even if the provided filter matches no document.", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "description": "Define ad-hoc runtime fields in the request similar to the way it is done in search requests.\nThese fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.", "x-found-in": "body" }, "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "include_unmapped": { "type": "boolean", "description": "If true, unmapped fields are included in the response.", "x-found-in": "query" }, "filters": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A comma-separated list of filters to apply to the response.", "x-found-in": "query" }, "types": { "type": "array", "items": { "type": "string" }, "description": "A comma-separated list of field types to include.\nAny fields that do not match one of these types will be excluded from the results.\nIt defaults to empty, meaning that all field types are returned.", "x-found-in": "query" }, "include_empty_fields": { "type": "boolean", "description": "If false, empty fields are not included in the response.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.", "x-found-in": "path" } }, "description": "Get the field capabilities.\n\nGet information about the capabilities of fields among multiple indices.\n\nFor data streams, the API returns field capabilities among the stream’s backing indices.\nIt returns runtime fields like any other field.\nFor example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family." }

package/lib/es/json/fleet.global_checkpoints.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "fleet.global_checkpoints", "type": "object", "properties": { "index": { "oneOf": [{ "type": "string" }, { "type": "string" }], "description": "A single index or index alias that resolves to a single index.", "x-found-in": "path" }, "wait_for_advance": { "type": "boolean", "description": "A boolean value which controls whether to wait (until the timeout) for the global checkpoints\nto advance past the provided `checkpoints`.", "x-found-in": "query" }, "wait_for_index": { "type": "boolean", "description": "A boolean value which controls whether to wait (until the timeout) for the target index to exist\nand all primary shards be active. Can only be true when `wait_for_advance` is true.", "x-found-in": "query" }, "checkpoints": { "type": "array", "items": { "type": "number" }, "description": "A comma separated list of previous global checkpoints. When used in combination with `wait_for_advance`,\nthe API will only return once the global checkpoints advances past the checkpoints. Providing an empty list\nwill cause Elasticsearch to immediately return the current global checkpoints.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a global checkpoints to advance past `checkpoints`.", "x-found-in": "query" } }, "required": ["index"], "description": "Get global checkpoints.\n\nGet the current global checkpoints for an index.\nThis API is designed for internal use by the Fleet server project." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "fleet.global_checkpoints", "type": "object", "properties": { "wait_for_advance": { "type": "boolean", "description": "A boolean value which controls whether to wait (until the timeout) for the global checkpoints\nto advance past the provided `checkpoints`.", "x-found-in": "query" }, "wait_for_index": { "type": "boolean", "description": "A boolean value which controls whether to wait (until the timeout) for the target index to exist\nand all primary shards be active. Can only be true when `wait_for_advance` is true.", "x-found-in": "query" }, "checkpoints": { "type": "array", "items": { "type": "number" }, "description": "A comma separated list of previous global checkpoints. When used in combination with `wait_for_advance`,\nthe API will only return once the global checkpoints advances past the checkpoints. Providing an empty list\nwill cause Elasticsearch to immediately return the current global checkpoints.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a global checkpoints to advance past `checkpoints`.", "x-found-in": "query" }, "index": { "oneOf": [{ "type": "string" }, { "type": "string" }], "description": "A single index or index alias that resolves to a single index.", "x-found-in": "path" } }, "required": ["index"], "description": "Get global checkpoints.\n\nGet the current global checkpoints for an index.\nThis API is designed for internal use by the Fleet server project." }

package/lib/es/json/fleet.msearch.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "fleet.msearch", "type": "object", "properties": { "index": { "oneOf": [{ "type": "string" }, { "type": "string" }], "description": "A single target to search. If the target is an index alias, it must resolve to a single index.", "x-found-in": "path" }, "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" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.", "x-found-in": "query" }, "ignore_throttled": { "type": "boolean", "description": "If true, concrete, expanded or aliased indices are ignored when frozen.", "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" }, "max_concurrent_searches": { "type": "number", "description": "Maximum number of concurrent searches the multi search API can execute.", "x-found-in": "query" }, "max_concurrent_shard_requests": { "type": "number", "description": "Maximum number of concurrent shard requests that each sub-search request executes per node.", "x-found-in": "query" }, "pre_filter_shard_size": { "type": "number", "description": "Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.", "x-found-in": "query" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "description": "Indicates whether global term and document frequencies should be used when scoring returned documents.", "x-found-in": "query" }, "rest_total_hits_as_int": { "type": "boolean", "description": "If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.", "x-found-in": "query" }, "typed_keys": { "type": "boolean", "description": "Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.", "x-found-in": "query" }, "wait_for_checkpoints": { "type": "array", "items": { "type": "number" }, "description": "A comma separated list of checkpoints. When configured, the search API will only be executed on a shard\nafter the relevant checkpoint has become visible for search. Defaults to an empty list which will cause\nElasticsearch to immediately execute the search.", "x-found-in": "query" }, "allow_partial_search_results": { "type": "boolean", "description": "If true, returns partial results if there are shard request timeouts or shard failures.\nIf false, returns an error with no partial results.\nDefaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default.", "x-found-in": "query" } }, "description": "Run multiple Fleet searches.\n\nRun several Fleet searches with a single API request.\nThe API follows the same structure as the multi search API.\nHowever, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "fleet.msearch", "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" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.", "x-found-in": "query" }, "ignore_throttled": { "type": "boolean", "description": "If true, concrete, expanded or aliased indices are ignored when frozen.", "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" }, "max_concurrent_searches": { "type": "number", "description": "Maximum number of concurrent searches the multi search API can execute.", "x-found-in": "query" }, "max_concurrent_shard_requests": { "type": "number", "description": "Maximum number of concurrent shard requests that each sub-search request executes per node.", "x-found-in": "query" }, "pre_filter_shard_size": { "type": "number", "description": "Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.", "x-found-in": "query" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "description": "Indicates whether global term and document frequencies should be used when scoring returned documents.", "x-found-in": "query" }, "rest_total_hits_as_int": { "type": "boolean", "description": "If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.", "x-found-in": "query" }, "typed_keys": { "type": "boolean", "description": "Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.", "x-found-in": "query" }, "wait_for_checkpoints": { "type": "array", "items": { "type": "number" }, "description": "A comma separated list of checkpoints. When configured, the search API will only be executed on a shard\nafter the relevant checkpoint has become visible for search. Defaults to an empty list which will cause\nElasticsearch to immediately execute the search.", "x-found-in": "query" }, "allow_partial_search_results": { "type": "boolean", "description": "If true, returns partial results if there are shard request timeouts or shard failures.\nIf false, returns an error with no partial results.\nDefaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default.", "x-found-in": "query" }, "index": { "oneOf": [{ "type": "string" }, { "type": "string" }], "description": "A single target to search. If the target is an index alias, it must resolve to a single index.", "x-found-in": "path" } }, "description": "Run multiple Fleet searches.\n\nRun several Fleet searches with a single API request.\nThe API follows the same structure as the multi search API.\nHowever, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "fleet.search", "type": "object", "properties": { "index": { "oneOf": [{ "type": "string" }, { "type": "string" }], "description": "A single target to search. If the target is an index alias, it must resolve to a single index.", "x-found-in": "path" }, "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", "x-found-in": "query" }, "analyze_wildcard": { "type": "boolean", "x-found-in": "query" }, "batched_reduce_size": { "type": "number", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "x-found-in": "query" }, "default_operator": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__Operator", "x-found-in": "query" }, "df": { "type": "string", "x-found-in": "query" }, "docvalue_fields": { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, "description": "Array of wildcard (*) patterns. The request returns doc values for field\nnames matching these patterns in the hits.fields property of the response.", "x-found-in": "body" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "x-found-in": "query" }, "explain": { "type": "boolean", "description": "If true, returns detailed information about score computation as part of a hit.", "x-found-in": "body" }, "ignore_throttled": { "type": "boolean", "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", "x-found-in": "query" }, "max_concurrent_shard_requests": { "type": "number", "x-found-in": "query" }, "preference": { "type": "string", "x-found-in": "query" }, "pre_filter_shard_size": { "type": "number", "x-found-in": "query" }, "request_cache": { "type": "boolean", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "x-found-in": "query" }, "scroll": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "query" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "x-found-in": "query" }, "stats": { "type": "array", "items": { "type": "string" }, "description": "Stats groups to associate with the search. Each group maintains a statistics\naggregation for its associated searches. You can retrieve these stats using\nthe indices stats API.", "x-found-in": "body" }, "stored_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "List of stored fields to return as part of a hit. If no fields are specified,\nno stored fields are included in the response. If this field is specified, the _source\nparameter defaults to false. You can pass _source: true to return both source fields\nand stored fields in the search response.", "x-found-in": "body" }, "suggest_field": { "type": "string", "description": "Specifies which field to use for suggestions.", "x-found-in": "query" }, "suggest_mode": { "$ref": "./_types.json#/$defs/_types__SuggestMode", "x-found-in": "query" }, "suggest_size": { "type": "number", "x-found-in": "query" }, "suggest_text": { "type": "string", "description": "The source text for which the suggestions should be returned.", "x-found-in": "query" }, "terminate_after": { "type": "number", "description": "Maximum number of documents to collect for each shard. If a query reaches this\nlimit, Elasticsearch terminates the query early. Elasticsearch collects documents\nbefore sorting. Defaults to 0, which does not terminate query execution early.", "x-found-in": "body" }, "timeout": { "type": "string", "description": "Specifies the period of time to wait for a response from each shard. If no response\nis received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", "x-found-in": "body" }, "track_total_hits": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__TrackHits", "description": "Number of hits matching the query to count accurately. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.", "x-found-in": "body" }, "track_scores": { "type": "boolean", "description": "If true, calculate and return document scores, even if the scores are not used for sorting.", "x-found-in": "body" }, "typed_keys": { "type": "boolean", "x-found-in": "query" }, "rest_total_hits_as_int": { "type": "boolean", "x-found-in": "query" }, "version": { "type": "boolean", "description": "If true, returns document version as part of a hit.", "x-found-in": "body" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfig", "description": "Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.", "x-found-in": "body" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "x-found-in": "query" }, "seq_no_primary_term": { "type": "boolean", "description": "If true, returns sequence number and primary term of the last modification\nof each hit. See Optimistic concurrency control.", "x-found-in": "body" }, "q": { "type": "string", "x-found-in": "query" }, "size": { "type": "number", "description": "The number of hits to return. By default, you cannot page through more\nthan 10,000 hits using the from and size parameters. To page through more\nhits, use the search_after parameter.", "x-found-in": "body" }, "from": { "type": "number", "description": "Starting document offset. By default, you cannot page through more than 10,000\nhits using the from and size parameters. To page through more hits, use the\nsearch_after parameter.", "x-found-in": "body" }, "sort": { "$ref": "./_types.json#/$defs/_types__Sort", "x-found-in": "body" }, "wait_for_checkpoints": { "type": "array", "items": { "type": "number" }, "description": "A comma separated list of checkpoints. When configured, the search API will only be executed on a shard\nafter the relevant checkpoint has become visible for search. Defaults to an empty list which will cause\nElasticsearch to immediately execute the search.", "x-found-in": "query" }, "allow_partial_search_results": { "type": "boolean", "description": "If true, returns partial results if there are shard request timeouts or shard failures.\nIf false, returns an error with no partial results.\nDefaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default.", "x-found-in": "query" }, "aggregations": { "type": "object", "additionalProperties": { "$ref": "./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer" }, "x-found-in": "body" }, "collapse": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__FieldCollapse", "x-found-in": "body" }, "ext": { "type": "object", "additionalProperties": {}, "description": "Configuration of search extensions defined by Elasticsearch plugins.", "x-found-in": "body" }, "highlight": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Highlight", "x-found-in": "body" }, "indices_boost": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "number" } }, "description": "Boosts the _score of documents from specified indices.", "x-found-in": "body" }, "min_score": { "type": "number", "description": "Minimum _score for matching documents. Documents with a lower _score are\nnot included in search results and results collected by aggregations.", "x-found-in": "body" }, "post_filter": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "x-found-in": "body" }, "profile": { "type": "boolean", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Defines the search definition using the Query DSL.", "x-found-in": "body" }, "rescore": { "oneOf": [{ "$ref": "./_global.search._types.json#/$defs/_global.search._types__Rescore" }, { "type": "array", "items": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Rescore" } }], "x-found-in": "body" }, "script_fields": { "type": "object", "additionalProperties": { "$ref": "./_types.json#/$defs/_types__ScriptField" }, "description": "Retrieve a script evaluation (based on different fields) for each hit.", "x-found-in": "body" }, "search_after": { "$ref": "./_types.json#/$defs/_types__SortResults", "x-found-in": "body" }, "slice": { "$ref": "./_types.json#/$defs/_types__SlicedScroll", "x-found-in": "body" }, "fields": { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.", "x-found-in": "body" }, "suggest": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Suggester", "x-found-in": "body" }, "pit": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__PointInTimeReference", "description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an <index> in the request path.", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", "x-found-in": "body" } }, "required": ["index"], "description": "Run a Fleet search.\n\nThe purpose of the Fleet search API is to provide an API where the search will be run only\nafter the provided checkpoint has been processed and is visible for searches inside of Elasticsearch." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "fleet.search", "type": "object", "properties": { "aggregations": { "type": "object", "additionalProperties": { "$ref": "./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer" }, "x-found-in": "body" }, "collapse": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__FieldCollapse", "x-found-in": "body" }, "explain": { "type": "boolean", "x-found-in": "query" }, "ext": { "type": "object", "additionalProperties": {}, "description": "Configuration of search extensions defined by Elasticsearch plugins.", "x-found-in": "body" }, "from": { "type": "number", "x-found-in": "query" }, "highlight": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Highlight", "x-found-in": "body" }, "track_total_hits": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__TrackHits", "x-found-in": "query" }, "indices_boost": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "number" } }, "description": "Boosts the _score of documents from specified indices.", "x-found-in": "body" }, "docvalue_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "x-found-in": "query" }, "min_score": { "type": "number", "description": "Minimum _score for matching documents. Documents with a lower _score are\nnot included in search results and results collected by aggregations.", "x-found-in": "body" }, "post_filter": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "x-found-in": "body" }, "profile": { "type": "boolean", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Defines the search definition using the Query DSL.", "x-found-in": "body" }, "rescore": { "oneOf": [{ "$ref": "./_global.search._types.json#/$defs/_global.search._types__Rescore" }, { "type": "array", "items": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Rescore" } }], "x-found-in": "body" }, "script_fields": { "type": "object", "additionalProperties": { "$ref": "./_types.json#/$defs/_types__ScriptField" }, "description": "Retrieve a script evaluation (based on different fields) for each hit.", "x-found-in": "body" }, "search_after": { "$ref": "./_types.json#/$defs/_types__SortResults", "x-found-in": "body" }, "size": { "type": "number", "x-found-in": "query" }, "slice": { "$ref": "./_types.json#/$defs/_types__SlicedScroll", "x-found-in": "body" }, "sort": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "x-found-in": "query" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "x-found-in": "query" }, "fields": { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.", "x-found-in": "body" }, "suggest": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Suggester", "x-found-in": "body" }, "terminate_after": { "type": "number", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "query" }, "track_scores": { "type": "boolean", "x-found-in": "query" }, "version": { "type": "boolean", "x-found-in": "query" }, "seq_no_primary_term": { "type": "boolean", "x-found-in": "query" }, "stored_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "x-found-in": "query" }, "pit": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__PointInTimeReference", "description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an <index> in the request path.", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", "x-found-in": "body" }, "stats": { "type": "array", "items": { "type": "string" }, "x-found-in": "query" }, "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "analyzer": { "type": "string", "x-found-in": "query" }, "analyze_wildcard": { "type": "boolean", "x-found-in": "query" }, "batched_reduce_size": { "type": "number", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "x-found-in": "query" }, "default_operator": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__Operator", "x-found-in": "query" }, "df": { "type": "string", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "x-found-in": "query" }, "ignore_throttled": { "type": "boolean", "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", "x-found-in": "query" }, "max_concurrent_shard_requests": { "type": "number", "x-found-in": "query" }, "preference": { "type": "string", "x-found-in": "query" }, "pre_filter_shard_size": { "type": "number", "x-found-in": "query" }, "request_cache": { "type": "boolean", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "x-found-in": "query" }, "scroll": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "query" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "x-found-in": "query" }, "suggest_field": { "type": "string", "description": "Specifies which field to use for suggestions.", "x-found-in": "query" }, "suggest_mode": { "$ref": "./_types.json#/$defs/_types__SuggestMode", "x-found-in": "query" }, "suggest_size": { "type": "number", "x-found-in": "query" }, "suggest_text": { "type": "string", "description": "The source text for which the suggestions should be returned.", "x-found-in": "query" }, "typed_keys": { "type": "boolean", "x-found-in": "query" }, "rest_total_hits_as_int": { "type": "boolean", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "x-found-in": "query" }, "q": { "type": "string", "x-found-in": "query" }, "wait_for_checkpoints": { "type": "array", "items": { "type": "number" }, "description": "A comma separated list of checkpoints. When configured, the search API will only be executed on a shard\nafter the relevant checkpoint has become visible for search. Defaults to an empty list which will cause\nElasticsearch to immediately execute the search.", "x-found-in": "query" }, "allow_partial_search_results": { "type": "boolean", "description": "If true, returns partial results if there are shard request timeouts or shard failures.\nIf false, returns an error with no partial results.\nDefaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default.", "x-found-in": "query" }, "index": { "oneOf": [{ "type": "string" }, { "type": "string" }], "description": "A single target to search. If the target is an index alias, it must resolve to a single index.", "x-found-in": "path" } }, "required": ["index"], "description": "Run a Fleet search.\n\nThe purpose of the Fleet search API is to provide an API where the search will be run only\nafter the provided checkpoint has been processed and is visible for searches inside of Elasticsearch." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get", "type": "object", "properties": { "id": { "type": "string", "description": "A unique document identifier.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the index that contains the document.", "x-found-in": "path" }, "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nBy default, the operation is randomized between the shard replicas.\n\nIf it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible.\nIf it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value.\nThis can help with \"jumping values\" when hitting different shards in different refresh states.\nA sample value can be something like the web session ID or the user name.", "x-found-in": "query" }, "realtime": { "type": "boolean", "description": "If `true`, the request is real-time as opposed to near-real-time.", "x-found-in": "query" }, "refresh": { "type": "boolean", "description": "If `true`, the request refreshes the relevant shards before retrieving the document.\nSetting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", "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" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "_source_exclude_vectors": { "type": "boolean", "description": "Whether vectors should be excluded from _source", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "stored_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to `false`.\nOnly leaf fields can be retrieved with the `stored_fields` option.\nObject fields can't be returned; if specified, the request fails.", "x-found-in": "query" }, "version": { "type": "number", "description": "The 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" } }, "required": ["id", "index"], "description": "Get a document by its ID.\n\nGet a document and its source or stored fields from an index.\n\nBy default, this API is realtime and is not affected by the refresh rate of the index (when data will become visible for search).\nIn the case where stored fields are requested with the `stored_fields` parameter and the document has been updated but is not yet refreshed, the API will have to parse and analyze the source to extract the stored fields.\nTo turn off realtime behavior, set the `realtime` parameter to false.\n\n**Source filtering**\n\nBy default, the API returns the contents of the `_source` field unless you have used the `stored_fields` parameter or the `_source` field is turned off.\nYou can turn off `_source` retrieval by using the `_source` parameter:\n\n```\nGET my-index-000001/_doc/0?_source=false\n```\n\nIf you only need one or two fields from the `_source`, use the `_source_includes` or `_source_excludes` parameters to include or filter out particular fields.\nThis can be helpful with large documents where partial retrieval can save on network overhead\nBoth parameters take a comma separated list of fields or wildcard expressions.\nFor example:\n\n```\nGET my-index-000001/_doc/0?_source_includes=*.id&_source_excludes=entities\n```\n\nIf you only want to specify includes, you can use a shorter notation:\n\n```\nGET my-index-000001/_doc/0?_source=*.id\n```\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to retrieve a document.\nFor example:\n\n```\nGET my-index-000001/_doc/2?routing=user1\n```\n\nThis request gets the document with ID 2, but it is routed based on the user.\nThe document is not fetched if the correct routing is not specified.\n\n**Distributed**\n\nThe GET operation is hashed into a specific shard ID.\nIt is then redirected to one of the replicas within that shard ID and returns the result.\nThe replicas are the primary shard and its replicas within that shard ID group.\nThis means that the more replicas you have, the better your GET scaling will be.\n\n**Versioning support**\n\nYou can use the `version` parameter to retrieve the document only if its current version is equal to the specified one.\n\nInternally, Elasticsearch has marked the old document as deleted and added an entirely new document.\nThe old version of the document doesn't disappear immediately, although you won't be able to access it.\nElasticsearch cleans up deleted documents in the background as you continue to index more data." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get", "type": "object", "properties": { "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nBy default, the operation is randomized between the shard replicas.\n\nIf it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible.\nIf it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value.\nThis can help with \"jumping values\" when hitting different shards in different refresh states.\nA sample value can be something like the web session ID or the user name.", "x-found-in": "query" }, "realtime": { "type": "boolean", "description": "If `true`, the request is real-time as opposed to near-real-time.", "x-found-in": "query" }, "refresh": { "type": "boolean", "description": "If `true`, the request refreshes the relevant shards before retrieving the document.\nSetting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", "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" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "_source_exclude_vectors": { "type": "boolean", "description": "Whether vectors should be excluded from _source", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "stored_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to `false`.\nOnly leaf fields can be retrieved with the `stored_fields` option.\nObject fields can't be returned; if specified, the request fails.", "x-found-in": "query" }, "version": { "type": "number", "description": "The 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" }, "id": { "type": "string", "description": "A unique document identifier.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the index that contains the document.", "x-found-in": "path" } }, "required": ["id", "index"], "description": "Get a document by its ID.\n\nGet a document and its source or stored fields from an index.\n\nBy default, this API is realtime and is not affected by the refresh rate of the index (when data will become visible for search).\nIn the case where stored fields are requested with the `stored_fields` parameter and the document has been updated but is not yet refreshed, the API will have to parse and analyze the source to extract the stored fields.\nTo turn off realtime behavior, set the `realtime` parameter to false.\n\n**Source filtering**\n\nBy default, the API returns the contents of the `_source` field unless you have used the `stored_fields` parameter or the `_source` field is turned off.\nYou can turn off `_source` retrieval by using the `_source` parameter:\n\n```\nGET my-index-000001/_doc/0?_source=false\n```\n\nIf you only need one or two fields from the `_source`, use the `_source_includes` or `_source_excludes` parameters to include or filter out particular fields.\nThis can be helpful with large documents where partial retrieval can save on network overhead\nBoth parameters take a comma separated list of fields or wildcard expressions.\nFor example:\n\n```\nGET my-index-000001/_doc/0?_source_includes=*.id&_source_excludes=entities\n```\n\nIf you only want to specify includes, you can use a shorter notation:\n\n```\nGET my-index-000001/_doc/0?_source=*.id\n```\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to retrieve a document.\nFor example:\n\n```\nGET my-index-000001/_doc/2?routing=user1\n```\n\nThis request gets the document with ID 2, but it is routed based on the user.\nThe document is not fetched if the correct routing is not specified.\n\n**Distributed**\n\nThe GET operation is hashed into a specific shard ID.\nIt is then redirected to one of the replicas within that shard ID and returns the result.\nThe replicas are the primary shard and its replicas within that shard ID group.\nThis means that the more replicas you have, the better your GET scaling will be.\n\n**Versioning support**\n\nYou can use the `version` parameter to retrieve the document only if its current version is equal to the specified one.\n\nInternally, Elasticsearch has marked the old document as deleted and added an entirely new document.\nThe old version of the document doesn't disappear immediately, although you won't be able to access it.\nElasticsearch cleans up deleted documents in the background as you continue to index more data." }

package/lib/es/json/get_reindex.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get_reindex", "type": "object", "properties": { "task_id": { "type": "string", "description": "The ID of the reindex task to retrieve.", "x-found-in": "path" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request blocks until the reindex task completes, then returns the result.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the reindex task to complete when `wait_for_completion` is `true`.", "x-found-in": "query" } }, "required": ["task_id"], "description": "Get the status and progress of a specific reindex task.\n\nThis API follows reindex tasks across node-shutdown relocations, so callers can\nkeep using the original task ID throughout the lifetime of the operation.\nReturned task IDs and timings reflect the original task, not its relocated successor.\nRelocated task IDs are also supported. They are followed transparently and return the task ID and timings of the original task.\n\nWhen the task ID cannot be resolved, the API returns the response below with a 404 status code.\nThis response is used whether the ID is unknown, refers to a non-reindex task, refers to a sliced child subtask, or refers to a task whose node left the cluster with no stored result (e.g. a non-graceful shutdown).\n```\n{\n  \"error\": {\n    \"type\": \"resource_not_found_exception\",\n    \"reason\": \"Reindex operation [r1A2WoRbTwKZ516z6NEs5A:36619] not found\"\n  },\n  \"status\": 404\n}\n```" }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get_reindex", "type": "object", "properties": { "wait_for_completion": { "type": "boolean", "description": "If `true`, the request blocks until the reindex task completes, then returns the result.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the reindex task to complete when `wait_for_completion` is `true`.", "x-found-in": "query" }, "task_id": { "type": "string", "description": "The ID of the reindex task to retrieve.", "x-found-in": "path" } }, "required": ["task_id"], "description": "Get the status and progress of a specific reindex task.\n\nThis API follows reindex tasks across node-shutdown relocations, so callers can\nkeep using the original task ID throughout the lifetime of the operation.\nReturned task IDs and timings reflect the original task, not its relocated successor.\nRelocated task IDs are also supported. They are followed transparently and return the task ID and timings of the original task.\n\nWhen the task ID cannot be resolved, the API returns the response below with a 404 status code.\nThis response is used whether the ID is unknown, refers to a non-reindex task, refers to a sliced child subtask, or refers to a task whose node left the cluster with no stored result (e.g. a non-graceful shutdown).\n```\n{\n  \"error\": {\n    \"type\": \"resource_not_found_exception\",\n    \"reason\": \"Reindex operation [r1A2WoRbTwKZ516z6NEs5A:36619] not found\"\n  },\n  \"status\": 404\n}\n```" }

package/lib/es/json/get_script.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get_script", "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the stored script or search template.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" } }, "required": ["id"], "description": "Get a script or search template.\n\nRetrieves a stored script or search template." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get_script", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\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"], "description": "Get a script or search template.\n\nRetrieves a stored script or search template." }