@elastic/schemas 0.5.1 → 0.6.0

package/src/es/json/ml.put_trained_model_definition_part.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.put_trained_model_definition_part","description":"Create part of a trained model definition.","x-api":{"id":"ml.put_trained_model_definition_part","name":"put-trained-model-definition-part","namespace":"ml"},"x-method":"PUT","x-path":"/_ml/trained_models/{model_id}/definition/{part}","x-urls":[{"path":"/_ml/trained_models/{model_id}/definition/{part}","methods":["PUT"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"definition":{"type":"string","description":"The definition part for the model. Must be a base64 encoded string.","x-found-in":"body"},"total_definition_length":{"type":"number","description":"The total uncompressed definition length in bytes. Not base64 encoded.","x-found-in":"body"},"total_parts":{"type":"number","description":"The total number of parts that will be uploaded. Must be greater than 0.","x-found-in":"body"},"model_id":{"type":"string","description":"The unique identifier of the trained model.","x-found-in":"path"},"part":{"type":"number","description":"The definition part number. When the definition is loaded for inference the definition parts are streamed in the\norder of their part number. The first part must be `0` and the final part must be `total_parts - 1`.","x-found-in":"path"}},"required":["model_id","part","definition","total_definition_length","total_parts"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.put_trained_model_definition_part","description":"Create part of a trained model definition.","x-api":{"id":"ml.put_trained_model_definition_part","name":"put-trained-model-definition-part","namespace":"ml"},"x-method":"PUT","x-path":"/_ml/trained_models/{model_id}/definition/{part}","x-urls":[{"path":"/_ml/trained_models/{model_id}/definition/{part}","methods":["PUT"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"definition":{"type":"string","description":"The definition part for the model. Must be a base64 encoded string.","x-found-in":"body"},"total_definition_length":{"type":"number","description":"The total uncompressed definition length in bytes. Not base64 encoded.","x-found-in":"body"},"total_parts":{"type":"number","description":"The total number of parts that will be uploaded. Must be greater than 0.","x-found-in":"body"},"model_id":{"type":"string","description":"The unique identifier of the trained model.","x-found-in":"path"},"part":{"type":"number","description":"The definition part number. When the definition is loaded for inference the definition parts are streamed in the\norder of their part number. The first part must be `0` and the final part must be `total_parts - 1`.","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","part","definition","total_definition_length","total_parts"]}

package/src/es/json/ml.put_trained_model_vocabulary.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.put_trained_model_vocabulary","description":"Create a trained model vocabulary.\n\nThis API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.","x-api":{"id":"ml.put_trained_model_vocabulary","name":"put-trained-model-vocabulary","namespace":"ml"},"x-method":"PUT","x-path":"/_ml/trained_models/{model_id}/vocabulary","x-urls":[{"path":"/_ml/trained_models/{model_id}/vocabulary","methods":["PUT"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"vocabulary":{"type":"array","items":{"type":"string"},"description":"The model vocabulary, which must not be empty.","x-found-in":"body"},"merges":{"type":"array","items":{"type":"string"},"description":"The optional model merges if required by the tokenizer.","x-found-in":"body","x-availability":{"stack":{"since":"8.2.0"},"serverless":{}}},"scores":{"type":"array","items":{"type":"number"},"description":"The optional vocabulary value scores if required by the tokenizer.","x-found-in":"body","x-availability":{"stack":{"since":"8.9.0"},"serverless":{}}},"model_id":{"type":"string","description":"The unique identifier of the trained model.","x-found-in":"path"}},"required":["model_id","vocabulary"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.put_trained_model_vocabulary","description":"Create a trained model vocabulary.\n\nThis API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.","x-api":{"id":"ml.put_trained_model_vocabulary","name":"put-trained-model-vocabulary","namespace":"ml"},"x-method":"PUT","x-path":"/_ml/trained_models/{model_id}/vocabulary","x-urls":[{"path":"/_ml/trained_models/{model_id}/vocabulary","methods":["PUT"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"vocabulary":{"type":"array","items":{"type":"string"},"description":"The model vocabulary, which must not be empty.","x-found-in":"body"},"merges":{"type":"array","items":{"type":"string"},"description":"The optional model merges if required by the tokenizer.","x-found-in":"body","x-availability":{"stack":{"since":"8.2.0"},"serverless":{}}},"scores":{"type":"array","items":{"type":"number"},"description":"The optional vocabulary value scores if required by the tokenizer.","x-found-in":"body","x-availability":{"stack":{"since":"8.9.0"},"serverless":{}}},"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","vocabulary"]}

package/src/es/json/ml.reset_job.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.reset_job","description":"Reset an anomaly detection job.\n\nAll model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.","x-api":{"id":"ml.reset_job","name":"reset-job","namespace":"ml"},"x-method":"POST","x-path":"/_ml/anomaly_detectors/{job_id}/_reset","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}/_reset","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.14.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"wait_for_completion":{"type":"boolean","description":"Should this request wait until the operation has completed before\nreturning.","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"},"job_id":{"type":"string","description":"The ID of the job to reset.","x-found-in":"path"}},"required":["job_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.reset_job","description":"Reset an anomaly detection job.\n\nAll model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.","x-api":{"id":"ml.reset_job","name":"reset-job","namespace":"ml"},"x-method":"POST","x-path":"/_ml/anomaly_detectors/{job_id}/_reset","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}/_reset","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.14.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"wait_for_completion":{"type":"boolean","description":"Should this request wait until the operation has completed before\nreturning.","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"},"job_id":{"type":"string","description":"The ID of the job to reset.","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/src/es/json/ml.revert_model_snapshot.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.revert_model_snapshot","description":"Revert to a snapshot.\n\nThe machine learning features react quickly to anomalous input, learning new\nbehaviors in data. Highly anomalous input increases the variance in the\nmodels whilst the system learns whether this is a new step-change in behavior\nor a one-off event. In the case where this anomalous input is known to be a\none-off, then it might be appropriate to reset the model state to a time\nbefore this event. For example, you might consider reverting to a saved\nsnapshot after Black Friday or a critical system failure.","x-api":{"id":"ml.revert_model_snapshot","name":"revert-model-snapshot","namespace":"ml"},"x-method":"POST","x-path":"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"delete_intervening_results":{"type":"boolean","description":"Refer to the description for the `delete_intervening_results` query parameter.","x-found-in":"body"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"snapshot_id":{"type":"string","description":"You can specify `empty` as the <snapshot_id>. Reverting to the empty\nsnapshot means the anomaly detection job starts learning a new model from\nscratch when it is started.","x-found-in":"path"}},"required":["job_id","snapshot_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.revert_model_snapshot","description":"Revert to a snapshot.\n\nThe machine learning features react quickly to anomalous input, learning new\nbehaviors in data. Highly anomalous input increases the variance in the\nmodels whilst the system learns whether this is a new step-change in behavior\nor a one-off event. In the case where this anomalous input is known to be a\none-off, then it might be appropriate to reset the model state to a time\nbefore this event. For example, you might consider reverting to a saved\nsnapshot after Black Friday or a critical system failure.","x-api":{"id":"ml.revert_model_snapshot","name":"revert-model-snapshot","namespace":"ml"},"x-method":"POST","x-path":"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"delete_intervening_results":{"type":"boolean","description":"Refer to the description for the `delete_intervening_results` query parameter.","x-found-in":"body"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"snapshot_id":{"type":"string","description":"You can specify `empty` as the <snapshot_id>. Reverting to the empty\nsnapshot means the anomaly detection job starts learning a new model from\nscratch when it is started.","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/src/es/json/ml.set_upgrade_mode.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.set_upgrade_mode","description":"Set upgrade_mode for ML indices.\n\nSets a cluster wide upgrade_mode setting that prepares machine learning\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your machine learning indices. In those circumstances,\nthere must be no machine learning jobs running. You can close the machine\nlearning jobs, do the upgrade, then open all the jobs again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the jobs and\ndatafeeds and prevent new jobs from opening. You can also use this API\nduring upgrades that do not require you to reindex your machine learning\nindices, though stopping jobs is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\nmachine learning info API.","x-api":{"id":"ml.set_upgrade_mode","name":"set-upgrade-mode","namespace":"ml"},"x-method":"POST","x-path":"/_ml/set_upgrade_mode","x-urls":[{"path":"/_ml/set_upgrade_mode","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.7.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"enabled":{"type":"boolean","description":"When `true`, it enables `upgrade_mode` which temporarily halts all job\nand datafeed tasks and prohibits new job and datafeed tasks from\nstarting.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time to wait for the request to be completed.","x-found-in":"query"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.set_upgrade_mode","description":"Set upgrade_mode for ML indices.\n\nSets a cluster wide upgrade_mode setting that prepares machine learning\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your machine learning indices. In those circumstances,\nthere must be no machine learning jobs running. You can close the machine\nlearning jobs, do the upgrade, then open all the jobs again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the jobs and\ndatafeeds and prevent new jobs from opening. You can also use this API\nduring upgrades that do not require you to reindex your machine learning\nindices, though stopping jobs is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\nmachine learning info API.","x-api":{"id":"ml.set_upgrade_mode","name":"set-upgrade-mode","namespace":"ml"},"x-method":"POST","x-path":"/_ml/set_upgrade_mode","x-urls":[{"path":"/_ml/set_upgrade_mode","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.7.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"enabled":{"type":"boolean","description":"When `true`, it enables `upgrade_mode` which temporarily halts all job\nand datafeed tasks and prohibits new job and datafeed tasks from\nstarting.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time to wait for the request to be completed.","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/src/es/json/ml.start_data_frame_analytics.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.start_data_frame_analytics","description":"Start a data frame analytics job.\n\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.","x-api":{"id":"ml.start_data_frame_analytics","name":"start-data-frame-analytics","namespace":"ml"},"x-method":"POST","x-path":"/_ml/data_frame/analytics/{id}/_start","x-urls":[{"path":"/_ml/data_frame/analytics/{id}/_start","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.3.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Controls the amount of time to wait until the data frame analytics job\nstarts.","x-found-in":"body"},"id":{"type":"string","description":"Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.","x-found-in":"path"}},"required":["id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.start_data_frame_analytics","description":"Start a data frame analytics job.\n\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.","x-api":{"id":"ml.start_data_frame_analytics","name":"start-data-frame-analytics","namespace":"ml"},"x-method":"POST","x-path":"/_ml/data_frame/analytics/{id}/_start","x-urls":[{"path":"/_ml/data_frame/analytics/{id}/_start","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.3.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Controls the amount of time to wait until the data frame analytics job\nstarts.","x-found-in":"body"},"id":{"type":"string","description":"Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.","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/src/es/json/ml.start_datafeed.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.start_datafeed","description":"Start datafeeds.\n\nA datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.","x-api":{"id":"ml.start_datafeed","name":"start-datafeed","namespace":"ml"},"x-method":"POST","x-path":"/_ml/datafeeds/{datafeed_id}/_start","x-urls":[{"path":"/_ml/datafeeds/{datafeed_id}/_start","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"end":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Refer to the description for the `end` query parameter.","x-found-in":"body"},"start":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Refer to the description for the `start` 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"},"datafeed_id":{"type":"string","description":"A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase\nalphanumeric characters (a-z and 0-9), hyphens, 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.start_datafeed","description":"Start datafeeds.\n\nA datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.","x-api":{"id":"ml.start_datafeed","name":"start-datafeed","namespace":"ml"},"x-method":"POST","x-path":"/_ml/datafeeds/{datafeed_id}/_start","x-urls":[{"path":"/_ml/datafeeds/{datafeed_id}/_start","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"end":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Refer to the description for the `end` query parameter.","x-found-in":"body"},"start":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Refer to the description for the `start` 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"},"datafeed_id":{"type":"string","description":"A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase\nalphanumeric characters (a-z and 0-9), hyphens, 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/src/es/json/ml.start_trained_model_deployment.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.start_trained_model_deployment","description":"Start a trained model deployment.\n\nIt allocates the model to every machine learning node.","x-api":{"id":"ml.start_trained_model_deployment","name":"start-trained-model-deployment","namespace":"ml"},"x-method":"POST","x-path":"/_ml/trained_models/{model_id}/deployment/_start","x-urls":[{"path":"/_ml/trained_models/{model_id}/deployment/_start","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"cache_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The inference cache size (in memory outside the JVM heap) per node for the model.\nThe default value is the same size as the `model_size_bytes`. To disable the cache,\n`0b` can be provided.","x-found-in":"query"},"deployment_id":{"type":"string","description":"A unique identifier for the deployment of the model.","x-found-in":"query","x-availability":{"stack":{"since":"8.8.0"}}},"number_of_allocations":{"type":"number","description":"The number of model allocations on each node where the model is deployed.\nAll allocations on a node share the same copy of the model in memory but use\na separate set of threads to evaluate the model.\nIncreasing this value generally increases the throughput.\nIf this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.\nIf adaptive_allocations is enabled, do not set this value, because it’s automatically set.","x-found-in":"query"},"priority":{"$ref":"./ml._types.json#/$defs/ml._types__TrainingPriority","description":"The deployment priority","x-found-in":"query"},"queue_capacity":{"type":"number","description":"Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds\nthis value, new requests are rejected with a 429 error.","x-found-in":"query"},"threads_per_allocation":{"type":"number","description":"Sets the number of threads used by each model allocation during inference. This generally increases\nthe inference speed. The inference process is a compute-bound process; any number\ngreater than the number of available hardware threads on the machine does not increase the\ninference speed. If this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the model to deploy.","x-found-in":"query"},"wait_for":{"$ref":"./ml._types.json#/$defs/ml._types__DeploymentAllocationState","description":"Specifies the allocation status to wait for before returning.","x-found-in":"query"},"adaptive_allocations":{"$ref":"./ml._types.json#/$defs/ml._types__AdaptiveAllocationsSettings","description":"Adaptive allocations configuration. When enabled, the number of allocations\nis set based on the current load.\nIf adaptive_allocations is enabled, do not set the number of allocations manually.","x-found-in":"body"},"model_id":{"type":"string","description":"The unique identifier of the trained model. Currently, only PyTorch models are supported.","x-found-in":"path"}},"required":["model_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.start_trained_model_deployment","description":"Start a trained model deployment.\n\nIt allocates the model to every machine learning node.","x-api":{"id":"ml.start_trained_model_deployment","name":"start-trained-model-deployment","namespace":"ml"},"x-method":"POST","x-path":"/_ml/trained_models/{model_id}/deployment/_start","x-urls":[{"path":"/_ml/trained_models/{model_id}/deployment/_start","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"cache_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The inference cache size (in memory outside the JVM heap) per node for the model.\nThe default value is the same size as the `model_size_bytes`. To disable the cache,\n`0b` can be provided.","x-found-in":"query"},"deployment_id":{"type":"string","description":"A unique identifier for the deployment of the model.","x-found-in":"query","x-availability":{"stack":{"since":"8.8.0"}}},"number_of_allocations":{"type":"number","description":"The number of model allocations on each node where the model is deployed.\nAll allocations on a node share the same copy of the model in memory but use\na separate set of threads to evaluate the model.\nIncreasing this value generally increases the throughput.\nIf this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.\nIf adaptive_allocations is enabled, do not set this value, because it’s automatically set.","x-found-in":"query"},"priority":{"$ref":"./ml._types.json#/$defs/ml._types__TrainingPriority","description":"The deployment priority","x-found-in":"query"},"queue_capacity":{"type":"number","description":"Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds\nthis value, new requests are rejected with a 429 error.","x-found-in":"query"},"threads_per_allocation":{"type":"number","description":"Sets the number of threads used by each model allocation during inference. This generally increases\nthe inference speed. The inference process is a compute-bound process; any number\ngreater than the number of available hardware threads on the machine does not increase the\ninference speed. If this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the model to deploy.","x-found-in":"query"},"wait_for":{"$ref":"./ml._types.json#/$defs/ml._types__DeploymentAllocationState","description":"Specifies the allocation status to wait for before returning.","x-found-in":"query"},"adaptive_allocations":{"$ref":"./ml._types.json#/$defs/ml._types__AdaptiveAllocationsSettings","description":"Adaptive allocations configuration. When enabled, the number of allocations\nis set based on the current load.\nIf adaptive_allocations is enabled, do not set the number of allocations manually.","x-found-in":"body"},"model_id":{"type":"string","description":"The unique identifier of the trained model. Currently, only PyTorch models 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"}},"required":["model_id"]}

package/src/es/json/ml.stop_data_frame_analytics.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.stop_data_frame_analytics","description":"Stop data frame analytics jobs.\n\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.","x-api":{"id":"ml.stop_data_frame_analytics","name":"stop-data-frame-analytics","namespace":"ml"},"x-method":"POST","x-path":"/_ml/data_frame/analytics/{id}/_stop","x-urls":[{"path":"/_ml/data_frame/analytics/{id}/_stop","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.3.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no data frame analytics\njobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is true, which returns an empty data_frame_analytics\narray when there are no matches and the subset of results when there are\npartial matches. If this parameter is false, the request returns a 404\nstatus code when there are no matches or only partial matches.","x-found-in":"body"},"force":{"type":"boolean","description":"If true, the data frame analytics job is stopped forcefully.","x-found-in":"body"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Controls the amount of time to wait until the data frame analytics job\nstops. Defaults to 20 seconds.","x-found-in":"body"},"id":{"type":"string","description":"Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.","x-found-in":"path"}},"required":["id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.stop_data_frame_analytics","description":"Stop data frame analytics jobs.\n\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.","x-api":{"id":"ml.stop_data_frame_analytics","name":"stop-data-frame-analytics","namespace":"ml"},"x-method":"POST","x-path":"/_ml/data_frame/analytics/{id}/_stop","x-urls":[{"path":"/_ml/data_frame/analytics/{id}/_stop","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.3.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no data frame analytics\njobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is true, which returns an empty data_frame_analytics\narray when there are no matches and the subset of results when there are\npartial matches. If this parameter is false, the request returns a 404\nstatus code when there are no matches or only partial matches.","x-found-in":"body"},"force":{"type":"boolean","description":"If true, the data frame analytics job is stopped forcefully.","x-found-in":"body"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Controls the amount of time to wait until the data frame analytics job\nstops. Defaults to 20 seconds.","x-found-in":"body"},"id":{"type":"string","description":"Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.","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/src/es/json/ml.stop_datafeed.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.stop_datafeed","description":"Stop datafeeds.\n\nA datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.","x-api":{"id":"ml.stop_datafeed","name":"stop-datafeed","namespace":"ml"},"x-method":"POST","x-path":"/_ml/datafeeds/{datafeed_id}/_stop","x-urls":[{"path":"/_ml/datafeeds/{datafeed_id}/_stop","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 description 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"},"close_job":{"type":"boolean","description":"Refer to the description for the `close_job` query parameter.","x-found-in":"body"},"datafeed_id":{"type":"string","description":"Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated\nlist of datafeeds or a wildcard expression. You can close all datafeeds by using `_all` or by specifying `*` as\nthe identifier.","x-found-in":"path"}},"required":["datafeed_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.stop_datafeed","description":"Stop datafeeds.\n\nA datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.","x-api":{"id":"ml.stop_datafeed","name":"stop-datafeed","namespace":"ml"},"x-method":"POST","x-path":"/_ml/datafeeds/{datafeed_id}/_stop","x-urls":[{"path":"/_ml/datafeeds/{datafeed_id}/_stop","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 description 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"},"close_job":{"type":"boolean","description":"Refer to the description for the `close_job` query parameter.","x-found-in":"body"},"datafeed_id":{"type":"string","description":"Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated\nlist of datafeeds or a wildcard expression. You can close all datafeeds by using `_all` or by specifying `*` as\nthe 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":["datafeed_id"]}

package/src/es/json/ml.stop_trained_model_deployment.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.stop_trained_model_deployment","description":"Stop a trained model deployment.","x-api":{"id":"ml.stop_trained_model_deployment","name":"stop-trained-model-deployment","namespace":"ml"},"x-method":"POST","x-path":"/_ml/trained_models/{model_id}/deployment/_stop","x-urls":[{"path":"/_ml/trained_models/{model_id}/deployment/_stop","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request: contains wildcard expressions and there are no deployments that match;\ncontains the  `_all` string or no identifiers and there are no matches; or contains wildcard expressions and\nthere are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the request returns a 404 status code when there are no matches or only partial matches.","x-found-in":"body"},"force":{"type":"boolean","description":"Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you\nrestart the model deployment.","x-found-in":"body"},"id":{"type":"string","description":"If provided, must be the same identifier as in the path.","x-found-in":"body"},"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.stop_trained_model_deployment","description":"Stop a trained model deployment.","x-api":{"id":"ml.stop_trained_model_deployment","name":"stop-trained-model-deployment","namespace":"ml"},"x-method":"POST","x-path":"/_ml/trained_models/{model_id}/deployment/_stop","x-urls":[{"path":"/_ml/trained_models/{model_id}/deployment/_stop","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request: contains wildcard expressions and there are no deployments that match;\ncontains the  `_all` string or no identifiers and there are no matches; or contains wildcard expressions and\nthere are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the request returns a 404 status code when there are no matches or only partial matches.","x-found-in":"body"},"force":{"type":"boolean","description":"Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you\nrestart the model deployment.","x-found-in":"body"},"id":{"type":"string","description":"If provided, must be the same identifier as in the path.","x-found-in":"body"},"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/src/es/json/ml.update_data_frame_analytics.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.update_data_frame_analytics","description":"Update a data frame analytics job.","x-api":{"id":"ml.update_data_frame_analytics","name":"update-data-frame-analytics","namespace":"ml"},"x-method":"POST","x-path":"/_ml/data_frame/analytics/{id}/_update","x-urls":[{"path":"/_ml/data_frame/analytics/{id}/_update","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.3.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"description":{"type":"string","description":"A description of the job.","x-found-in":"body"},"model_memory_limit":{"type":"string","description":"The approximate maximum amount of memory resources that are permitted for\nanalytical processing. If your `elasticsearch.yml` file contains an\n`xpack.ml.max_model_memory_limit` setting, an error occurs when you try\nto create data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.","x-found-in":"body"},"max_num_threads":{"type":"number","description":"The maximum number of threads to be used by the analysis. Using more\nthreads may decrease the time necessary to complete the analysis at the\ncost of using more CPU. Note that the process may use additional threads\nfor operational functionality other than the analysis itself.","x-found-in":"body"},"allow_lazy_start":{"type":"boolean","description":"Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.","x-found-in":"body"},"id":{"type":"string","description":"Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.","x-found-in":"path"}},"required":["id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.update_data_frame_analytics","description":"Update a data frame analytics job.","x-api":{"id":"ml.update_data_frame_analytics","name":"update-data-frame-analytics","namespace":"ml"},"x-method":"POST","x-path":"/_ml/data_frame/analytics/{id}/_update","x-urls":[{"path":"/_ml/data_frame/analytics/{id}/_update","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.3.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"description":{"type":"string","description":"A description of the job.","x-found-in":"body"},"model_memory_limit":{"type":"string","description":"The approximate maximum amount of memory resources that are permitted for\nanalytical processing. If your `elasticsearch.yml` file contains an\n`xpack.ml.max_model_memory_limit` setting, an error occurs when you try\nto create data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.","x-found-in":"body"},"max_num_threads":{"type":"number","description":"The maximum number of threads to be used by the analysis. Using more\nthreads may decrease the time necessary to complete the analysis at the\ncost of using more CPU. Note that the process may use additional threads\nfor operational functionality other than the analysis itself.","x-found-in":"body"},"allow_lazy_start":{"type":"boolean","description":"Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.","x-found-in":"body"},"id":{"type":"string","description":"Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.","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/src/es/json/ml.update_datafeed.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.update_datafeed","description":"Update a datafeed.\n\nYou must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.","x-api":{"id":"ml.update_datafeed","name":"update-datafeed","namespace":"ml"},"x-method":"POST","x-path":"/_ml/datafeeds/{datafeed_id}/_update","x-urls":[{"path":"/_ml/datafeeds/{datafeed_id}/_update","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard patterns can match. If the request can target data streams, this argument determines\nwhether wildcard expressions match hidden data streams. Supports comma-separated values.","x-found-in":"query"},"ignore_throttled":{"type":"boolean","description":"If `true`, concrete, expanded or aliased indices are ignored when frozen.","x-found-in":"query","x-deprecated":{"since":"7.16.0"}},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"description":"If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only\nwith low cardinality data.","x-found-in":"body"},"chunking_config":{"$ref":"./ml._types.json#/$defs/ml._types__ChunkingConfig","description":"Datafeeds might search over long time periods, for several months or years. This search is split into time\nchunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of\nthese time chunks are calculated; it is an advanced configuration option.","x-found-in":"body"},"delayed_data_check_config":{"$ref":"./ml._types.json#/$defs/ml._types__DelayedDataCheckConfig","description":"Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally\nsearch over indices that have already been read in an effort to determine whether any data has subsequently been\nadded to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and\nthe data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time\ndatafeeds.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval at which scheduled queries are made while the datafeed runs in real time. The default value is\neither the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket\nspan. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are\nwritten then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value\nmust be divisible by the interval of the date histogram aggregation.","x-found-in":"body"},"indices":{"type":"array","items":{"type":"string"},"description":"An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine\nlearning nodes must have the `remote_cluster_client` role.","x-found-in":"body"},"indices_options":{"$ref":"./_types.json#/$defs/_types__IndicesOptions","description":"Specifies index expansion options that are used during search.","x-found-in":"body"},"job_id":{"type":"string","x-found-in":"body"},"max_empty_searches":{"type":"number","description":"If a real-time datafeed has never seen any data (including during any initial training period), it automatically\nstops and closes the associated job after this many real-time searches return no documents. In other words,\nit stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no\nend time that sees no data remains started until it is explicitly stopped. By default, it is not set.","x-found-in":"body"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an\nElasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this\nobject is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also\nchanged. Therefore, the time required to learn might be long and the understandability of the results is\nunpredictable. If you want to make significant changes to the source data, it is recommended that you\nclone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one\nwhen you are satisfied with the results of the job.","x-found-in":"body"},"query_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might\nnot be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default\nvalue is randomly selected between `60s` and `120s`. This randomness improves the query performance\nwhen there are multiple jobs running on the same node.","x-found-in":"body"},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"Specifies runtime fields for the datafeed search.","x-found-in":"body"},"script_fields":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ScriptField"},"description":"Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.\nThe detector configuration objects in a job can contain functions that use these script fields.","x-found-in":"body"},"scroll_size":{"type":"number","description":"The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.\nThe maximum value is the value of `index.max_result_window`.","x-found-in":"body"},"datafeed_id":{"type":"string","description":"A numerical character string that uniquely identifies the datafeed.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.","x-found-in":"path"}},"required":["datafeed_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.update_datafeed","description":"Update a datafeed.\n\nYou must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.","x-api":{"id":"ml.update_datafeed","name":"update-datafeed","namespace":"ml"},"x-method":"POST","x-path":"/_ml/datafeeds/{datafeed_id}/_update","x-urls":[{"path":"/_ml/datafeeds/{datafeed_id}/_update","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard patterns can match. If the request can target data streams, this argument determines\nwhether wildcard expressions match hidden data streams. Supports comma-separated values.","x-found-in":"query"},"ignore_throttled":{"type":"boolean","description":"If `true`, concrete, expanded or aliased indices are ignored when frozen.","x-found-in":"query","x-deprecated":{"since":"7.16.0"}},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"description":"If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only\nwith low cardinality data.","x-found-in":"body"},"chunking_config":{"$ref":"./ml._types.json#/$defs/ml._types__ChunkingConfig","description":"Datafeeds might search over long time periods, for several months or years. This search is split into time\nchunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of\nthese time chunks are calculated; it is an advanced configuration option.","x-found-in":"body"},"delayed_data_check_config":{"$ref":"./ml._types.json#/$defs/ml._types__DelayedDataCheckConfig","description":"Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally\nsearch over indices that have already been read in an effort to determine whether any data has subsequently been\nadded to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and\nthe data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time\ndatafeeds.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval at which scheduled queries are made while the datafeed runs in real time. The default value is\neither the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket\nspan. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are\nwritten then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value\nmust be divisible by the interval of the date histogram aggregation.","x-found-in":"body"},"indices":{"type":"array","items":{"type":"string"},"description":"An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine\nlearning nodes must have the `remote_cluster_client` role.","x-found-in":"body"},"indices_options":{"$ref":"./_types.json#/$defs/_types__IndicesOptions","description":"Specifies index expansion options that are used during search.","x-found-in":"body"},"job_id":{"type":"string","x-found-in":"body"},"max_empty_searches":{"type":"number","description":"If a real-time datafeed has never seen any data (including during any initial training period), it automatically\nstops and closes the associated job after this many real-time searches return no documents. In other words,\nit stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no\nend time that sees no data remains started until it is explicitly stopped. By default, it is not set.","x-found-in":"body"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an\nElasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this\nobject is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also\nchanged. Therefore, the time required to learn might be long and the understandability of the results is\nunpredictable. If you want to make significant changes to the source data, it is recommended that you\nclone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one\nwhen you are satisfied with the results of the job.","x-found-in":"body"},"query_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might\nnot be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default\nvalue is randomly selected between `60s` and `120s`. This randomness improves the query performance\nwhen there are multiple jobs running on the same node.","x-found-in":"body"},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"Specifies runtime fields for the datafeed search.","x-found-in":"body"},"script_fields":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ScriptField"},"description":"Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.\nThe detector configuration objects in a job can contain functions that use these script fields.","x-found-in":"body"},"scroll_size":{"type":"number","description":"The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.\nThe maximum value is the value of `index.max_result_window`.","x-found-in":"body"},"datafeed_id":{"type":"string","description":"A numerical character string that uniquely identifies the datafeed.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.","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/src/es/json/ml.update_filter.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.update_filter","description":"Update a filter.\n\nUpdates the description of a filter, adds items, or removes items from the list.","x-api":{"id":"ml.update_filter","name":"update-filter","namespace":"ml"},"x-method":"POST","x-path":"/_ml/filters/{filter_id}/_update","x-urls":[{"path":"/_ml/filters/{filter_id}/_update","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"add_items":{"type":"array","items":{"type":"string"},"description":"The items to add to the filter.","x-found-in":"body"},"description":{"type":"string","description":"A description for the filter.","x-found-in":"body"},"remove_items":{"type":"array","items":{"type":"string"},"description":"The items to remove from the filter.","x-found-in":"body"},"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.update_filter","description":"Update a filter.\n\nUpdates the description of a filter, adds items, or removes items from the list.","x-api":{"id":"ml.update_filter","name":"update-filter","namespace":"ml"},"x-method":"POST","x-path":"/_ml/filters/{filter_id}/_update","x-urls":[{"path":"/_ml/filters/{filter_id}/_update","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"add_items":{"type":"array","items":{"type":"string"},"description":"The items to add to the filter.","x-found-in":"body"},"description":{"type":"string","description":"A description for the filter.","x-found-in":"body"},"remove_items":{"type":"array","items":{"type":"string"},"description":"The items to remove from the filter.","x-found-in":"body"},"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/src/es/json/ml.update_job.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.update_job","description":"Update an anomaly detection job.\n\nUpdates certain properties of an anomaly detection job.","x-api":{"id":"ml.update_job","name":"update-job","namespace":"ml"},"x-method":"POST","x-path":"/_ml/anomaly_detectors/{job_id}/_update","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}/_update","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_lazy_open":{"type":"boolean","description":"Advanced configuration option. Specifies whether this job can open when\nthere is insufficient machine learning node capacity for it to be\nimmediately assigned to a node. If `false` and a machine learning node\nwith capacity to run the job cannot immediately be found, the open\nanomaly detection jobs API returns an error. However, this is also\nsubject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this\noption is set to `true`, the open anomaly detection jobs API does not\nreturn an error and the job waits in the opening state until sufficient\nmachine learning node capacity is available.","x-found-in":"body"},"analysis_limits":{"$ref":"./ml._types.json#/$defs/ml._types__AnalysisMemoryLimit","x-found-in":"body"},"background_persist_interval":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Advanced configuration option. The time between each periodic persistence\nof the model.\nThe default value is a randomized value between 3 to 4 hours, which\navoids all jobs persisting at exactly the same time. The smallest allowed\nvalue is 1 hour.\nFor very large models (several GB), persistence could take 10-20 minutes,\nso do not set the value too low.\nIf the job is open when you make the update, you must stop the datafeed,\nclose the job, then reopen the job and restart the datafeed for the\nchanges to take effect.","x-found-in":"body"},"custom_settings":{"type":"object","additionalProperties":{},"description":"Advanced configuration option. Contains custom meta data about the job.\nFor example, it can contain custom URL information as shown in Adding\ncustom URLs to machine learning results.","x-found-in":"body"},"categorization_filters":{"type":"array","items":{"type":"string"},"x-found-in":"body"},"description":{"type":"string","description":"A description of the job.","x-found-in":"body"},"model_plot_config":{"$ref":"./ml._types.json#/$defs/ml._types__ModelPlotConfig","x-found-in":"body"},"model_prune_window":{"$ref":"./_types.json#/$defs/_types__Duration","x-found-in":"body"},"daily_model_snapshot_retention_after_days":{"type":"number","description":"Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies a period of time (in days)\nafter which only the first snapshot per day is retained. This period is\nrelative to the timestamp of the most recent snapshot for this job. Valid\nvalues range from 0 to `model_snapshot_retention_days`. For jobs created\nbefore version 7.8.0, the default value matches\n`model_snapshot_retention_days`.","x-found-in":"body"},"model_snapshot_retention_days":{"type":"number","description":"Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies the maximum period of time (in\ndays) that snapshots are retained. This period is relative to the\ntimestamp of the most recent snapshot for this job.","x-found-in":"body"},"renormalization_window_days":{"type":"number","description":"Advanced configuration option. The period over which adjustments to the\nscore are applied, as new data is seen.","x-found-in":"body"},"results_retention_days":{"type":"number","description":"Advanced configuration option. The period of time (in days) that results\nare retained. Age is calculated relative to the timestamp of the latest\nbucket result. If this property has a non-null value, once per day at\n00:30 (server time), results that are the specified number of days older\nthan the latest bucket result are deleted from Elasticsearch. The default\nvalue is null, which means all results are retained.","x-found-in":"body"},"groups":{"type":"array","items":{"type":"string"},"description":"A list of job groups. A job can belong to no groups or many.","x-found-in":"body"},"detectors":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__DetectorUpdate"},"description":"An array of detector update objects.","x-found-in":"body"},"per_partition_categorization":{"$ref":"./ml._types.json#/$defs/ml._types__PerPartitionCategorization","description":"Settings related to how categorization interacts with partition fields.","x-found-in":"body"},"job_id":{"type":"string","description":"Identifier for the job.","x-found-in":"path"}},"required":["job_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.update_job","description":"Update an anomaly detection job.\n\nUpdates certain properties of an anomaly detection job.","x-api":{"id":"ml.update_job","name":"update-job","namespace":"ml"},"x-method":"POST","x-path":"/_ml/anomaly_detectors/{job_id}/_update","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}/_update","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_lazy_open":{"type":"boolean","description":"Advanced configuration option. Specifies whether this job can open when\nthere is insufficient machine learning node capacity for it to be\nimmediately assigned to a node. If `false` and a machine learning node\nwith capacity to run the job cannot immediately be found, the open\nanomaly detection jobs API returns an error. However, this is also\nsubject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this\noption is set to `true`, the open anomaly detection jobs API does not\nreturn an error and the job waits in the opening state until sufficient\nmachine learning node capacity is available.","x-found-in":"body"},"analysis_limits":{"$ref":"./ml._types.json#/$defs/ml._types__AnalysisMemoryLimit","x-found-in":"body"},"background_persist_interval":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Advanced configuration option. The time between each periodic persistence\nof the model.\nThe default value is a randomized value between 3 to 4 hours, which\navoids all jobs persisting at exactly the same time. The smallest allowed\nvalue is 1 hour.\nFor very large models (several GB), persistence could take 10-20 minutes,\nso do not set the value too low.\nIf the job is open when you make the update, you must stop the datafeed,\nclose the job, then reopen the job and restart the datafeed for the\nchanges to take effect.","x-found-in":"body"},"custom_settings":{"type":"object","additionalProperties":{},"description":"Advanced configuration option. Contains custom meta data about the job.\nFor example, it can contain custom URL information as shown in Adding\ncustom URLs to machine learning results.","x-found-in":"body"},"categorization_filters":{"type":"array","items":{"type":"string"},"x-found-in":"body"},"description":{"type":"string","description":"A description of the job.","x-found-in":"body"},"model_plot_config":{"$ref":"./ml._types.json#/$defs/ml._types__ModelPlotConfig","x-found-in":"body"},"model_prune_window":{"$ref":"./_types.json#/$defs/_types__Duration","x-found-in":"body"},"daily_model_snapshot_retention_after_days":{"type":"number","description":"Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies a period of time (in days)\nafter which only the first snapshot per day is retained. This period is\nrelative to the timestamp of the most recent snapshot for this job. Valid\nvalues range from 0 to `model_snapshot_retention_days`. For jobs created\nbefore version 7.8.0, the default value matches\n`model_snapshot_retention_days`.","x-found-in":"body"},"model_snapshot_retention_days":{"type":"number","description":"Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies the maximum period of time (in\ndays) that snapshots are retained. This period is relative to the\ntimestamp of the most recent snapshot for this job.","x-found-in":"body"},"renormalization_window_days":{"type":"number","description":"Advanced configuration option. The period over which adjustments to the\nscore are applied, as new data is seen.","x-found-in":"body"},"results_retention_days":{"type":"number","description":"Advanced configuration option. The period of time (in days) that results\nare retained. Age is calculated relative to the timestamp of the latest\nbucket result. If this property has a non-null value, once per day at\n00:30 (server time), results that are the specified number of days older\nthan the latest bucket result are deleted from Elasticsearch. The default\nvalue is null, which means all results are retained.","x-found-in":"body"},"groups":{"type":"array","items":{"type":"string"},"description":"A list of job groups. A job can belong to no groups or many.","x-found-in":"body"},"detectors":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__DetectorUpdate"},"description":"An array of detector update objects.","x-found-in":"body"},"per_partition_categorization":{"$ref":"./ml._types.json#/$defs/ml._types__PerPartitionCategorization","description":"Settings related to how categorization interacts with partition fields.","x-found-in":"body"},"job_id":{"type":"string","description":"Identifier for 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/src/es/json/ml.update_model_snapshot.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.update_model_snapshot","description":"Update a snapshot.\n\nUpdates certain properties of a snapshot.","x-api":{"id":"ml.update_model_snapshot","name":"update-model-snapshot","namespace":"ml"},"x-method":"POST","x-path":"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"description":{"type":"string","description":"A description of the model snapshot.","x-found-in":"body"},"retain":{"type":"boolean","description":"If `true`, this snapshot will not be deleted during automatic cleanup of\nsnapshots older than `model_snapshot_retention_days`. However, this\nsnapshot will be deleted when the job is deleted.","x-found-in":"body"},"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.update_model_snapshot","description":"Update a snapshot.\n\nUpdates certain properties of a snapshot.","x-api":{"id":"ml.update_model_snapshot","name":"update-model-snapshot","namespace":"ml"},"x-method":"POST","x-path":"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"description":{"type":"string","description":"A description of the model snapshot.","x-found-in":"body"},"retain":{"type":"boolean","description":"If `true`, this snapshot will not be deleted during automatic cleanup of\nsnapshots older than `model_snapshot_retention_days`. However, this\nsnapshot will be deleted when the job is deleted.","x-found-in":"body"},"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/src/es/json/ml.update_trained_model_deployment.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.update_trained_model_deployment","description":"Update a trained model deployment.","x-api":{"id":"ml.update_trained_model_deployment","name":"update-trained-model-deployment","namespace":"ml"},"x-method":"POST","x-path":"/_ml/trained_models/{model_id}/deployment/_update","x-urls":[{"path":"/_ml/trained_models/{model_id}/deployment/_update","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.6.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"number_of_allocations":{"type":"number","description":"The number of model allocations on each node where the model is deployed.\nAll allocations on a node share the same copy of the model in memory but use\na separate set of threads to evaluate the model.\nIncreasing this value generally increases the throughput.\nIf this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.\nIf adaptive_allocations is enabled, do not set this value, because it’s automatically set.","x-found-in":"body"},"adaptive_allocations":{"$ref":"./ml._types.json#/$defs/ml._types__AdaptiveAllocationsSettings","description":"Adaptive allocations configuration. When enabled, the number of allocations\nis set based on the current load.\nIf adaptive_allocations is enabled, do not set the number of allocations manually.","x-found-in":"body"},"model_id":{"type":"string","description":"The unique identifier of the trained model. Currently, only PyTorch models are supported.","x-found-in":"path"}},"required":["model_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.update_trained_model_deployment","description":"Update a trained model deployment.","x-api":{"id":"ml.update_trained_model_deployment","name":"update-trained-model-deployment","namespace":"ml"},"x-method":"POST","x-path":"/_ml/trained_models/{model_id}/deployment/_update","x-urls":[{"path":"/_ml/trained_models/{model_id}/deployment/_update","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.6.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"number_of_allocations":{"type":"number","description":"The number of model allocations on each node where the model is deployed.\nAll allocations on a node share the same copy of the model in memory but use\na separate set of threads to evaluate the model.\nIncreasing this value generally increases the throughput.\nIf this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.\nIf adaptive_allocations is enabled, do not set this value, because it’s automatically set.","x-found-in":"body"},"adaptive_allocations":{"$ref":"./ml._types.json#/$defs/ml._types__AdaptiveAllocationsSettings","description":"Adaptive allocations configuration. When enabled, the number of allocations\nis set based on the current load.\nIf adaptive_allocations is enabled, do not set the number of allocations manually.","x-found-in":"body"},"model_id":{"type":"string","description":"The unique identifier of the trained model. Currently, only PyTorch models 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"}},"required":["model_id"]}

package/src/es/json/ml.upgrade_job_snapshot.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.upgrade_job_snapshot","description":"Upgrade a snapshot.\n\nUpgrade an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.","x-api":{"id":"ml.upgrade_job_snapshot","name":"upgrade-job-snapshot","namespace":"ml"},"x-method":"POST","x-path":"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"wait_for_completion":{"type":"boolean","description":"When true, the API won’t respond until the upgrade is complete.\nOtherwise, it responds as soon as the upgrade task is assigned to a node.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Controls the time to wait for the request to complete.","x-found-in":"query"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"snapshot_id":{"type":"string","description":"A numerical character string that uniquely identifies the model snapshot.","x-found-in":"path"}},"required":["job_id","snapshot_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.upgrade_job_snapshot","description":"Upgrade a snapshot.\n\nUpgrade an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.","x-api":{"id":"ml.upgrade_job_snapshot","name":"upgrade-job-snapshot","namespace":"ml"},"x-method":"POST","x-path":"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"wait_for_completion":{"type":"boolean","description":"When true, the API won’t respond until the upgrade is complete.\nOtherwise, it responds as soon as the upgrade task is assigned to a node.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Controls the time to wait for the request to complete.","x-found-in":"query"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"snapshot_id":{"type":"string","description":"A numerical character string that uniquely identifies 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/src/es/json/msearch.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"msearch","description":"Run multiple searches.\n\nThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.","x-api":{"id":"msearch","name":"msearch","namespace":null},"x-method":"GET","x-path":"/{index}/_msearch","x-urls":[{"path":"/_msearch","methods":["GET","POST"]},{"path":"/{index}/_msearch","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"1.3.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-body-format":"ndjson","type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"ccs_minimize_roundtrips":{"type":"boolean","description":"If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.","x-found-in":"query"},"ignore_throttled":{"type":"boolean","description":"If true, concrete, expanded or aliased indices are ignored when frozen.","x-found-in":"query","x-deprecated":{"since":"7.16.0","description":"This parameter is deprecated because frozen indices have been deprecated."}},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"include_named_queries_score":{"type":"boolean","description":"Indicates whether hit.matched_queries should be rendered as a map that includes\nthe name of the matched query associated with its score (true)\nor as an array containing the name of the matched queries (false)\nThis functionality reruns each named query on every hit in a search response.\nTypically, this adds a small overhead to a request.\nHowever, using computationally expensive named queries on a large number of hits may add significant overhead.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Comma-separated list of data streams, indices, and index aliases to search.","x-found-in":"path"},"max_concurrent_searches":{"type":"number","description":"Maximum number of concurrent searches the multi search API can execute.\nDefaults to `max(1, (# of data nodes * min(search thread pool size, 10)))`.","x-found-in":"query"},"max_concurrent_shard_requests":{"type":"number","description":"Maximum number of concurrent shard requests that each sub-search request executes per node.","x-found-in":"query"},"pre_filter_shard_size":{"type":"number","description":"Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.","x-found-in":"query"},"rest_total_hits_as_int":{"type":"boolean","description":"If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"Custom routing value used to route search operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"Indicates whether global term and document frequencies should be used when scoring returned documents.","x-found-in":"query"},"typed_keys":{"type":"boolean","description":"Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.","x-found-in":"query"},"searches":{"type":"array","items":{"$ref":"./_global.msearch.json#/$defs/_global.msearch__RequestItem"},"x-found-in":"body","x-body-root":true}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"msearch","description":"Run multiple searches.\n\nThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.","x-api":{"id":"msearch","name":"msearch","namespace":null},"x-method":"GET","x-path":"/{index}/_msearch","x-urls":[{"path":"/_msearch","methods":["GET","POST"]},{"path":"/{index}/_msearch","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"1.3.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-body-format":["ndjson"],"type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"ccs_minimize_roundtrips":{"type":"boolean","description":"If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.","x-found-in":"query"},"ignore_throttled":{"type":"boolean","description":"If true, concrete, expanded or aliased indices are ignored when frozen.","x-found-in":"query","x-deprecated":{"since":"7.16.0","description":"This parameter is deprecated because frozen indices have been deprecated."}},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"include_named_queries_score":{"type":"boolean","description":"Indicates whether hit.matched_queries should be rendered as a map that includes\nthe name of the matched query associated with its score (true)\nor as an array containing the name of the matched queries (false)\nThis functionality reruns each named query on every hit in a search response.\nTypically, this adds a small overhead to a request.\nHowever, using computationally expensive named queries on a large number of hits may add significant overhead.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Comma-separated list of data streams, indices, and index aliases to search.","x-found-in":"path"},"max_concurrent_searches":{"type":"number","description":"Maximum number of concurrent searches the multi search API can execute.\nDefaults to `max(1, (# of data nodes * min(search thread pool size, 10)))`.","x-found-in":"query"},"max_concurrent_shard_requests":{"type":"number","description":"Maximum number of concurrent shard requests that each sub-search request executes per node.","x-found-in":"query"},"pre_filter_shard_size":{"type":"number","description":"Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.","x-found-in":"query"},"rest_total_hits_as_int":{"type":"boolean","description":"If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"Custom routing value used to route search operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"Indicates whether global term and document frequencies should be used when scoring returned documents.","x-found-in":"query"},"typed_keys":{"type":"boolean","description":"Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.","x-found-in":"query"},"searches":{"type":"array","items":{"$ref":"./_global.msearch.json#/$defs/_global.msearch__RequestItem"},"x-found-in":"body","x-body-root":true},"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/src/es/json/msearch_template.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"msearch_template","description":"Run multiple templated searches.\n\nRun multiple templated searches with a single request.\nIf you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines.\nFor example:\n\n```\n$ cat requests\n{ \"index\": \"my-index\" }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ \"index\": \"my-other-index\" }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}\n\n$ curl -H \"Content-Type: application/x-ndjson\" -XGET localhost:9200/_msearch/template --data-binary \"@requests\"; echo\n```","x-api":{"id":"msearch_template","name":"msearch-template","namespace":null},"x-method":"GET","x-path":"/{index}/_msearch/template","x-urls":[{"path":"/_msearch/template","methods":["GET","POST"]},{"path":"/{index}/_msearch/template","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"5.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-body-format":"ndjson","type":"object","properties":{"ccs_minimize_roundtrips":{"type":"boolean","description":"If `true`, network round-trips are minimized for cross-cluster search requests.","x-found-in":"query"},"max_concurrent_searches":{"type":"number","description":"The maximum number of concurrent searches the API can run.","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"The type of the search operation.","x-found-in":"query"},"rest_total_hits_as_int":{"type":"boolean","description":"If `true`, the response returns `hits.total` as an integer.\nIf `false`, it returns `hits.total` as an object.","x-found-in":"query"},"typed_keys":{"type":"boolean","description":"If `true`, the response prefixes aggregation and suggester names with their respective types.","x-found-in":"query"},"search_templates":{"type":"array","items":{"$ref":"./_global.msearch_template.json#/$defs/_global.msearch_template__RequestItem"},"x-found-in":"body","x-body-root":true},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*`.","x-found-in":"path"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"msearch_template","description":"Run multiple templated searches.\n\nRun multiple templated searches with a single request.\nIf you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines.\nFor example:\n\n```\n$ cat requests\n{ \"index\": \"my-index\" }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ \"index\": \"my-other-index\" }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}\n\n$ curl -H \"Content-Type: application/x-ndjson\" -XGET localhost:9200/_msearch/template --data-binary \"@requests\"; echo\n```","x-api":{"id":"msearch_template","name":"msearch-template","namespace":null},"x-method":"GET","x-path":"/{index}/_msearch/template","x-urls":[{"path":"/_msearch/template","methods":["GET","POST"]},{"path":"/{index}/_msearch/template","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"5.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-body-format":["ndjson"],"type":"object","properties":{"ccs_minimize_roundtrips":{"type":"boolean","description":"If `true`, network round-trips are minimized for cross-cluster search requests.","x-found-in":"query"},"max_concurrent_searches":{"type":"number","description":"The maximum number of concurrent searches the API can run.","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"The type of the search operation.","x-found-in":"query"},"rest_total_hits_as_int":{"type":"boolean","description":"If `true`, the response returns `hits.total` as an integer.\nIf `false`, it returns `hits.total` as an object.","x-found-in":"query"},"typed_keys":{"type":"boolean","description":"If `true`, the response prefixes aggregation and suggester names with their respective types.","x-found-in":"query"},"search_templates":{"type":"array","items":{"$ref":"./_global.msearch_template.json#/$defs/_global.msearch_template__RequestItem"},"x-found-in":"body","x-body-root":true},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*`.","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/src/es/json/mtermvectors.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"mtermvectors","description":"Get multiple term vectors.\n\nGet multiple term vectors with a single request.\nYou can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.\n\n**Artificial documents**\n\nYou can also use `mtermvectors` to generate term vectors for artificial documents provided in the body of the request.\nThe mapping used is determined by the specified `_index`.","x-api":{"id":"mtermvectors","name":"mtermvectors","namespace":null},"x-method":"GET","x-path":"/{index}/_mtermvectors","x-urls":[{"path":"/_mtermvectors","methods":["GET","POST"]},{"path":"/{index}/_mtermvectors","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"description":"A simplified syntax to specify documents by their ID if they're in the same index.","x-found-in":"body"},"fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A comma-separated list or wildcard expressions of fields to include in the statistics.\nIt is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.","x-found-in":"query"},"field_statistics":{"type":"boolean","description":"If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.","x-found-in":"query"},"offsets":{"type":"boolean","description":"If `true`, the response includes term offsets.","x-found-in":"query"},"payloads":{"type":"boolean","description":"If `true`, the response includes term payloads.","x-found-in":"query"},"positions":{"type":"boolean","description":"If `true`, the response includes term positions.","x-found-in":"query"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"realtime":{"type":"boolean","description":"If true, the request is real-time as opposed to near-real-time.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"term_statistics":{"type":"boolean","description":"If true, the response includes term frequency and document frequency.","x-found-in":"query"},"version":{"type":"number","description":"If `true`, returns the document version as part of a hit.","x-found-in":"query"},"version_type":{"$ref":"./_types.json#/$defs/_types__VersionType","description":"The version type.","x-found-in":"query"},"docs":{"type":"array","items":{"$ref":"./_global.mtermvectors.json#/$defs/_global.mtermvectors__Operation"},"description":"An array of existing or artificial documents.","x-found-in":"body"},"index":{"type":"string","description":"The name of the index that contains the documents.","x-found-in":"path"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"mtermvectors","description":"Get multiple term vectors.\n\nGet multiple term vectors with a single request.\nYou can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.\n\n**Artificial documents**\n\nYou can also use `mtermvectors` to generate term vectors for artificial documents provided in the body of the request.\nThe mapping used is determined by the specified `_index`.","x-api":{"id":"mtermvectors","name":"mtermvectors","namespace":null},"x-method":"GET","x-path":"/{index}/_mtermvectors","x-urls":[{"path":"/_mtermvectors","methods":["GET","POST"]},{"path":"/{index}/_mtermvectors","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"description":"A simplified syntax to specify documents by their ID if they're in the same index.","x-found-in":"body"},"fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A comma-separated list or wildcard expressions of fields to include in the statistics.\nIt is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.","x-found-in":"query"},"field_statistics":{"type":"boolean","description":"If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.","x-found-in":"query"},"offsets":{"type":"boolean","description":"If `true`, the response includes term offsets.","x-found-in":"query"},"payloads":{"type":"boolean","description":"If `true`, the response includes term payloads.","x-found-in":"query"},"positions":{"type":"boolean","description":"If `true`, the response includes term positions.","x-found-in":"query"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"realtime":{"type":"boolean","description":"If true, the request is real-time as opposed to near-real-time.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"term_statistics":{"type":"boolean","description":"If true, the response includes term frequency and document frequency.","x-found-in":"query"},"version":{"type":"number","description":"If `true`, returns the document version as part of a hit.","x-found-in":"query"},"version_type":{"$ref":"./_types.json#/$defs/_types__VersionType","description":"The version type.","x-found-in":"query"},"docs":{"type":"array","items":{"$ref":"./_global.mtermvectors.json#/$defs/_global.mtermvectors__Operation"},"description":"An array of existing or artificial documents.","x-found-in":"body"},"index":{"type":"string","description":"The name of the index that contains the documents.","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/src/es/json/nodes.clear_repositories_metering_archive.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"nodes.clear_repositories_metering_archive__ResponseBase":{"type":"object","properties":{"node_stats":{"$ref":"./_types.json#/$defs/_types__NodeStatistics","description":"Contains statistics about the number of nodes selected by the request’s node filters."},"cluster_name":{"type":"string","description":"Name of the cluster. Based on the `cluster.name` setting."},"nodes":{"type":"object","additionalProperties":{"$ref":"./nodes._types.json#/$defs/nodes._types__RepositoryMeteringInformation"},"description":"Contains repositories metering information for the nodes selected by the request."}},"required":["cluster_name","nodes"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"nodes.clear_repositories_metering_archive__ResponseBase":{"type":"object","properties":{"_nodes":{"$ref":"./_types.json#/$defs/_types__NodeStatistics","description":"Contains statistics about the number of nodes selected by the request’s node filters.","x-codegen-name":"node_stats"},"cluster_name":{"type":"string","description":"Name of the cluster. Based on the `cluster.name` setting."},"nodes":{"type":"object","additionalProperties":{"$ref":"./nodes._types.json#/$defs/nodes._types__RepositoryMeteringInformation"},"description":"Contains repositories metering information for the nodes selected by the request."}},"required":["cluster_name","nodes"]}}}

package/src/es/json/nodes.clear_repositories_metering_archive.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"nodes.clear_repositories_metering_archive","description":"Clear the archived repositories metering.\n\nClear the archived repositories metering information in the cluster.","x-api":{"id":"nodes.clear_repositories_metering_archive","name":"clear-repositories-metering-archive","namespace":"nodes"},"x-method":"DELETE","x-path":"/_nodes/{node_id}/_repositories_metering/{max_archive_version}","x-urls":[{"path":"/_nodes/{node_id}/_repositories_metering/{max_archive_version}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.16.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"private"}},"type":"object","properties":{"node_id":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"Comma-separated list of node IDs or names used to limit returned information.","x-found-in":"path"},"max_archive_version":{"type":"number","description":"Specifies the maximum `archive_version` to be cleared from the archive.","x-found-in":"path"}},"required":["node_id","max_archive_version"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"nodes.clear_repositories_metering_archive","description":"Clear the archived repositories metering.\n\nClear the archived repositories metering information in the cluster.","x-api":{"id":"nodes.clear_repositories_metering_archive","name":"clear-repositories-metering-archive","namespace":"nodes"},"x-method":"DELETE","x-path":"/_nodes/{node_id}/_repositories_metering/{max_archive_version}","x-urls":[{"path":"/_nodes/{node_id}/_repositories_metering/{max_archive_version}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.16.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"private"}},"type":"object","properties":{"node_id":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"Comma-separated list of node IDs or names used to limit returned information.","x-found-in":"path"},"max_archive_version":{"type":"number","description":"Specifies the maximum `archive_version` to be cleared from the archive.","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":["node_id","max_archive_version"]}

package/src/es/json/nodes.get_repositories_metering_info.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"nodes.get_repositories_metering_info__ResponseBase":{"type":"object","properties":{"node_stats":{"$ref":"./_types.json#/$defs/_types__NodeStatistics","description":"Contains statistics about the number of nodes selected by the request’s node filters."},"cluster_name":{"type":"string","description":"Name of the cluster. Based on the `cluster.name` setting."},"nodes":{"type":"object","additionalProperties":{"$ref":"./nodes._types.json#/$defs/nodes._types__RepositoryMeteringInformation"},"description":"Contains repositories metering information for the nodes selected by the request."}},"required":["cluster_name","nodes"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"nodes.get_repositories_metering_info__ResponseBase":{"type":"object","properties":{"_nodes":{"$ref":"./_types.json#/$defs/_types__NodeStatistics","description":"Contains statistics about the number of nodes selected by the request’s node filters.","x-codegen-name":"node_stats"},"cluster_name":{"type":"string","description":"Name of the cluster. Based on the `cluster.name` setting."},"nodes":{"type":"object","additionalProperties":{"$ref":"./nodes._types.json#/$defs/nodes._types__RepositoryMeteringInformation"},"description":"Contains repositories metering information for the nodes selected by the request."}},"required":["cluster_name","nodes"]}}}

package/src/es/json/nodes.get_repositories_metering_info.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"nodes.get_repositories_metering_info","description":"Get cluster repositories metering.\n\nGet repositories metering information for a cluster.\nThis API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time.\nAdditionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.","x-api":{"id":"nodes.get_repositories_metering_info","name":"get-repositories-metering-info","namespace":"nodes"},"x-method":"GET","x-path":"/_nodes/{node_id}/_repositories_metering","x-urls":[{"path":"/_nodes/{node_id}/_repositories_metering","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.16.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"private"}},"type":"object","properties":{"node_id":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"Comma-separated list of node IDs or names used to limit returned information.","x-found-in":"path"}},"required":["node_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"nodes.get_repositories_metering_info","description":"Get cluster repositories metering.\n\nGet repositories metering information for a cluster.\nThis API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time.\nAdditionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.","x-api":{"id":"nodes.get_repositories_metering_info","name":"get-repositories-metering-info","namespace":"nodes"},"x-method":"GET","x-path":"/_nodes/{node_id}/_repositories_metering","x-urls":[{"path":"/_nodes/{node_id}/_repositories_metering","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.16.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"private"}},"type":"object","properties":{"node_id":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"Comma-separated list of node IDs or names used to limit returned information.","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":["node_id"]}

package/src/es/json/nodes.hot_threads.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"nodes.hot_threads","description":"Get the hot threads for nodes.\n\nGet a breakdown of the hot threads on each selected node in the cluster.\nThe output is plain text with a breakdown of the top hot threads for each node.","x-api":{"id":"nodes.hot_threads","name":"hot-threads","namespace":"nodes"},"x-method":"GET","x-path":"/_nodes/{node_id}/hot_threads","x-urls":[{"path":"/_nodes/hot_threads","methods":["GET"]},{"path":"/_nodes/{node_id}/hot_threads","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"ignore_idle_threads":{"type":"boolean","description":"If true, known idle threads (e.g. waiting in a socket select, or to get\na task from an empty queue) are filtered out.","x-found-in":"query"},"interval":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval to do the second sampling of threads.","x-found-in":"query"},"snapshots":{"type":"number","description":"Number of samples of thread stacktrace.","x-found-in":"query"},"threads":{"type":"number","description":"Specifies the number of hot threads to provide information for.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received\nbefore the timeout expires, the request fails and returns an error.","x-found-in":"query"},"type":{"$ref":"./_types.json#/$defs/_types__ThreadType","description":"The type to sample.","x-found-in":"query"},"sort":{"$ref":"./_types.json#/$defs/_types__ThreadType","description":"The sort order for 'cpu' type","x-found-in":"query"},"node_id":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"List of node IDs or names used to limit returned information.","x-found-in":"path"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"nodes.hot_threads","description":"Get the hot threads for nodes.\n\nGet a breakdown of the hot threads on each selected node in the cluster.\nThe output is plain text with a breakdown of the top hot threads for each node.","x-api":{"id":"nodes.hot_threads","name":"hot-threads","namespace":"nodes"},"x-method":"GET","x-path":"/_nodes/{node_id}/hot_threads","x-urls":[{"path":"/_nodes/hot_threads","methods":["GET"]},{"path":"/_nodes/{node_id}/hot_threads","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":["text"],"type":"object","properties":{"ignore_idle_threads":{"type":"boolean","description":"If true, known idle threads (e.g. waiting in a socket select, or to get\na task from an empty queue) are filtered out.","x-found-in":"query"},"interval":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval to do the second sampling of threads.","x-found-in":"query"},"snapshots":{"type":"number","description":"Number of samples of thread stacktrace.","x-found-in":"query"},"threads":{"type":"number","description":"Specifies the number of hot threads to provide information for.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received\nbefore the timeout expires, the request fails and returns an error.","x-found-in":"query"},"type":{"$ref":"./_types.json#/$defs/_types__ThreadType","description":"The type to sample.","x-found-in":"query"},"sort":{"$ref":"./_types.json#/$defs/_types__ThreadType","description":"The sort order for 'cpu' type","x-found-in":"query"},"node_id":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"List of node IDs or names used to limit returned information.","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"}}}