@elastic/schemas 0.5.1 → 0.6.0

package/lib/cjs/es/json/delete_by_query_rethrottle.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete_by_query_rethrottle", "description": "Throttle a delete by query operation.\n\nChange the number of requests per second for a particular delete by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.", "x-api": { "id": "delete_by_query_rethrottle", "name": "delete-by-query-rethrottle", "namespace": null }, "x-method": "POST", "x-path": "/_delete_by_query/{task_id}/_rethrottle", "x-urls": [{ "path": "/_delete_by_query/{task_id}/_rethrottle", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "requests_per_second": { "type": "number", "description": "The maximum number of documents to delete per second, across the entire delete-by-query operation (including slices).\nIt can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.", "x-found-in": "query" }, "task_id": { "type": "string", "description": "The ID for the task.", "x-found-in": "path" } }, "required": ["task_id", "requests_per_second"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete_by_query_rethrottle", "description": "Throttle a delete by query operation.\n\nChange the number of requests per second for a particular delete by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.", "x-api": { "id": "delete_by_query_rethrottle", "name": "delete-by-query-rethrottle", "namespace": null }, "x-method": "POST", "x-path": "/_delete_by_query/{task_id}/_rethrottle", "x-urls": [{ "path": "/_delete_by_query/{task_id}/_rethrottle", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "requests_per_second": { "type": "number", "description": "The maximum number of documents to delete per second, across the entire delete-by-query operation (including slices).\nIt can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.", "x-found-in": "query" }, "task_id": { "type": "string", "description": "The ID for the task.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["task_id", "requests_per_second"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete_script", "description": "Delete a script or search template.\n\nDeletes a stored script or search template.", "x-api": { "id": "delete_script", "name": "delete-script", "namespace": null }, "x-method": "DELETE", "x-path": "/_scripts/{id}", "x-urls": [{ "path": "/_scripts/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "id": { "type": "string", "description": "The identifier for the stored script or search template.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete_script", "description": "Delete a script or search template.\n\nDeletes a stored script or search template.", "x-api": { "id": "delete_script", "name": "delete-script", "namespace": null }, "x-method": "DELETE", "x-path": "/_scripts/{id}", "x-urls": [{ "path": "/_scripts/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "id": { "type": "string", "description": "The identifier for the stored script or search template.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "encryption.reset", "description": "Reset the project encryption key.\n\nDestroy the current project encryption key (PEK) and generate a new one.\nThis is the recovery path for when the on-disk encrypted PEK becomes permanently\ninaccessible, for example because the key encryption material protecting it was lost.\n\nAll data that was encrypted under the destroyed key becomes permanently unrecoverable.\nEach feature that stores encrypted data decides how to handle its own data during the\nreset: some features drop the encrypted values entirely, while others preserve the rest\nof the affected data and only clear the values that can no longer be decrypted.\n\nBecause this operation causes permanent data loss, it requires the `accept_data_loss`\nquery parameter to be set to `true`.", "x-api": { "id": "encryption.reset", "name": "reset", "namespace": "encryption" }, "x-method": "POST", "x-path": "/_encryption/_reset", "x-urls": [{ "path": "/_encryption/_reset", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "9.5.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "private" } }, "type": "object", "properties": { "accept_data_loss": { "type": "boolean", "description": "Acknowledge that resetting the project encryption key permanently destroys all data\nthat was encrypted under the current key.\nThe request fails if this is not set to `true`.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "required": ["accept_data_loss"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "encryption.reset", "description": "Reset the project encryption key.\n\nDestroy the current project encryption key (PEK) and generate a new one.\nThis is the recovery path for when the on-disk encrypted PEK becomes permanently\ninaccessible, for example because the key encryption material protecting it was lost.\n\nAll data that was encrypted under the destroyed key becomes permanently unrecoverable.\nEach feature that stores encrypted data decides how to handle its own data during the\nreset: some features drop the encrypted values entirely, while others preserve the rest\nof the affected data and only clear the values that can no longer be decrypted.\n\nBecause this operation causes permanent data loss, it requires the `accept_data_loss`\nquery parameter to be set to `true`.", "x-api": { "id": "encryption.reset", "name": "reset", "namespace": "encryption" }, "x-method": "POST", "x-path": "/_encryption/_reset", "x-urls": [{ "path": "/_encryption/_reset", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "9.5.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "private" } }, "type": "object", "properties": { "accept_data_loss": { "type": "boolean", "description": "Acknowledge that resetting the project encryption key permanently destroys all data\nthat was encrypted under the current key.\nThe request fails if this is not set to `true`.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["accept_data_loss"] }

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

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

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.execute_policy", "description": "Run an enrich policy.\n\nCreate the enrich index for an existing enrich policy.", "x-api": { "id": "enrich.execute_policy", "name": "execute-policy", "namespace": "enrich" }, "x-method": "PUT", "x-path": "/_enrich/policy/{name}/_execute", "x-urls": [{ "path": "/_enrich/policy/{name}/_execute", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request blocks other enrich policy execution requests until complete.", "x-found-in": "query" }, "name": { "type": "string", "description": "Enrich policy to execute.", "x-found-in": "path" } }, "required": ["name"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.execute_policy", "description": "Run an enrich policy.\n\nCreate the enrich index for an existing enrich policy.", "x-api": { "id": "enrich.execute_policy", "name": "execute-policy", "namespace": "enrich" }, "x-method": "PUT", "x-path": "/_enrich/policy/{name}/_execute", "x-urls": [{ "path": "/_enrich/policy/{name}/_execute", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request blocks other enrich policy execution requests until complete.", "x-found-in": "query" }, "name": { "type": "string", "description": "Enrich policy to execute.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["name"] }

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

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

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.put_policy", "description": "Create an enrich policy.\n\nCreates an enrich policy.", "x-api": { "id": "enrich.put_policy", "name": "put-policy", "namespace": "enrich" }, "x-method": "PUT", "x-path": "/_enrich/policy/{name}", "x-urls": [{ "path": "/_enrich/policy/{name}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "geo_match": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches enrich data to incoming documents based on a `geo_shape` query.", "x-found-in": "body" }, "match": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches enrich data to incoming documents based on a `term` query.", "x-found-in": "body" }, "range": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query.", "x-found-in": "body" }, "name": { "type": "string", "description": "Name of the enrich policy to create or update.", "x-found-in": "path" } }, "required": ["name"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.put_policy", "description": "Create an enrich policy.\n\nCreates an enrich policy.", "x-api": { "id": "enrich.put_policy", "name": "put-policy", "namespace": "enrich" }, "x-method": "PUT", "x-path": "/_enrich/policy/{name}", "x-urls": [{ "path": "/_enrich/policy/{name}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "geo_match": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches enrich data to incoming documents based on a `geo_shape` query.", "x-found-in": "body" }, "match": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches enrich data to incoming documents based on a `term` query.", "x-found-in": "body" }, "range": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query.", "x-found-in": "body" }, "name": { "type": "string", "description": "Name of the enrich policy to create or update.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["name"] }

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

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

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.delete", "description": "Delete an async EQL search.\n\nDelete an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", "x-api": { "id": "eql.delete", "name": "delete", "namespace": "eql" }, "x-method": "DELETE", "x-path": "/_eql/search/{id}", "x-urls": [{ "path": "/_eql/search/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the search to delete.\nA search ID is provided in the EQL search API's response for an async search.\nA search ID is also provided if the request’s `keep_on_completion` parameter is `true`.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.delete", "description": "Delete an async EQL search.\n\nDelete an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", "x-api": { "id": "eql.delete", "name": "delete", "namespace": "eql" }, "x-method": "DELETE", "x-path": "/_eql/search/{id}", "x-urls": [{ "path": "/_eql/search/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the search to delete.\nA search ID is provided in the EQL search API's response for an async search.\nA search ID is also provided if the request’s `keep_on_completion` parameter is `true`.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.get", "description": "Get async EQL search results.\n\nGet the current status and available results for an async EQL search or a stored synchronous EQL search.", "x-api": { "id": "eql.get", "name": "get", "namespace": "eql" }, "x-method": "GET", "x-path": "/_eql/search/{id}", "x-urls": [{ "path": "/_eql/search/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period for which the search and its results are stored on the cluster.\nDefaults to the keep_alive value set by the search’s EQL search API request.", "x-found-in": "query" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Timeout duration to wait for the request to finish.\nDefaults to no timeout, meaning the request waits for complete search results.", "x-found-in": "query" }, "id": { "type": "string", "description": "Identifier for the search.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.get", "description": "Get async EQL search results.\n\nGet the current status and available results for an async EQL search or a stored synchronous EQL search.", "x-api": { "id": "eql.get", "name": "get", "namespace": "eql" }, "x-method": "GET", "x-path": "/_eql/search/{id}", "x-urls": [{ "path": "/_eql/search/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period for which the search and its results are stored on the cluster.\nDefaults to the keep_alive value set by the search’s EQL search API request.", "x-found-in": "query" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Timeout duration to wait for the request to finish.\nDefaults to no timeout, meaning the request waits for complete search results.", "x-found-in": "query" }, "id": { "type": "string", "description": "Identifier for the search.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.get_status", "description": "Get the async EQL status.\n\nGet the current status for an async EQL search or a stored synchronous EQL search without returning results.", "x-api": { "id": "eql.get_status", "name": "get-status", "namespace": "eql" }, "x-method": "GET", "x-path": "/_eql/search/status/{id}", "x-urls": [{ "path": "/_eql/search/status/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the search.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.get_status", "description": "Get the async EQL status.\n\nGet the current status for an async EQL search or a stored synchronous EQL search without returning results.", "x-api": { "id": "eql.get_status", "name": "get-status", "namespace": "eql" }, "x-method": "GET", "x-path": "/_eql/search/status/{id}", "x-urls": [{ "path": "/_eql/search/status/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the search.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.search", "description": "Get EQL search results.\n\nReturns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", "x-api": { "id": "eql.search", "name": "search", "namespace": "eql" }, "x-method": "GET", "x-path": "/{index}/_eql/search", "x-urls": [{ "path": "/{index}/_eql/search", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "allow_partial_search_results": { "type": "boolean", "description": "Allow query execution also in case of shard failures.\nIf true, the query will keep running and will return results based on the available shards.\nFor sequences, the behavior can be further refined using allow_partial_sequence_results", "x-found-in": "body" }, "allow_partial_sequence_results": { "type": "boolean", "description": "This flag applies only to sequences and has effect only if allow_partial_search_results=true.\nIf true, the sequence query will return results based on the available shards, ignoring the others.\nIf false, the sequence query will return successfully, but will always have empty results.", "x-found-in": "body" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "keep_on_completion": { "type": "boolean", "x-found-in": "body" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "query": { "type": "string", "description": "EQL query you wish to run.", "x-found-in": "body" }, "case_sensitive": { "type": "boolean", "x-found-in": "body" }, "event_category_field": { "type": "string", "description": "Field containing the event classification, such as process, file, or network.", "x-found-in": "body" }, "tiebreaker_field": { "type": "string", "description": "Field used to sort hits with the same timestamp in ascending order", "x-found-in": "body" }, "timestamp_field": { "type": "string", "description": "Field containing event timestamp.", "x-found-in": "body" }, "fetch_size": { "type": "number", "description": "Maximum number of events to search at a time for sequence queries.", "x-found-in": "body" }, "filter": { "anyOf": [{ "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer" }, { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer" } }], "description": "Query, written in Query DSL, used to filter the events on which the EQL query runs.", "x-found-in": "body" }, "size": { "type": "number", "description": "For basic queries, the maximum number of matching events to return. Defaults to 10", "x-found-in": "body" }, "fields": { "anyOf": [{ "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" } }], "description": "Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit.", "x-found-in": "body" }, "result_position": { "$ref": "./eql.search.json#/$defs/eql.search__ResultPosition", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "x-found-in": "body", "x-availability": { "stack": { "since": "8.0.0" }, "serverless": {} } }, "max_samples_per_key": { "type": "number", "description": "By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size`\nparameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the\n`max_samples_per_key` parameter. Pipes are not supported for sample queries.", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of index names to scope the operation", "x-found-in": "path" } }, "required": ["index", "query"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.search", "description": "Get EQL search results.\n\nReturns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", "x-api": { "id": "eql.search", "name": "search", "namespace": "eql" }, "x-method": "GET", "x-path": "/{index}/_eql/search", "x-urls": [{ "path": "/{index}/_eql/search", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "allow_partial_search_results": { "type": "boolean", "description": "Allow query execution also in case of shard failures.\nIf true, the query will keep running and will return results based on the available shards.\nFor sequences, the behavior can be further refined using allow_partial_sequence_results", "x-found-in": "body" }, "allow_partial_sequence_results": { "type": "boolean", "description": "This flag applies only to sequences and has effect only if allow_partial_search_results=true.\nIf true, the sequence query will return results based on the available shards, ignoring the others.\nIf false, the sequence query will return successfully, but will always have empty results.", "x-found-in": "body" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "keep_on_completion": { "type": "boolean", "x-found-in": "body" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "query": { "type": "string", "description": "EQL query you wish to run.", "x-found-in": "body" }, "case_sensitive": { "type": "boolean", "x-found-in": "body" }, "event_category_field": { "type": "string", "description": "Field containing the event classification, such as process, file, or network.", "x-found-in": "body" }, "tiebreaker_field": { "type": "string", "description": "Field used to sort hits with the same timestamp in ascending order", "x-found-in": "body" }, "timestamp_field": { "type": "string", "description": "Field containing event timestamp.", "x-found-in": "body" }, "fetch_size": { "type": "number", "description": "Maximum number of events to search at a time for sequence queries.", "x-found-in": "body" }, "filter": { "anyOf": [{ "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer" }, { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer" } }], "description": "Query, written in Query DSL, used to filter the events on which the EQL query runs.", "x-found-in": "body" }, "size": { "type": "number", "description": "For basic queries, the maximum number of matching events to return. Defaults to 10", "x-found-in": "body" }, "fields": { "anyOf": [{ "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" } }], "description": "Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit.", "x-found-in": "body" }, "result_position": { "$ref": "./eql.search.json#/$defs/eql.search__ResultPosition", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "x-found-in": "body", "x-availability": { "stack": { "since": "8.0.0" }, "serverless": {} } }, "max_samples_per_key": { "type": "number", "description": "By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size`\nparameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the\n`max_samples_per_key` parameter. Pipes are not supported for sample queries.", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of index names to scope the operation", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["index", "query"] }

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

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

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query_delete", "description": "Delete an async ES|QL query.\n\nIf the query is still running, it is cancelled.\nOtherwise, the stored results are deleted.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a query:\n\n* The authenticated user that submitted the original query request\n* Users with the `cancel_task` cluster privilege", "x-api": { "id": "esql.async_query_delete", "name": "async-query-delete", "namespace": "esql" }, "x-method": "DELETE", "x-path": "/_query/async/{id}", "x-urls": [{ "path": "/_query/async/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.13.0", "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the query.\nA query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.\nA query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query_delete", "description": "Delete an async ES|QL query.\n\nIf the query is still running, it is cancelled.\nOtherwise, the stored results are deleted.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a query:\n\n* The authenticated user that submitted the original query request\n* Users with the `cancel_task` cluster privilege", "x-api": { "id": "esql.async_query_delete", "name": "async-query-delete", "namespace": "esql" }, "x-method": "DELETE", "x-path": "/_query/async/{id}", "x-urls": [{ "path": "/_query/async/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.13.0", "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the query.\nA query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.\nA query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query_get", "description": "Get async ES|QL query results.\n\nGet the current status and available results or stored results for an ES|QL asynchronous query.\nIf the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API.", "x-api": { "id": "esql.async_query_get", "name": "async-query-get", "namespace": "esql" }, "x-method": "GET", "x-path": "/_query/async/{id}", "x-urls": [{ "path": "/_query/async/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.13.0", "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "drop_null_columns": { "type": "boolean", "description": "Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.\nIf `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.", "x-found-in": "query" }, "format": { "$ref": "./esql._types.json#/$defs/esql._types__EsqlFormat", "description": "A short version of the Accept header, for example `json` or `yaml`.", "x-found-in": "query" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period for which the query and its results are stored in the cluster.\nWhen this period expires, the query and its results are deleted, even if the query is still ongoing.", "x-found-in": "query" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the request to finish.\nBy default, the request waits for complete query results.\nIf the request completes during the period specified in this parameter, complete query results are returned.\nOtherwise, the response returns an `is_running` value of `true` and no results.", "x-found-in": "query" }, "id": { "type": "string", "description": "The unique identifier of the query.\nA query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.\nA query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query_get", "description": "Get async ES|QL query results.\n\nGet the current status and available results or stored results for an ES|QL asynchronous query.\nIf the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API.", "x-api": { "id": "esql.async_query_get", "name": "async-query-get", "namespace": "esql" }, "x-method": "GET", "x-path": "/_query/async/{id}", "x-urls": [{ "path": "/_query/async/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.13.0", "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "drop_null_columns": { "type": "boolean", "description": "Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.\nIf `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.", "x-found-in": "query" }, "format": { "$ref": "./esql._types.json#/$defs/esql._types__EsqlFormat", "description": "A short version of the Accept header, for example `json` or `yaml`.", "x-found-in": "query" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period for which the query and its results are stored in the cluster.\nWhen this period expires, the query and its results are deleted, even if the query is still ongoing.", "x-found-in": "query" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the request to finish.\nBy default, the request waits for complete query results.\nIf the request completes during the period specified in this parameter, complete query results are returned.\nOtherwise, the response returns an `is_running` value of `true` and no results.", "x-found-in": "query" }, "id": { "type": "string", "description": "The unique identifier of the query.\nA query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.\nA query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query_stop", "description": "Stop async ES|QL query.\n\nThis API interrupts the query execution and returns the results so far.\nIf the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it.", "x-api": { "id": "esql.async_query_stop", "name": "async-query-stop", "namespace": "esql" }, "x-method": "POST", "x-path": "/_query/async/{id}/stop", "x-urls": [{ "path": "/_query/async/{id}/stop", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.18.0", "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "drop_null_columns": { "type": "boolean", "description": "Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.\nIf `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.", "x-found-in": "query" }, "id": { "type": "string", "description": "The unique identifier of the query.\nA query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.\nA query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "esql.async_query_stop", "description": "Stop async ES|QL query.\n\nThis API interrupts the query execution and returns the results so far.\nIf the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it.", "x-api": { "id": "esql.async_query_stop", "name": "async-query-stop", "namespace": "esql" }, "x-method": "POST", "x-path": "/_query/async/{id}/stop", "x-urls": [{ "path": "/_query/async/{id}/stop", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.18.0", "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "drop_null_columns": { "type": "boolean", "description": "Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.\nIf `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.", "x-found-in": "query" }, "id": { "type": "string", "description": "The unique identifier of the query.\nA query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.\nA query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id"] }

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

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

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

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

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

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

package/lib/cjs/es/json/esql.list_queries.request.json

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

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

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

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

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

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

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

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

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

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

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

package/lib/cjs/es/json/features.get_features.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "features.get_features", "description": "Get the features.\n\nGet a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot.\nYou can use this API to determine which feature states to include when taking a snapshot.\nBy default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not.\n\nA feature state includes one or more system indices necessary for a given feature to function.\nIn order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together.\n\nThe features listed by this API are a combination of built-in features and features defined by plugins.\nIn order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node.", "x-api": { "id": "features.get_features", "name": "get-features", "namespace": "features" }, "x-method": "GET", "x-path": "/_features", "x-urls": [{ "path": "/_features", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.12.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "features.get_features", "description": "Get the features.\n\nGet a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot.\nYou can use this API to determine which feature states to include when taking a snapshot.\nBy default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not.\n\nA feature state includes one or more system indices necessary for a given feature to function.\nIn order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together.\n\nThe features listed by this API are a combination of built-in features and features defined by plugins.\nIn order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node.", "x-api": { "id": "features.get_features", "name": "get-features", "namespace": "features" }, "x-method": "GET", "x-path": "/_features", "x-urls": [{ "path": "/_features", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.12.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/features.reset_features.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "features.reset_features", "description": "Reset the features.\n\nClear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.\n\nWARNING: Intended for development and testing use only. Do not reset features on a production cluster.\n\nReturn a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features.\nThis deletes all state information stored in system indices.\n\nThe response code is HTTP 200 if the state is successfully reset for all features.\nIt is HTTP 500 if the reset operation failed for any feature.\n\nNote that select features might provide a way to reset particular system indices.\nUsing this API resets all features, both those that are built-in and implemented as plugins.\n\nTo list the features that will be affected, use the get features API.\n\nIMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.", "x-api": { "id": "features.reset_features", "name": "reset-features", "namespace": "features" }, "x-method": "POST", "x-path": "/_features/_reset", "x-urls": [{ "path": "/_features/_reset", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.12.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "private" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "features.reset_features", "description": "Reset the features.\n\nClear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.\n\nWARNING: Intended for development and testing use only. Do not reset features on a production cluster.\n\nReturn a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features.\nThis deletes all state information stored in system indices.\n\nThe response code is HTTP 200 if the state is successfully reset for all features.\nIt is HTTP 500 if the reset operation failed for any feature.\n\nNote that select features might provide a way to reset particular system indices.\nUsing this API resets all features, both those that are built-in and implemented as plugins.\n\nTo list the features that will be affected, use the get features API.\n\nIMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.", "x-api": { "id": "features.reset_features", "name": "reset-features", "namespace": "features" }, "x-method": "POST", "x-path": "/_features/_reset", "x-urls": [{ "path": "/_features/_reset", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.12.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "private" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }