@elastic/schemas 0.5.1 → 0.6.0

package/lib/cjs/es/json/ingest.put_geoip_database.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.put_geoip_database", "description": "Create or update a GeoIP database configuration.\n\nRefer to the create or update IP geolocation database configuration API.", "x-api": { "id": "ingest.put_geoip_database", "name": "put-geoip-database", "namespace": "ingest" }, "x-method": "PUT", "x-path": "/_ingest/geoip/database/{id}", "x-urls": [{ "path": "/_ingest/geoip/database/{id}", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable" }, "serverless": { "visibility": "private" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "name": { "type": "string", "description": "The provider-assigned name of the IP geolocation database to download.", "x-found-in": "body" }, "maxmind": { "$ref": "./ingest._types.json#/$defs/ingest._types__Maxmind", "description": "The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured.", "x-found-in": "body" }, "id": { "type": "string", "description": "ID of the database configuration to create or update.", "x-found-in": "path" } }, "required": ["id", "name", "maxmind"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.put_geoip_database", "description": "Create or update a GeoIP database configuration.\n\nRefer to the create or update IP geolocation database configuration API.", "x-api": { "id": "ingest.put_geoip_database", "name": "put-geoip-database", "namespace": "ingest" }, "x-method": "PUT", "x-path": "/_ingest/geoip/database/{id}", "x-urls": [{ "path": "/_ingest/geoip/database/{id}", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable" }, "serverless": { "visibility": "private" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "name": { "type": "string", "description": "The provider-assigned name of the IP geolocation database to download.", "x-found-in": "body" }, "maxmind": { "$ref": "./ingest._types.json#/$defs/ingest._types__Maxmind", "description": "The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured.", "x-found-in": "body" }, "id": { "type": "string", "description": "ID of the database configuration 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": ["id", "name", "maxmind"] }

package/lib/cjs/es/json/ingest.put_ip_location_database.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.put_ip_location_database", "description": "Create or update an IP geolocation database configuration.", "x-api": { "id": "ingest.put_ip_location_database", "name": "put-ip-location-database", "namespace": "ingest" }, "x-method": "PUT", "x-path": "/_ingest/ip_location/database/{id}", "x-urls": [{ "path": "/_ingest/ip_location/database/{id}", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable" }, "serverless": { "visibility": "private" } }, "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.\nA value of `-1` indicates that the request should never time out.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged.\nA value of `-1` indicates that the request should never time out.", "x-found-in": "query" }, "configuration": { "$ref": "./ingest._types.json#/$defs/ingest._types__DatabaseConfiguration", "x-found-in": "body", "x-body-root": true }, "id": { "type": "string", "description": "The database configuration identifier.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.put_ip_location_database", "description": "Create or update an IP geolocation database configuration.", "x-api": { "id": "ingest.put_ip_location_database", "name": "put-ip-location-database", "namespace": "ingest" }, "x-method": "PUT", "x-path": "/_ingest/ip_location/database/{id}", "x-urls": [{ "path": "/_ingest/ip_location/database/{id}", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable" }, "serverless": { "visibility": "private" } }, "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.\nA value of `-1` indicates that the request should never time out.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged.\nA value of `-1` indicates that the request should never time out.", "x-found-in": "query" }, "configuration": { "$ref": "./ingest._types.json#/$defs/ingest._types__DatabaseConfiguration", "x-found-in": "body", "x-body-root": true }, "id": { "type": "string", "description": "The database configuration identifier.", "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/ingest.put_pipeline.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.put_pipeline", "description": "Create or update a pipeline.\n\nChanges made using this API take effect immediately.", "x-api": { "id": "ingest.put_pipeline", "name": "put-pipeline", "namespace": "ingest" }, "x-method": "PUT", "x-path": "/_ingest/pipeline/{id}", "x-urls": [{ "path": "/_ingest/pipeline/{id}", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.0.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. If 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": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "if_version": { "type": "number", "description": "Required version for optimistic concurrency control for pipeline updates", "x-found-in": "query" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.", "x-found-in": "body" }, "description": { "type": "string", "description": "Description of the ingest pipeline.", "x-found-in": "body" }, "on_failure": { "type": "array", "items": { "$ref": "./ingest._types.json#/$defs/ingest._types__ProcessorContainer" }, "description": "Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors.", "x-found-in": "body" }, "processors": { "type": "array", "items": { "$ref": "./ingest._types.json#/$defs/ingest._types__ProcessorContainer" }, "description": "Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.", "x-found-in": "body" }, "version": { "type": "number", "description": "Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers.", "x-found-in": "body" }, "deprecated": { "type": "boolean", "description": "Marks this ingest pipeline as deprecated.\nWhen a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.", "x-found-in": "body" }, "field_access_pattern": { "$ref": "./ingest._types.json#/$defs/ingest._types__FieldAccessPattern", "description": "Controls how processors in this pipeline should read and write data on a document's source.", "x-found-in": "body", "x-availability": { "stack": { "since": "9.2.0" }, "serverless": {} } }, "id": { "type": "string", "description": "ID of the ingest pipeline to create or update.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.put_pipeline", "description": "Create or update a pipeline.\n\nChanges made using this API take effect immediately.", "x-api": { "id": "ingest.put_pipeline", "name": "put-pipeline", "namespace": "ingest" }, "x-method": "PUT", "x-path": "/_ingest/pipeline/{id}", "x-urls": [{ "path": "/_ingest/pipeline/{id}", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.0.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. If 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": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "if_version": { "type": "number", "description": "Required version for optimistic concurrency control for pipeline updates", "x-found-in": "query" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.", "x-found-in": "body" }, "description": { "type": "string", "description": "Description of the ingest pipeline.", "x-found-in": "body" }, "on_failure": { "type": "array", "items": { "$ref": "./ingest._types.json#/$defs/ingest._types__ProcessorContainer" }, "description": "Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors.", "x-found-in": "body" }, "processors": { "type": "array", "items": { "$ref": "./ingest._types.json#/$defs/ingest._types__ProcessorContainer" }, "description": "Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.", "x-found-in": "body" }, "version": { "type": "number", "description": "Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers.", "x-found-in": "body" }, "deprecated": { "type": "boolean", "description": "Marks this ingest pipeline as deprecated.\nWhen a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.", "x-found-in": "body" }, "field_access_pattern": { "$ref": "./ingest._types.json#/$defs/ingest._types__FieldAccessPattern", "description": "Controls how processors in this pipeline should read and write data on a document's source.", "x-found-in": "body", "x-availability": { "stack": { "since": "9.2.0" }, "serverless": {} } }, "id": { "type": "string", "description": "ID of the ingest pipeline 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": ["id"] }

package/lib/cjs/es/json/ingest.simulate.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.simulate", "description": "Simulate a pipeline.\n\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", "x-api": { "id": "ingest.simulate", "name": "simulate", "namespace": "ingest" }, "x-method": "GET", "x-path": "/_ingest/pipeline/{id}/_simulate", "x-urls": [{ "path": "/_ingest/pipeline/_simulate", "methods": ["GET", "POST"] }, { "path": "/_ingest/pipeline/{id}/_simulate", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "verbose": { "type": "boolean", "description": "If `true`, the response includes output data for each processor in the executed pipeline.", "x-found-in": "query" }, "docs": { "type": "array", "items": { "$ref": "./ingest._types.json#/$defs/ingest._types__Document" }, "description": "Sample documents to test in the pipeline.", "x-found-in": "body" }, "pipeline": { "$ref": "./ingest._types.json#/$defs/ingest._types__Pipeline", "description": "The pipeline to test.\nIf you don't specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", "x-found-in": "body" }, "id": { "type": "string", "description": "The pipeline to test.\nIf you don't specify a `pipeline` in the request body, this parameter is required.", "x-found-in": "path" } }, "required": ["docs"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.simulate", "description": "Simulate a pipeline.\n\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", "x-api": { "id": "ingest.simulate", "name": "simulate", "namespace": "ingest" }, "x-method": "GET", "x-path": "/_ingest/pipeline/{id}/_simulate", "x-urls": [{ "path": "/_ingest/pipeline/_simulate", "methods": ["GET", "POST"] }, { "path": "/_ingest/pipeline/{id}/_simulate", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "verbose": { "type": "boolean", "description": "If `true`, the response includes output data for each processor in the executed pipeline.", "x-found-in": "query" }, "docs": { "type": "array", "items": { "$ref": "./ingest._types.json#/$defs/ingest._types__Document" }, "description": "Sample documents to test in the pipeline.", "x-found-in": "body" }, "pipeline": { "$ref": "./ingest._types.json#/$defs/ingest._types__Pipeline", "description": "The pipeline to test.\nIf you don't specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", "x-found-in": "body" }, "id": { "type": "string", "description": "The pipeline to test.\nIf you don't specify a `pipeline` in the request body, this parameter is required.", "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": ["docs"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "license.delete", "description": "Delete the license.\n\nWhen the license expires, your subscription level reverts to Basic.\n\nIf the operator privileges feature is enabled, only operator users can use this API.", "x-api": { "id": "license.delete", "name": "delete", "namespace": "license" }, "x-method": "DELETE", "x-path": "/_license", "x-urls": [{ "path": "/_license", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "license.delete", "description": "Delete the license.\n\nWhen the license expires, your subscription level reverts to Basic.\n\nIf the operator privileges feature is enabled, only operator users can use this API.", "x-api": { "id": "license.delete", "name": "delete", "namespace": "license" }, "x-method": "DELETE", "x-path": "/_license", "x-urls": [{ "path": "/_license", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "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/license.get.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "license.get", "description": "Get license information.\n\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\n>info\n> If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\n> If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", "x-api": { "id": "license.get", "name": "get", "namespace": "license" }, "x-method": "GET", "x-path": "/_license", "x-urls": [{ "path": "/_license", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "accept_enterprise": { "type": "boolean", "description": "If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility.\nThis parameter is deprecated and will always be set to true in 8.x.", "x-found-in": "query", "x-deprecated": { "since": "7.6.0" } }, "local": { "type": "boolean", "description": "Specifies whether to retrieve local information.\nFrom 9.2 onwards the default value is `true`, which means the information is retrieved from the responding node.\nIn earlier versions the default is `false`, which means the information is retrieved from the elected master node.", "x-found-in": "query" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "license.get", "description": "Get license information.\n\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\n>info\n> If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\n> If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", "x-api": { "id": "license.get", "name": "get", "namespace": "license" }, "x-method": "GET", "x-path": "/_license", "x-urls": [{ "path": "/_license", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "accept_enterprise": { "type": "boolean", "description": "If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility.\nThis parameter is deprecated and will always be set to true in 8.x.", "x-found-in": "query", "x-deprecated": { "since": "7.6.0" } }, "local": { "type": "boolean", "description": "Specifies whether to retrieve local information.\nFrom 9.2 onwards the default value is `true`, which means the information is retrieved from the responding node.\nIn earlier versions the default is `false`, which means the information is retrieved from the elected 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/license.get_basic_status.request.json

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

package/lib/cjs/es/json/license.get_trial_status.request.json

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

package/lib/cjs/es/json/license.post.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "license.post", "description": "Update the license.\n\nYou can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API.", "x-api": { "id": "license.post", "name": "post", "namespace": "license" }, "x-method": "PUT", "x-path": "/_license", "x-urls": [{ "path": "/_license", "methods": ["PUT", "POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": { "acknowledge": { "type": "boolean", "description": "To update a license, you must accept the acknowledge messages and set this parameter to `true`.\nIn particular, if you are upgrading or downgrading a license, you must acknowlege the feature changes.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "license": { "$ref": "./license._types.json#/$defs/license._types__License", "x-found-in": "body" }, "licenses": { "type": "array", "items": { "$ref": "./license._types.json#/$defs/license._types__License" }, "description": "A sequence of one or more JSON documents containing the license information.", "x-found-in": "body" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "license.post", "description": "Update the license.\n\nYou can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API.", "x-api": { "id": "license.post", "name": "post", "namespace": "license" }, "x-method": "PUT", "x-path": "/_license", "x-urls": [{ "path": "/_license", "methods": ["PUT", "POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": { "acknowledge": { "type": "boolean", "description": "To update a license, you must accept the acknowledge messages and set this parameter to `true`.\nIn particular, if you are upgrading or downgrading a license, you must acknowlege the feature changes.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "license": { "$ref": "./license._types.json#/$defs/license._types__License", "x-found-in": "body" }, "licenses": { "type": "array", "items": { "$ref": "./license._types.json#/$defs/license._types__License" }, "description": "A sequence of one or more JSON documents containing the license information.", "x-found-in": "body" }, "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/license.post_start_basic.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "license.post_start_basic", "description": "Start a basic license.\n\nStart an indefinite basic license, which gives access to all the basic features.\n\nNOTE: In order to start a basic license, you must not currently have a basic license.\n\nIf the basic license does not support all of the features that are available with your current license, however, you are notified in the response.\nYou must then re-submit the API request with the `acknowledge` parameter set to `true`.\n\nTo check the status of your basic license, use the get basic license API.", "x-api": { "id": "license.post_start_basic", "name": "post-start-basic", "namespace": "license" }, "x-method": "POST", "x-path": "/_license/start_basic", "x-urls": [{ "path": "/_license/start_basic", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.3.0", "stability": "stable" } }, "type": "object", "properties": { "acknowledge": { "type": "boolean", "description": "To start a basic license, you must accept the acknowledge messages and set this parameter to `true`.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "license.post_start_basic", "description": "Start a basic license.\n\nStart an indefinite basic license, which gives access to all the basic features.\n\nNOTE: In order to start a basic license, you must not currently have a basic license.\n\nIf the basic license does not support all of the features that are available with your current license, however, you are notified in the response.\nYou must then re-submit the API request with the `acknowledge` parameter set to `true`.\n\nTo check the status of your basic license, use the get basic license API.", "x-api": { "id": "license.post_start_basic", "name": "post-start-basic", "namespace": "license" }, "x-method": "POST", "x-path": "/_license/start_basic", "x-urls": [{ "path": "/_license/start_basic", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.3.0", "stability": "stable" } }, "type": "object", "properties": { "acknowledge": { "type": "boolean", "description": "To start a basic license, you must accept the acknowledge messages and set this parameter to `true`.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "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/license.post_start_trial.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "license.post_start_trial", "description": "Start a trial.\n\nStart a 30-day trial, which gives access to all subscription features.\n\nNOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version.\nFor example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension.\n\nTo check the status of your trial, use the get trial status API.", "x-api": { "id": "license.post_start_trial", "name": "post-start-trial", "namespace": "license" }, "x-method": "POST", "x-path": "/_license/start_trial", "x-urls": [{ "path": "/_license/start_trial", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.1.0", "stability": "stable" } }, "type": "object", "properties": { "acknowledge": { "type": "boolean", "description": "To start a trial, you must accept the acknowledge messages and set this parameter to `true`.", "x-found-in": "query" }, "type": { "type": "string", "description": "The type of trial license to generate", "x-found-in": "query" }, "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": "license.post_start_trial", "description": "Start a trial.\n\nStart a 30-day trial, which gives access to all subscription features.\n\nNOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version.\nFor example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension.\n\nTo check the status of your trial, use the get trial status API.", "x-api": { "id": "license.post_start_trial", "name": "post-start-trial", "namespace": "license" }, "x-method": "POST", "x-path": "/_license/start_trial", "x-urls": [{ "path": "/_license/start_trial", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.1.0", "stability": "stable" } }, "type": "object", "properties": { "acknowledge": { "type": "boolean", "description": "To start a trial, you must accept the acknowledge messages and set this parameter to `true`.", "x-found-in": "query" }, "type": { "type": "string", "description": "The type of trial license to generate", "x-found-in": "query" }, "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/list_reindex.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "list_reindex", "description": "Get information about all currently running reindex tasks.\n\nReindex tasks that are mid-relocation between nodes are reported once,\nunder their original task ID, so callers do not see duplicates across the relocation chain.\n\nIf the API returns a HTTP status of `200 OK`, but `node_failures` or `task_failures` are non-empty in the body, the listing is not a complete authoritative listing and may be missing tasks.", "x-api": { "id": "list_reindex", "name": "list-reindex", "namespace": null }, "x-method": "GET", "x-path": "/_reindex", "x-urls": [{ "path": "/_reindex", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.5.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "detailed": { "type": "boolean", "description": "If `true`, include detailed task status information in the response.", "x-found-in": "query" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "list_reindex", "description": "Get information about all currently running reindex tasks.\n\nReindex tasks that are mid-relocation between nodes are reported once,\nunder their original task ID, so callers do not see duplicates across the relocation chain.\n\nIf the API returns a HTTP status of `200 OK`, but `node_failures` or `task_failures` are non-empty in the body, the listing is not a complete authoritative listing and may be missing tasks.", "x-api": { "id": "list_reindex", "name": "list-reindex", "namespace": null }, "x-method": "GET", "x-path": "/_reindex", "x-urls": [{ "path": "/_reindex", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.5.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "detailed": { "type": "boolean", "description": "If `true`, include detailed task status information in the response.", "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/logstash.delete_pipeline.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "logstash.delete_pipeline", "description": "Delete a Logstash pipeline.\n\nDelete a pipeline that is used for Logstash Central Management.\nIf the request succeeds, you receive an empty response with an appropriate status code.", "x-api": { "id": "logstash.delete_pipeline", "name": "delete-pipeline", "namespace": "logstash" }, "x-method": "DELETE", "x-path": "/_logstash/pipeline/{id}", "x-urls": [{ "path": "/_logstash/pipeline/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.12.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "An identifier for the pipeline.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "logstash.delete_pipeline", "description": "Delete a Logstash pipeline.\n\nDelete a pipeline that is used for Logstash Central Management.\nIf the request succeeds, you receive an empty response with an appropriate status code.", "x-api": { "id": "logstash.delete_pipeline", "name": "delete-pipeline", "namespace": "logstash" }, "x-method": "DELETE", "x-path": "/_logstash/pipeline/{id}", "x-urls": [{ "path": "/_logstash/pipeline/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.12.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "An identifier for the pipeline.", "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/logstash.get_pipeline.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "logstash.get_pipeline", "description": "Get Logstash pipelines.\n\nGet pipelines that are used for Logstash Central Management.", "x-api": { "id": "logstash.get_pipeline", "name": "get-pipeline", "namespace": "logstash" }, "x-method": "GET", "x-path": "/_logstash/pipeline/{id}", "x-urls": [{ "path": "/_logstash/pipeline", "methods": ["GET"] }, { "path": "/_logstash/pipeline/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.12.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "A comma-separated list of pipeline identifiers.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "logstash.get_pipeline", "description": "Get Logstash pipelines.\n\nGet pipelines that are used for Logstash Central Management.", "x-api": { "id": "logstash.get_pipeline", "name": "get-pipeline", "namespace": "logstash" }, "x-method": "GET", "x-path": "/_logstash/pipeline/{id}", "x-urls": [{ "path": "/_logstash/pipeline", "methods": ["GET"] }, { "path": "/_logstash/pipeline/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.12.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "A comma-separated list of pipeline identifiers.", "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/logstash.put_pipeline.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "logstash.put_pipeline", "description": "Create or update a Logstash pipeline.\n\nCreate a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", "x-api": { "id": "logstash.put_pipeline", "name": "put-pipeline", "namespace": "logstash" }, "x-method": "PUT", "x-path": "/_logstash/pipeline/{id}", "x-urls": [{ "path": "/_logstash/pipeline/{id}", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.12.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "pipeline": { "$ref": "./logstash._types.json#/$defs/logstash._types__Pipeline", "x-found-in": "body", "x-body-root": true }, "id": { "type": "string", "description": "An identifier for the pipeline.\nPipeline IDs must begin with a letter or underscore and contain only letters, underscores, dashes, hyphens and numbers.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "logstash.put_pipeline", "description": "Create or update a Logstash pipeline.\n\nCreate a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", "x-api": { "id": "logstash.put_pipeline", "name": "put-pipeline", "namespace": "logstash" }, "x-method": "PUT", "x-path": "/_logstash/pipeline/{id}", "x-urls": [{ "path": "/_logstash/pipeline/{id}", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.12.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "pipeline": { "$ref": "./logstash._types.json#/$defs/logstash._types__Pipeline", "x-found-in": "body", "x-body-root": true }, "id": { "type": "string", "description": "An identifier for the pipeline.\nPipeline IDs must begin with a letter or underscore and contain only letters, underscores, dashes, hyphens and numbers.", "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/mget.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "mget", "description": "Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.\n\n**Filter source fields**\n\nBy default, the `_source` field is returned for every document (if stored).\nUse the `_source` and `_source_include` or `source_exclude` attributes to filter what fields are returned for a particular document.\nYou can include the `_source`, `_source_includes`, and `_source_excludes` query parameters in the request URI to specify the defaults to use when there are no per-document instructions.\n\n**Get stored fields**\n\nUse the `stored_fields` attribute to specify the set of stored fields you want to retrieve.\nAny requested fields that are not stored are ignored.\nYou can include the `stored_fields` query parameter in the request URI to specify the defaults to use when there are no per-document instructions.", "x-api": { "id": "mget", "name": "mget", "namespace": null }, "x-method": "GET", "x-path": "/{index}/_mget", "x-urls": [{ "path": "/_mget", "methods": ["GET", "POST"] }, { "path": "/{index}/_mget", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "1.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "preference": { "type": "string", "description": "Specifies the node or shard the operation should be performed on. Random by default.", "x-found-in": "query" }, "realtime": { "type": "boolean", "description": "If `true`, the request is real-time as opposed to near-real-time.", "x-found-in": "query" }, "refresh": { "type": "boolean", "description": "If `true`, the request refreshes relevant shards before retrieving documents.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "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.", "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. You 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": "If `true`, retrieves the document fields stored in the index rather than the document `_source`.", "x-found-in": "query" }, "docs": { "type": "array", "items": { "$ref": "./_global.mget.json#/$defs/_global.mget__Operation" }, "description": "The documents you want to retrieve. Required if no index is specified in the request URI.", "x-found-in": "body" }, "ids": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.", "x-found-in": "body" }, "index": { "type": "string", "description": "Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "mget", "description": "Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.\n\n**Filter source fields**\n\nBy default, the `_source` field is returned for every document (if stored).\nUse the `_source` and `_source_include` or `source_exclude` attributes to filter what fields are returned for a particular document.\nYou can include the `_source`, `_source_includes`, and `_source_excludes` query parameters in the request URI to specify the defaults to use when there are no per-document instructions.\n\n**Get stored fields**\n\nUse the `stored_fields` attribute to specify the set of stored fields you want to retrieve.\nAny requested fields that are not stored are ignored.\nYou can include the `stored_fields` query parameter in the request URI to specify the defaults to use when there are no per-document instructions.", "x-api": { "id": "mget", "name": "mget", "namespace": null }, "x-method": "GET", "x-path": "/{index}/_mget", "x-urls": [{ "path": "/_mget", "methods": ["GET", "POST"] }, { "path": "/{index}/_mget", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "1.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "preference": { "type": "string", "description": "Specifies the node or shard the operation should be performed on. Random by default.", "x-found-in": "query" }, "realtime": { "type": "boolean", "description": "If `true`, the request is real-time as opposed to near-real-time.", "x-found-in": "query" }, "refresh": { "type": "boolean", "description": "If `true`, the request refreshes relevant shards before retrieving documents.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "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.", "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. You 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": "If `true`, retrieves the document fields stored in the index rather than the document `_source`.", "x-found-in": "query" }, "docs": { "type": "array", "items": { "$ref": "./_global.mget.json#/$defs/_global.mget__Operation" }, "description": "The documents you want to retrieve. Required if no index is specified in the request URI.", "x-found-in": "body" }, "ids": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.", "x-found-in": "body" }, "index": { "type": "string", "description": "Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/migration.deprecations.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "migration.deprecations", "description": "Get deprecation information.\n\nReturns information about deprecated features which are in use in the cluster.\nThe reported features include cluster, node, and index level settings that will be removed or changed in the next major version.\nYou must address the reported issues before upgrading to the next major version.\nHowever, no action is required when upgrading within the current major version.\nDeprecated features remain fully supported and will continue to work in the current version, and when upgrading to a newer minor or patch release in the same major version.\nUse this API to review your usage of these features and migrate away from them at your own pace, before upgrading to a new major version.\n\n> info\n> This API is designed for indirect use by the [Upgrade Assistant](https://www.elastic.co/docs/deploy-manage/upgrade/prepare-to-upgrade/upgrade-assistant).\n> We recommend learning about deprecated features using the Upgrade Assistant rather than calling this API directly.", "x-api": { "id": "migration.deprecations", "name": "deprecations", "namespace": "migration" }, "x-method": "GET", "x-path": "/{index}/_migration/deprecations", "x-urls": [{ "path": "/_migration/deprecations", "methods": ["GET"] }, { "path": "/{index}/_migration/deprecations", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.1.0", "stability": "stable" } }, "type": "object", "properties": { "index": { "type": "string", "description": "Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "migration.deprecations", "description": "Get deprecation information.\n\nReturns information about deprecated features which are in use in the cluster.\nThe reported features include cluster, node, and index level settings that will be removed or changed in the next major version.\nYou must address the reported issues before upgrading to the next major version.\nHowever, no action is required when upgrading within the current major version.\nDeprecated features remain fully supported and will continue to work in the current version, and when upgrading to a newer minor or patch release in the same major version.\nUse this API to review your usage of these features and migrate away from them at your own pace, before upgrading to a new major version.\n\n> info\n> This API is designed for indirect use by the [Upgrade Assistant](https://www.elastic.co/docs/deploy-manage/upgrade/prepare-to-upgrade/upgrade-assistant).\n> We recommend learning about deprecated features using the Upgrade Assistant rather than calling this API directly.", "x-api": { "id": "migration.deprecations", "name": "deprecations", "namespace": "migration" }, "x-method": "GET", "x-path": "/{index}/_migration/deprecations", "x-urls": [{ "path": "/_migration/deprecations", "methods": ["GET"] }, { "path": "/{index}/_migration/deprecations", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.1.0", "stability": "stable" } }, "type": "object", "properties": { "index": { "type": "string", "description": "Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported.", "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/migration.get_feature_upgrade_status.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "migration.get_feature_upgrade_status", "description": "Get feature migration information.\n\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nYou are strongly recommended to use the Upgrade Assistant.", "x-api": { "id": "migration.get_feature_upgrade_status", "name": "get-feature-upgrade-status", "namespace": "migration" }, "x-method": "GET", "x-path": "/_migration/system_features", "x-urls": [{ "path": "/_migration/system_features", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.16.0", "stability": "stable" } }, "type": "object", "properties": {} }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "migration.get_feature_upgrade_status", "description": "Get feature migration information.\n\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nYou are strongly recommended to use the Upgrade Assistant.", "x-api": { "id": "migration.get_feature_upgrade_status", "name": "get-feature-upgrade-status", "namespace": "migration" }, "x-method": "GET", "x-path": "/_migration/system_features", "x-urls": [{ "path": "/_migration/system_features", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.16.0", "stability": "stable" } }, "type": "object", "properties": { "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/migration.post_feature_upgrade.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "migration.post_feature_upgrade", "description": "Start the feature migration.\n\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nThis API starts the automatic migration process.\n\nSome functionality might be temporarily unavailable during the migration process.\n\nTIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", "x-api": { "id": "migration.post_feature_upgrade", "name": "post-feature-upgrade", "namespace": "migration" }, "x-method": "POST", "x-path": "/_migration/system_features", "x-urls": [{ "path": "/_migration/system_features", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.16.0", "stability": "stable" } }, "type": "object", "properties": {} }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "migration.post_feature_upgrade", "description": "Start the feature migration.\n\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nThis API starts the automatic migration process.\n\nSome functionality might be temporarily unavailable during the migration process.\n\nTIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", "x-api": { "id": "migration.post_feature_upgrade", "name": "post-feature-upgrade", "namespace": "migration" }, "x-method": "POST", "x-path": "/_migration/system_features", "x-urls": [{ "path": "/_migration/system_features", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.16.0", "stability": "stable" } }, "type": "object", "properties": { "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/ml.clear_trained_model_deployment_cache.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.clear_trained_model_deployment_cache", "description": "Clear trained model deployment cache.\n\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", "x-api": { "id": "ml.clear_trained_model_deployment_cache", "name": "clear-trained-model-deployment-cache", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/trained_models/{model_id}/deployment/cache/_clear", "x-urls": [{ "path": "/_ml/trained_models/{model_id}/deployment/cache/_clear", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "model_id": { "type": "string", "description": "The unique identifier of the trained model.", "x-found-in": "path" } }, "required": ["model_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.clear_trained_model_deployment_cache", "description": "Clear trained model deployment cache.\n\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", "x-api": { "id": "ml.clear_trained_model_deployment_cache", "name": "clear-trained-model-deployment-cache", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/trained_models/{model_id}/deployment/cache/_clear", "x-urls": [{ "path": "/_ml/trained_models/{model_id}/deployment/cache/_clear", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "model_id": { "type": "string", "description": "The unique identifier of the trained model.", "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": ["model_id"] }

package/lib/cjs/es/json/ml.close_job.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.close_job", "description": "Close anomaly detection jobs.\n\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", "x-api": { "id": "ml.close_job", "name": "close-job", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/anomaly_detectors/{job_id}/_close", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/_close", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Refer to the description for the `allow_no_match` query parameter.", "x-found-in": "body" }, "force": { "type": "boolean", "description": "Refer to the descriptiion for the `force` query parameter.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `timeout` query parameter.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can close all jobs by using `_all` or by specifying `*` as the job identifier.", "x-found-in": "path" } }, "required": ["job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.close_job", "description": "Close anomaly detection jobs.\n\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", "x-api": { "id": "ml.close_job", "name": "close-job", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/anomaly_detectors/{job_id}/_close", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/_close", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Refer to the description for the `allow_no_match` query parameter.", "x-found-in": "body" }, "force": { "type": "boolean", "description": "Refer to the descriptiion for the `force` query parameter.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `timeout` query parameter.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can close all jobs by using `_all` or by specifying `*` as the job identifier.", "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": ["job_id"] }

package/lib/cjs/es/json/ml.delete_calendar.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_calendar", "description": "Delete a calendar.\n\nRemove all scheduled events from a calendar, then delete it.", "x-api": { "id": "ml.delete_calendar", "name": "delete-calendar", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/calendars/{calendar_id}", "x-urls": [{ "path": "/_ml/calendars/{calendar_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "calendar_id": { "type": "string", "description": "A string that uniquely identifies a calendar.", "x-found-in": "path" } }, "required": ["calendar_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_calendar", "description": "Delete a calendar.\n\nRemove all scheduled events from a calendar, then delete it.", "x-api": { "id": "ml.delete_calendar", "name": "delete-calendar", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/calendars/{calendar_id}", "x-urls": [{ "path": "/_ml/calendars/{calendar_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "calendar_id": { "type": "string", "description": "A string that uniquely identifies a calendar.", "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": ["calendar_id"] }

package/lib/cjs/es/json/ml.delete_calendar_event.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_calendar_event", "description": "Delete events from a calendar.", "x-api": { "id": "ml.delete_calendar_event", "name": "delete-calendar-event", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/calendars/{calendar_id}/events/{event_id}", "x-urls": [{ "path": "/_ml/calendars/{calendar_id}/events/{event_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "calendar_id": { "type": "string", "description": "A string that uniquely identifies a calendar.", "x-found-in": "path" }, "event_id": { "type": "string", "description": "Identifier for the scheduled event.\nYou can obtain this identifier by using the get calendar events API.", "x-found-in": "path" } }, "required": ["calendar_id", "event_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_calendar_event", "description": "Delete events from a calendar.", "x-api": { "id": "ml.delete_calendar_event", "name": "delete-calendar-event", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/calendars/{calendar_id}/events/{event_id}", "x-urls": [{ "path": "/_ml/calendars/{calendar_id}/events/{event_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "calendar_id": { "type": "string", "description": "A string that uniquely identifies a calendar.", "x-found-in": "path" }, "event_id": { "type": "string", "description": "Identifier for the scheduled event.\nYou can obtain this identifier by using the get calendar events API.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["calendar_id", "event_id"] }

package/lib/cjs/es/json/ml.delete_calendar_job.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_calendar_job", "description": "Delete anomaly jobs from a calendar.", "x-api": { "id": "ml.delete_calendar_job", "name": "delete-calendar-job", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/calendars/{calendar_id}/jobs/{job_id}", "x-urls": [{ "path": "/_ml/calendars/{calendar_id}/jobs/{job_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "calendar_id": { "type": "string", "description": "A string that uniquely identifies a calendar.", "x-found-in": "path" }, "job_id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a\ncomma-separated list of jobs or groups.", "x-found-in": "path" } }, "required": ["calendar_id", "job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_calendar_job", "description": "Delete anomaly jobs from a calendar.", "x-api": { "id": "ml.delete_calendar_job", "name": "delete-calendar-job", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/calendars/{calendar_id}/jobs/{job_id}", "x-urls": [{ "path": "/_ml/calendars/{calendar_id}/jobs/{job_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "calendar_id": { "type": "string", "description": "A string that uniquely identifies a calendar.", "x-found-in": "path" }, "job_id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a\ncomma-separated list of jobs or groups.", "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": ["calendar_id", "job_id"] }

package/lib/cjs/es/json/ml.delete_data_frame_analytics.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_data_frame_analytics", "description": "Delete a data frame analytics job.", "x-api": { "id": "ml.delete_data_frame_analytics", "name": "delete-data-frame-analytics", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/data_frame/analytics/{id}", "x-urls": [{ "path": "/_ml/data_frame/analytics/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "force": { "type": "boolean", "description": "If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The time to wait for the job to be deleted.", "x-found-in": "query" }, "id": { "type": "string", "description": "Identifier for the data frame analytics job.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_data_frame_analytics", "description": "Delete a data frame analytics job.", "x-api": { "id": "ml.delete_data_frame_analytics", "name": "delete-data-frame-analytics", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/data_frame/analytics/{id}", "x-urls": [{ "path": "/_ml/data_frame/analytics/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "force": { "type": "boolean", "description": "If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The time to wait for the job to be deleted.", "x-found-in": "query" }, "id": { "type": "string", "description": "Identifier for the data frame analytics job.", "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/ml.delete_datafeed.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_datafeed", "description": "Delete a datafeed.", "x-api": { "id": "ml.delete_datafeed", "name": "delete-datafeed", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/datafeeds/{datafeed_id}", "x-urls": [{ "path": "/_ml/datafeeds/{datafeed_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "force": { "type": "boolean", "description": "Use to forcefully delete a started datafeed; this method is quicker than\nstopping and deleting the datafeed.", "x-found-in": "query" }, "datafeed_id": { "type": "string", "description": "A numerical character string that uniquely identifies the datafeed. This\nidentifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It must start and end with alphanumeric\ncharacters.", "x-found-in": "path" } }, "required": ["datafeed_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_datafeed", "description": "Delete a datafeed.", "x-api": { "id": "ml.delete_datafeed", "name": "delete-datafeed", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/datafeeds/{datafeed_id}", "x-urls": [{ "path": "/_ml/datafeeds/{datafeed_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "force": { "type": "boolean", "description": "Use to forcefully delete a started datafeed; this method is quicker than\nstopping and deleting the datafeed.", "x-found-in": "query" }, "datafeed_id": { "type": "string", "description": "A numerical character string that uniquely identifies the datafeed. This\nidentifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It must start and end with alphanumeric\ncharacters.", "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": ["datafeed_id"] }

package/lib/cjs/es/json/ml.delete_expired_data.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_expired_data", "description": "Delete expired ML data.\n\nDelete all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using `_all`, by specifying `*` as the `<job_id>`, or by omitting the\n`<job_id>`.", "x-api": { "id": "ml.delete_expired_data", "name": "delete-expired-data", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/_delete_expired_data/{job_id}", "x-urls": [{ "path": "/_ml/_delete_expired_data/{job_id}", "methods": ["DELETE"] }, { "path": "/_ml/_delete_expired_data", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "requests_per_second": { "type": "number", "description": "The desired requests per second for the deletion processes. The default\nbehavior is no throttling.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "How long can the underlying delete processes run until they are canceled.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for an anomaly detection job. It can be a job identifier, a\ngroup name, or a wildcard expression.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_expired_data", "description": "Delete expired ML data.\n\nDelete all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using `_all`, by specifying `*` as the `<job_id>`, or by omitting the\n`<job_id>`.", "x-api": { "id": "ml.delete_expired_data", "name": "delete-expired-data", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/_delete_expired_data/{job_id}", "x-urls": [{ "path": "/_ml/_delete_expired_data/{job_id}", "methods": ["DELETE"] }, { "path": "/_ml/_delete_expired_data", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "requests_per_second": { "type": "number", "description": "The desired requests per second for the deletion processes. The default\nbehavior is no throttling.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "How long can the underlying delete processes run until they are canceled.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for an anomaly detection job. It can be a job identifier, a\ngroup name, or a wildcard expression.", "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/ml.delete_filter.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_filter", "description": "Delete a filter.\n\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", "x-api": { "id": "ml.delete_filter", "name": "delete-filter", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/filters/{filter_id}", "x-urls": [{ "path": "/_ml/filters/{filter_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "filter_id": { "type": "string", "description": "A string that uniquely identifies a filter.", "x-found-in": "path" } }, "required": ["filter_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_filter", "description": "Delete a filter.\n\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", "x-api": { "id": "ml.delete_filter", "name": "delete-filter", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/filters/{filter_id}", "x-urls": [{ "path": "/_ml/filters/{filter_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "filter_id": { "type": "string", "description": "A string that uniquely identifies a filter.", "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": ["filter_id"] }

package/lib/cjs/es/json/ml.delete_forecast.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_forecast", "description": "Delete forecasts from a job.\n\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", "x-api": { "id": "ml.delete_forecast", "name": "delete-forecast", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id}", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/_forecast", "methods": ["DELETE"] }, { "path": "/_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "allow_no_forecasts": { "type": "boolean", "description": "Specifies whether an error occurs when there are no forecasts. In\nparticular, if this parameter is set to `false` and there are no\nforecasts associated with the job, attempts to delete all forecasts\nreturn an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the period of time to wait for the completion of the delete\noperation. When this period of time elapses, the API fails and returns an\nerror.", "x-found-in": "query" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "forecast_id": { "type": "string", "description": "A comma-separated list of forecast identifiers. If you do not specify\nthis optional parameter or if you specify `_all` or `*` the API deletes\nall forecasts from the job.", "x-found-in": "path" } }, "required": ["job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_forecast", "description": "Delete forecasts from a job.\n\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", "x-api": { "id": "ml.delete_forecast", "name": "delete-forecast", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id}", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/_forecast", "methods": ["DELETE"] }, { "path": "/_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "allow_no_forecasts": { "type": "boolean", "description": "Specifies whether an error occurs when there are no forecasts. In\nparticular, if this parameter is set to `false` and there are no\nforecasts associated with the job, attempts to delete all forecasts\nreturn an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the period of time to wait for the completion of the delete\noperation. When this period of time elapses, the API fails and returns an\nerror.", "x-found-in": "query" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "forecast_id": { "type": "string", "description": "A comma-separated list of forecast identifiers. If you do not specify\nthis optional parameter or if you specify `_all` or `*` the API deletes\nall forecasts from the job.", "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": ["job_id"] }

package/lib/cjs/es/json/ml.delete_job.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_job", "description": "Delete an anomaly detection job.\n\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", "x-api": { "id": "ml.delete_job", "name": "delete-job", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/anomaly_detectors/{job_id}", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "force": { "type": "boolean", "description": "Use to forcefully delete an opened job; this method is quicker than\nclosing and deleting the job.", "x-found-in": "query" }, "delete_user_annotations": { "type": "boolean", "description": "Specifies whether annotations that have been added by the\nuser should be deleted along with any auto-generated annotations when the job is\nreset.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "Specifies whether the request should return immediately or wait until the\njob deletion completes.", "x-found-in": "query" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" } }, "required": ["job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_job", "description": "Delete an anomaly detection job.\n\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", "x-api": { "id": "ml.delete_job", "name": "delete-job", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/anomaly_detectors/{job_id}", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "force": { "type": "boolean", "description": "Use to forcefully delete an opened job; this method is quicker than\nclosing and deleting the job.", "x-found-in": "query" }, "delete_user_annotations": { "type": "boolean", "description": "Specifies whether annotations that have been added by the\nuser should be deleted along with any auto-generated annotations when the job is\nreset.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "Specifies whether the request should return immediately or wait until the\njob deletion completes.", "x-found-in": "query" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "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": ["job_id"] }

package/lib/cjs/es/json/ml.delete_model_snapshot.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_model_snapshot", "description": "Delete a model snapshot.\n\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", "x-api": { "id": "ml.delete_model_snapshot", "name": "delete-model-snapshot", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "snapshot_id": { "type": "string", "description": "Identifier for the model snapshot.", "x-found-in": "path" } }, "required": ["job_id", "snapshot_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_model_snapshot", "description": "Delete a model snapshot.\n\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", "x-api": { "id": "ml.delete_model_snapshot", "name": "delete-model-snapshot", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "snapshot_id": { "type": "string", "description": "Identifier for the model snapshot.", "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": ["job_id", "snapshot_id"] }

package/lib/cjs/es/json/ml.delete_trained_model.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_trained_model", "description": "Delete an unreferenced trained model.\n\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", "x-api": { "id": "ml.delete_trained_model", "name": "delete-trained-model", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/trained_models/{model_id}", "x-urls": [{ "path": "/_ml/trained_models/{model_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.10.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "force": { "type": "boolean", "description": "Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "model_id": { "type": "string", "description": "The unique identifier of the trained model.", "x-found-in": "path" } }, "required": ["model_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_trained_model", "description": "Delete an unreferenced trained model.\n\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", "x-api": { "id": "ml.delete_trained_model", "name": "delete-trained-model", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/trained_models/{model_id}", "x-urls": [{ "path": "/_ml/trained_models/{model_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.10.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "force": { "type": "boolean", "description": "Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "model_id": { "type": "string", "description": "The unique identifier of the trained model.", "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": ["model_id"] }

package/lib/cjs/es/json/ml.delete_trained_model_alias.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_trained_model_alias", "description": "Delete a trained model alias.\n\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", "x-api": { "id": "ml.delete_trained_model_alias", "name": "delete-trained-model-alias", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/trained_models/{model_id}/model_aliases/{model_alias}", "x-urls": [{ "path": "/_ml/trained_models/{model_id}/model_aliases/{model_alias}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.13.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "model_alias": { "type": "string", "description": "The model alias to delete.", "x-found-in": "path" }, "model_id": { "type": "string", "description": "The trained model ID to which the model alias refers.", "x-found-in": "path" } }, "required": ["model_alias", "model_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_trained_model_alias", "description": "Delete a trained model alias.\n\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", "x-api": { "id": "ml.delete_trained_model_alias", "name": "delete-trained-model-alias", "namespace": "ml" }, "x-method": "DELETE", "x-path": "/_ml/trained_models/{model_id}/model_aliases/{model_alias}", "x-urls": [{ "path": "/_ml/trained_models/{model_id}/model_aliases/{model_alias}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.13.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "model_alias": { "type": "string", "description": "The model alias to delete.", "x-found-in": "path" }, "model_id": { "type": "string", "description": "The trained model ID to which the model alias refers.", "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": ["model_alias", "model_id"] }

package/lib/cjs/es/json/ml.estimate_model_memory.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.estimate_model_memory", "description": "Estimate job model memory usage.\n\nMake an estimation of the memory usage for an anomaly detection job model.\nThe estimate is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", "x-api": { "id": "ml.estimate_model_memory", "name": "estimate-model-memory", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/anomaly_detectors/_estimate_model_memory", "x-urls": [{ "path": "/_ml/anomaly_detectors/_estimate_model_memory", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.7.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "analysis_config": { "$ref": "./ml._types.json#/$defs/ml._types__AnalysisConfig", "description": "For a list of the properties that you can specify in the\n`analysis_config` component of the body of this API.", "x-found-in": "body" }, "max_bucket_cardinality": { "type": "object", "additionalProperties": { "type": "number" }, "description": "Estimates of the highest cardinality in a single bucket that is observed\nfor influencer fields over the time period that the job analyzes data.\nTo produce a good answer, values must be provided for all influencer\nfields. Providing values for fields that are not listed as `influencers`\nhas no effect on the estimation.", "x-found-in": "body" }, "overall_cardinality": { "type": "object", "additionalProperties": { "type": "number" }, "description": "Estimates of the cardinality that is observed for fields over the whole\ntime period that the job analyzes data. To produce a good answer, values\nmust be provided for fields referenced in the `by_field_name`,\n`over_field_name` and `partition_field_name` of any detectors. Providing\nvalues for other fields has no effect on the estimation. It can be\nomitted from the request if no detectors have a `by_field_name`,\n`over_field_name` or `partition_field_name`.", "x-found-in": "body" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.estimate_model_memory", "description": "Estimate job model memory usage.\n\nMake an estimation of the memory usage for an anomaly detection job model.\nThe estimate is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", "x-api": { "id": "ml.estimate_model_memory", "name": "estimate-model-memory", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/anomaly_detectors/_estimate_model_memory", "x-urls": [{ "path": "/_ml/anomaly_detectors/_estimate_model_memory", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.7.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "analysis_config": { "$ref": "./ml._types.json#/$defs/ml._types__AnalysisConfig", "description": "For a list of the properties that you can specify in the\n`analysis_config` component of the body of this API.", "x-found-in": "body" }, "max_bucket_cardinality": { "type": "object", "additionalProperties": { "type": "number" }, "description": "Estimates of the highest cardinality in a single bucket that is observed\nfor influencer fields over the time period that the job analyzes data.\nTo produce a good answer, values must be provided for all influencer\nfields. Providing values for fields that are not listed as `influencers`\nhas no effect on the estimation.", "x-found-in": "body" }, "overall_cardinality": { "type": "object", "additionalProperties": { "type": "number" }, "description": "Estimates of the cardinality that is observed for fields over the whole\ntime period that the job analyzes data. To produce a good answer, values\nmust be provided for fields referenced in the `by_field_name`,\n`over_field_name` and `partition_field_name` of any detectors. Providing\nvalues for other fields has no effect on the estimation. It can be\nomitted from the request if no detectors have a `by_field_name`,\n`over_field_name` or `partition_field_name`.", "x-found-in": "body" }, "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" } } }