@elastic/schemas 0.4.4 → 0.5.0

package/lib/es/json/ml.put_job.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_job", "type": "object", "properties": { "allow_lazy_open": { "type": "boolean", "description": "Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available.", "x-found-in": "body" }, "analysis_config": { "$ref": "./ml._types.json#/$defs/ml._types__AnalysisConfig", "description": "Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.", "x-found-in": "body" }, "analysis_limits": { "$ref": "./ml._types.json#/$defs/ml._types__AnalysisLimits", "description": "Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes.", "x-found-in": "body" }, "background_persist_interval": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low.", "x-found-in": "body" }, "custom_settings": { "$ref": "./ml._types.json#/$defs/ml._types__CustomSettings", "description": "Advanced configuration option. Contains custom meta data about the job.", "x-found-in": "body" }, "daily_model_snapshot_retention_after_days": { "type": "number", "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`.", "x-found-in": "body" }, "data_description": { "$ref": "./ml._types.json#/$defs/ml._types__DataDescription", "description": "Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained.", "x-found-in": "body" }, "datafeed_config": { "$ref": "./ml._types.json#/$defs/ml._types__DatafeedConfig", "description": "Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead.", "x-found-in": "body" }, "description": { "type": "string", "description": "A description of the job.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", "x-found-in": "path" }, "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" }, "model_plot_config": { "$ref": "./ml._types.json#/$defs/ml._types__ModelPlotConfig", "description": "This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced.", "x-found-in": "body" }, "model_snapshot_retention_days": { "type": "number", "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted.", "x-found-in": "body" }, "renormalization_window_days": { "type": "number", "description": "Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans.", "x-found-in": "body" }, "results_index_name": { "type": "string", "description": "A text string that affects the name of the machine learning results index. By default, the job generates an index named `.ml-anomalies-shared`.", "x-found-in": "body" }, "results_retention_days": { "type": "number", "description": "Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever.", "x-found-in": "body" }, "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "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" }, "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" } }, "required": ["job_id", "analysis_config", "data_description"], "description": "Create an anomaly detection job.\n\nIf you include a `datafeed_config`, you must have read index privileges on the source index.\nIf you include a `datafeed_config` but do not provide a query, the datafeed uses `{\"match_all\": {\"boost\": 1}}`." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_job", "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" }, "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" }, "allow_lazy_open": { "type": "boolean", "description": "Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available.", "x-found-in": "body" }, "analysis_config": { "$ref": "./ml._types.json#/$defs/ml._types__AnalysisConfig", "description": "Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.", "x-found-in": "body" }, "analysis_limits": { "$ref": "./ml._types.json#/$defs/ml._types__AnalysisLimits", "description": "Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes.", "x-found-in": "body" }, "background_persist_interval": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low.", "x-found-in": "body" }, "custom_settings": { "$ref": "./ml._types.json#/$defs/ml._types__CustomSettings", "description": "Advanced configuration option. Contains custom meta data about the job.", "x-found-in": "body" }, "daily_model_snapshot_retention_after_days": { "type": "number", "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`.", "x-found-in": "body" }, "data_description": { "$ref": "./ml._types.json#/$defs/ml._types__DataDescription", "description": "Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained.", "x-found-in": "body" }, "datafeed_config": { "$ref": "./ml._types.json#/$defs/ml._types__DatafeedConfig", "description": "Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead.", "x-found-in": "body" }, "description": { "type": "string", "description": "A description of the job.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", "x-found-in": "path" }, "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" }, "model_plot_config": { "$ref": "./ml._types.json#/$defs/ml._types__ModelPlotConfig", "description": "This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced.", "x-found-in": "body" }, "model_snapshot_retention_days": { "type": "number", "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted.", "x-found-in": "body" }, "renormalization_window_days": { "type": "number", "description": "Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans.", "x-found-in": "body" }, "results_index_name": { "type": "string", "description": "A text string that affects the name of the machine learning results index. By default, the job generates an index named `.ml-anomalies-shared`.", "x-found-in": "body" }, "results_retention_days": { "type": "number", "description": "Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever.", "x-found-in": "body" } }, "required": ["job_id", "analysis_config", "data_description"], "description": "Create an anomaly detection job.\n\nIf you include a `datafeed_config`, you must have read index privileges on the source index.\nIf you include a `datafeed_config` but do not provide a query, the datafeed uses `{\"match_all\": {\"boost\": 1}}`." }

package/lib/es/json/ml.put_trained_model.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_trained_model", "type": "object", "properties": { "compressed_definition": { "type": "string", "description": "The compressed (GZipped and Base64 encoded) inference definition of the\nmodel. If compressed_definition is specified, then definition cannot be\nspecified.", "x-found-in": "body" }, "definition": { "$ref": "./ml.put_trained_model.json#/$defs/ml.put_trained_model__Definition", "description": "The inference definition for the model. If definition is specified, then\ncompressed_definition cannot be specified.", "x-found-in": "body" }, "description": { "type": "string", "description": "A human-readable description of the inference trained model.", "x-found-in": "body" }, "inference_config": { "$ref": "./ml._types.json#/$defs/ml._types__InferenceConfigCreateContainer", "description": "The default configuration for inference. This can be either a regression\nor classification configuration. It must match the underlying\ndefinition.trained_model's target_type. For pre-packaged models such as\nELSER the config is not required.", "x-found-in": "body" }, "input": { "$ref": "./ml.put_trained_model.json#/$defs/ml.put_trained_model__Input", "description": "The input field names for the model definition.", "x-found-in": "body" }, "metadata": { "description": "An object map that contains metadata about the model.", "x-found-in": "body" }, "model_type": { "$ref": "./ml._types.json#/$defs/ml._types__TrainedModelType", "description": "The model type.", "x-found-in": "body" }, "model_size_bytes": { "type": "number", "description": "The estimated memory usage in bytes to keep the trained model in memory.\nThis property is supported only if defer_definition_decompression is true\nor the model definition is not supplied.", "x-found-in": "body" }, "platform_architecture": { "type": "string", "description": "The platform architecture (if applicable) of the trained mode. If the model\nonly works on one platform, because it is heavily optimized for a particular\nprocessor architecture and OS combination, then this field specifies which.\nThe format of the string must match the platform identifiers used by Elasticsearch,\nso one of, `linux-x86_64`, `linux-aarch64`, `darwin-aarch64`,\nor `windows-x86_64`. For portable models (those that work independent of processor\narchitecture or OS features), leave this field unset.", "x-found-in": "body" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "An array of tags to organize the model.", "x-found-in": "body" }, "prefix_strings": { "$ref": "./ml._types.json#/$defs/ml._types__TrainedModelPrefixStrings", "description": "Optional prefix strings applied at inference", "x-found-in": "body" }, "defer_definition_decompression": { "type": "boolean", "description": "If set to `true` and a `compressed_definition` is provided,\nthe request defers definition decompression and skips relevant\nvalidations.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "Whether to wait for all child operations (e.g. model download)\nto complete.", "x-found-in": "query" }, "model_id": { "type": "string", "description": "The unique identifier of the trained model.", "x-found-in": "path" } }, "required": ["model_id"], "description": "Create a trained model.\n\nEnable you to supply a trained model that is not created by data frame analytics." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_trained_model", "type": "object", "properties": { "defer_definition_decompression": { "type": "boolean", "description": "If set to `true` and a `compressed_definition` is provided,\nthe request defers definition decompression and skips relevant\nvalidations.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "Whether to wait for all child operations (e.g. model download)\nto complete.", "x-found-in": "query" }, "compressed_definition": { "type": "string", "description": "The compressed (GZipped and Base64 encoded) inference definition of the\nmodel. If compressed_definition is specified, then definition cannot be\nspecified.", "x-found-in": "body" }, "definition": { "$ref": "./ml.put_trained_model.json#/$defs/ml.put_trained_model__Definition", "description": "The inference definition for the model. If definition is specified, then\ncompressed_definition cannot be specified.", "x-found-in": "body" }, "description": { "type": "string", "description": "A human-readable description of the inference trained model.", "x-found-in": "body" }, "inference_config": { "$ref": "./ml._types.json#/$defs/ml._types__InferenceConfigCreateContainer", "description": "The default configuration for inference. This can be either a regression\nor classification configuration. It must match the underlying\ndefinition.trained_model's target_type. For pre-packaged models such as\nELSER the config is not required.", "x-found-in": "body" }, "input": { "$ref": "./ml.put_trained_model.json#/$defs/ml.put_trained_model__Input", "description": "The input field names for the model definition.", "x-found-in": "body" }, "metadata": { "description": "An object map that contains metadata about the model.", "x-found-in": "body" }, "model_type": { "$ref": "./ml._types.json#/$defs/ml._types__TrainedModelType", "description": "The model type.", "x-found-in": "body" }, "model_size_bytes": { "type": "number", "description": "The estimated memory usage in bytes to keep the trained model in memory.\nThis property is supported only if defer_definition_decompression is true\nor the model definition is not supplied.", "x-found-in": "body" }, "platform_architecture": { "type": "string", "description": "The platform architecture (if applicable) of the trained mode. If the model\nonly works on one platform, because it is heavily optimized for a particular\nprocessor architecture and OS combination, then this field specifies which.\nThe format of the string must match the platform identifiers used by Elasticsearch,\nso one of, `linux-x86_64`, `linux-aarch64`, `darwin-aarch64`,\nor `windows-x86_64`. For portable models (those that work independent of processor\narchitecture or OS features), leave this field unset.", "x-found-in": "body" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "An array of tags to organize the model.", "x-found-in": "body" }, "prefix_strings": { "$ref": "./ml._types.json#/$defs/ml._types__TrainedModelPrefixStrings", "description": "Optional prefix strings applied at inference", "x-found-in": "body" }, "model_id": { "type": "string", "description": "The unique identifier of the trained model.", "x-found-in": "path" } }, "required": ["model_id"], "description": "Create a trained model.\n\nEnable you to supply a trained model that is not created by data frame analytics." }

package/lib/es/json/ml.revert_model_snapshot.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.revert_model_snapshot", "type": "object", "properties": { "delete_intervening_results": { "type": "boolean", "description": "If true, deletes the results in the time period between the latest\nresults and the time of the reverted snapshot. It also resets the model\nto accept records for this time period. If you choose not to delete\nintervening results when reverting a snapshot, the job will not accept\ninput data that is older than the current time. If you want to resend\ndata, then delete the intervening results.", "x-found-in": "query" }, "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"], "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.revert_model_snapshot", "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"], "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." }

package/lib/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", "type": "object", "properties": { "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" }, "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": "query" } }, "required": ["id"], "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.start_data_frame_analytics", "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"], "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." }

package/lib/es/json/ml.start_datafeed.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.start_datafeed", "type": "object", "properties": { "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "The time that the datafeed should end, which can be specified by using one of the following formats:\n\n* ISO 8601 format with milliseconds, for example `2017-01-22T06:00:00.000Z`\n* ISO 8601 format without milliseconds, for example `2017-01-22T06:00:00+00:00`\n* Milliseconds since the epoch, for example `1485061200000`\n\nDate-time arguments using either of the ISO 8601 formats must have a time zone designator, where `Z` is accepted\nas an abbreviation for UTC time. When a URL is expected (for example, in browsers), the `+` used in time zone\ndesignators must be encoded as `%2B`.\nThe end time value is exclusive. If you do not specify an end time, the datafeed\nruns continuously.", "x-found-in": "query" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "The time that the datafeed should begin, which can be specified by using the same formats as the `end` parameter.\nThis value is inclusive.\nIf you do not specify a start time and the datafeed is associated with a new anomaly detection job, the analysis\nstarts from the earliest time for which data is available.\nIf you restart a stopped datafeed and specify a start value that is earlier than the timestamp of the latest\nprocessed record, the datafeed continues from 1 millisecond after the timestamp of the latest processed record.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait until a datafeed starts.", "x-found-in": "query" }, "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"], "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.start_datafeed", "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"], "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." }

package/lib/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", "type": "object", "properties": { "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" }, "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" }, "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" }, "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"], "description": "Start a trained model deployment.\n\nIt allocates the model to every machine learning node." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.start_trained_model_deployment", "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" }, "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"], "description": "Start a trained model deployment.\n\nIt allocates the model to every machine learning node." }

package/lib/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", "type": "object", "properties": { "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" }, "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": "query" }, "force": { "type": "boolean", "description": "If true, the data frame analytics job is stopped forcefully.", "x-found-in": "query" }, "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": "query" } }, "required": ["id"], "description": "Stop data frame analytics jobs.\n\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.stop_data_frame_analytics", "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"], "description": "Stop data frame analytics jobs.\n\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle." }

package/lib/es/json/ml.stop_datafeed.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.stop_datafeed", "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n* Contains wildcard expressions and there are no datafeeds that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when\nthere are partial matches. If `false`, the API returns a 404 status code when there are no matches or only\npartial matches.", "x-found-in": "query" }, "force": { "type": "boolean", "description": "If `true`, the datafeed is stopped forcefully.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait until a datafeed stops.", "x-found-in": "query" }, "close_job": { "type": "boolean", "description": "If `true` the job associated with the datafeed is closed.", "x-found-in": "query" }, "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"], "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.stop_datafeed", "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"], "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." }

package/lib/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", "type": "object", "properties": { "id": { "type": "string", "description": "If provided, must be the same identifier as in the path.", "x-found-in": "body" }, "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": "query" }, "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": "query" }, "model_id": { "type": "string", "description": "The unique identifier of the trained model.", "x-found-in": "path" } }, "required": ["model_id"], "description": "Stop a trained model deployment." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.stop_trained_model_deployment", "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"], "description": "Stop a trained model deployment." }

package/lib/es/json/ml.update_datafeed.request.json

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

package/lib/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", "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.", "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"], "description": "Update a trained model deployment." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.update_trained_model_deployment", "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"], "description": "Update a trained model deployment." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "msearch", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.", "x-found-in": "query" }, "ignore_throttled": { "type": "boolean", "description": "If true, concrete, expanded or aliased indices are ignored when frozen.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "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" } }, "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`." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "msearch", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.", "x-found-in": "query" }, "ignore_throttled": { "type": "boolean", "description": "If true, concrete, expanded or aliased indices are ignored when frozen.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "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" } }, "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`." }

package/lib/es/json/msearch_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "msearch_template", "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" }, "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" } }, "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```" }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "msearch_template", "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" }, "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" } }, "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```" }

package/lib/es/json/mtermvectors.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "mtermvectors", "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "./_global.mtermvectors.json#/$defs/_global.mtermvectors__Operation" }, "description": "An array of existing or artificial documents.", "x-found-in": "body" }, "ids": { "type": "array", "items": { "type": "string" }, "description": "A comma-separated list of documents ids. You must define ids as parameter or set \"ids\" or \"docs\" in the request body", "x-found-in": "query" }, "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" }, "index": { "type": "string", "description": "The name of the index that contains the documents.", "x-found-in": "path" } }, "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`." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "mtermvectors", "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" } }, "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`." }

package/lib/es/json/nodes.reload_secure_settings.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "nodes.reload_secure_settings", "type": "object", "properties": { "secure_settings_password": { "type": "string", "description": "The password for the Elasticsearch keystore.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "node_id": { "$ref": "./_types.json#/$defs/_types__NodeIds", "description": "The names of particular nodes in the cluster to target.", "x-found-in": "path" } }, "description": "Reload the keystore on nodes in the cluster.\n\nSecure settings are stored in an on-disk keystore. Certain of these settings are reloadable.\nThat is, you can change them on disk and reload them without restarting any nodes in the cluster.\nWhen you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node.\n\nWhen the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings.\nReloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted.\nAlternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "nodes.reload_secure_settings", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "secure_settings_password": { "type": "string", "description": "The password for the Elasticsearch keystore.", "x-found-in": "body" }, "node_id": { "$ref": "./_types.json#/$defs/_types__NodeIds", "description": "The names of particular nodes in the cluster to target.", "x-found-in": "path" } }, "description": "Reload the keystore on nodes in the cluster.\n\nSecure settings are stored in an on-disk keystore. Certain of these settings are reloadable.\nThat is, you can change them on disk and reload them without restarting any nodes in the cluster.\nWhen you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node.\n\nWhen the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings.\nReloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted.\nAlternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password." }

package/lib/es/json/open_point_in_time.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "open_point_in_time", "type": "object", "properties": { "index_filter": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Filter indices if the provided query rewrites to `match_none` on every shard.", "x-found-in": "body" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Extend the length of time that the point in time persists.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nBy default, it is random.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value that is used to route operations to a specific shard.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "allow_partial_search_results": { "type": "boolean", "description": "Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT.\nIf `false`, creating a point in time request when a shard is missing or unavailable will throw an exception.\nIf `true`, the point in time will contain all the shards that are available at the time of the request.", "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" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices", "x-found-in": "path" } }, "required": ["index", "keep_alive"], "description": "Open a point in time.\n\nA search request by default runs against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.\n\nA point in time must be opened explicitly before being used in search requests.\n\nA subsequent search request with the `pit` parameter must not specify `index`, `routing`, or `preference` values as these parameters are copied from the point in time.\n\nJust like regular searches, you can use `from` and `size` to page through point in time search results, up to the first 10,000 hits.\nIf you want to retrieve more hits, use PIT with `search_after`.\n\nIMPORTANT: The open point in time request and each subsequent search request can return different identifiers; always use the most recently received ID for the next search request.\n\nWhen a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a `NoShardAvailableActionException` exception.\nTo get rid of these exceptions, a new PIT needs to be created so that shards missing from the previous PIT can be handled, assuming they become available in the meantime.\n\n**Keeping point in time alive**\n\nThe `keep_alive` parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time.\nThe value does not need to be long enough to process all data — it just needs to be long enough for the next request.\n\nNormally, the background merge process optimizes the index by merging together smaller segments to create new, bigger segments.\nOnce the smaller segments are no longer needed they are deleted.\nHowever, open point-in-times prevent the old segments from being deleted since they are still in use.\n\nTIP: Keeping older segments alive means that more disk space and file handles are needed.\nEnsure that you have configured your nodes to have ample free file handles.\n\nAdditionally, if a segment contains deleted or updated documents then the point in time must keep track of whether each document in the segment was live at the time of the initial search request.\nEnsure that your nodes have sufficient heap space if you have many open point-in-times on an index that is subject to ongoing deletes or updates.\nNote that a point-in-time doesn't prevent its associated indices from being deleted.\nYou can check how many point-in-times (that is, search contexts) are open with the nodes stats API." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "open_point_in_time", "type": "object", "properties": { "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Extend the length of time that the point in time persists.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nBy default, it is random.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value that is used to route operations to a specific shard.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "allow_partial_search_results": { "type": "boolean", "description": "Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT.\nIf `false`, creating a point in time request when a shard is missing or unavailable will throw an exception.\nIf `true`, the point in time will contain all the shards that are available at the time of the request.", "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" }, "index_filter": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Filter indices if the provided query rewrites to `match_none` on every shard.", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices", "x-found-in": "path" } }, "required": ["index", "keep_alive"], "description": "Open a point in time.\n\nA search request by default runs against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.\n\nA point in time must be opened explicitly before being used in search requests.\n\nA subsequent search request with the `pit` parameter must not specify `index`, `routing`, or `preference` values as these parameters are copied from the point in time.\n\nJust like regular searches, you can use `from` and `size` to page through point in time search results, up to the first 10,000 hits.\nIf you want to retrieve more hits, use PIT with `search_after`.\n\nIMPORTANT: The open point in time request and each subsequent search request can return different identifiers; always use the most recently received ID for the next search request.\n\nWhen a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a `NoShardAvailableActionException` exception.\nTo get rid of these exceptions, a new PIT needs to be created so that shards missing from the previous PIT can be handled, assuming they become available in the meantime.\n\n**Keeping point in time alive**\n\nThe `keep_alive` parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time.\nThe value does not need to be long enough to process all data — it just needs to be long enough for the next request.\n\nNormally, the background merge process optimizes the index by merging together smaller segments to create new, bigger segments.\nOnce the smaller segments are no longer needed they are deleted.\nHowever, open point-in-times prevent the old segments from being deleted since they are still in use.\n\nTIP: Keeping older segments alive means that more disk space and file handles are needed.\nEnsure that you have configured your nodes to have ample free file handles.\n\nAdditionally, if a segment contains deleted or updated documents then the point in time must keep track of whether each document in the segment was live at the time of the initial search request.\nEnsure that your nodes have sufficient heap space if you have many open point-in-times on an index that is subject to ongoing deletes or updates.\nNote that a point-in-time doesn't prevent its associated indices from being deleted.\nYou can check how many point-in-times (that is, search contexts) are open with the nodes stats API." }

package/lib/es/json/project.create_many_routing.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "project.create_many_routing", "type": "object", "properties": {}, "description": "Create or update project routing expressions." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "project.create_many_routing", "type": "object", "properties": { "expressions": { "$ref": "./project._types.json#/$defs/project._types__NamedProjectRoutingExpressions", "x-found-in": "body" } }, "description": "Create or update project routing expressions." }

package/lib/es/json/project.create_routing.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "project.create_routing", "type": "object", "properties": { "name": { "type": "string", "description": "The name of project routing expression", "x-found-in": "path" } }, "required": ["name"], "description": "Create or update a project routing expression." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "project.create_routing", "type": "object", "properties": { "expressions": { "$ref": "./project._types.json#/$defs/project._types__ProjectRoutingExpression", "x-found-in": "body" }, "name": { "type": "string", "description": "The name of project routing expression", "x-found-in": "path" } }, "required": ["name"], "description": "Create or update a project routing expression." }

package/lib/es/json/put_script.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "put_script", "type": "object", "properties": { "script": { "$ref": "./_types.json#/$defs/_types__StoredScript", "description": "The script or search template, its parameters, and its language.", "x-found-in": "body" }, "context": { "type": "string", "description": "The context in which the script or search template should run.\nTo prevent errors, the API immediately compiles the script or template in this context.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "id": { "type": "string", "description": "The identifier for the stored script or search template.\nIt must be unique within the cluster.", "x-found-in": "path" } }, "required": ["id", "script"], "description": "Create or update a script or search template.\n\nCreates or updates a stored script or search template." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "put_script", "type": "object", "properties": { "context": { "type": "string", "description": "The context in which the script or search template should run.\nTo prevent errors, the API immediately compiles the script or template in this context.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "script": { "$ref": "./_types.json#/$defs/_types__StoredScript", "description": "The script or search template, its parameters, and its language.", "x-found-in": "body" }, "id": { "type": "string", "description": "The identifier for the stored script or search template.\nIt must be unique within the cluster.", "x-found-in": "path" } }, "required": ["id", "script"], "description": "Create or update a script or search template.\n\nCreates or updates a stored script or search template." }

package/lib/es/json/query_rules.put_rule.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "query_rules.put_rule", "type": "object", "properties": { "type": { "$ref": "./query_rules._types.json#/$defs/query_rules._types__QueryRuleType", "description": "The type of rule.", "x-found-in": "body" }, "criteria": { "oneOf": [{ "$ref": "./query_rules._types.json#/$defs/query_rules._types__QueryRuleCriteria" }, { "type": "array", "items": { "$ref": "./query_rules._types.json#/$defs/query_rules._types__QueryRuleCriteria" } }], "description": "The criteria that must be met for the rule to be applied.\nIf multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.", "x-found-in": "body" }, "actions": { "$ref": "./query_rules._types.json#/$defs/query_rules._types__QueryRuleActions", "description": "The actions to take when the rule is matched.\nThe format of this action depends on the rule type.", "x-found-in": "body" }, "priority": { "type": "number", "x-found-in": "body" }, "ruleset_id": { "type": "string", "description": "The unique identifier of the query ruleset containing the rule to be created or updated.", "x-found-in": "path" }, "rule_id": { "type": "string", "description": "The unique identifier of the query rule within the specified ruleset to be created or updated.", "x-found-in": "path" } }, "required": ["ruleset_id", "rule_id", "type", "criteria", "actions"], "description": "Create or update a query rule.\n\nCreate or update a query rule within a query ruleset.\n\nIMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule.\nIt is advised to use one or the other in query rulesets, to avoid errors.\nAdditionally, pinned queries have a maximum limit of 100 pinned hits.\nIf multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "query_rules.put_rule", "type": "object", "properties": { "type": { "$ref": "./query_rules._types.json#/$defs/query_rules._types__QueryRuleType", "description": "The type of rule.", "x-found-in": "body" }, "criteria": { "anyOf": [{ "$ref": "./query_rules._types.json#/$defs/query_rules._types__QueryRuleCriteria" }, { "type": "array", "items": { "$ref": "./query_rules._types.json#/$defs/query_rules._types__QueryRuleCriteria" } }], "description": "The criteria that must be met for the rule to be applied.\nIf multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.", "x-found-in": "body" }, "actions": { "$ref": "./query_rules._types.json#/$defs/query_rules._types__QueryRuleActions", "description": "The actions to take when the rule is matched.\nThe format of this action depends on the rule type.", "x-found-in": "body" }, "priority": { "type": "number", "x-found-in": "body" }, "ruleset_id": { "type": "string", "description": "The unique identifier of the query ruleset containing the rule to be created or updated.", "x-found-in": "path" }, "rule_id": { "type": "string", "description": "The unique identifier of the query rule within the specified ruleset to be created or updated.", "x-found-in": "path" } }, "required": ["ruleset_id", "rule_id", "type", "criteria", "actions"], "description": "Create or update a query rule.\n\nCreate or update a query rule within a query ruleset.\n\nIMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule.\nIt is advised to use one or the other in query rulesets, to avoid errors.\nAdditionally, pinned queries have a maximum limit of 100 pinned hits.\nIf multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset." }

package/lib/es/json/query_rules.put_ruleset.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "query_rules.put_ruleset", "type": "object", "properties": { "rules": { "oneOf": [{ "$ref": "./query_rules._types.json#/$defs/query_rules._types__QueryRule" }, { "type": "array", "items": { "$ref": "./query_rules._types.json#/$defs/query_rules._types__QueryRule" } }], "x-found-in": "body" }, "ruleset_id": { "type": "string", "description": "The unique identifier of the query ruleset to be created or updated.", "x-found-in": "path" } }, "required": ["ruleset_id", "rules"], "description": "Create or update a query ruleset.\n\nThere is a limit of 100 rules per ruleset.\nThis limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset` cluster setting.\n\nIMPORTANT: Due to limitations within pinned queries, you can only select documents using `ids` or `docs`, but cannot use both in single rule.\nIt is advised to use one or the other in query rulesets, to avoid errors.\nAdditionally, pinned queries have a maximum limit of 100 pinned hits.\nIf multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "query_rules.put_ruleset", "type": "object", "properties": { "rules": { "anyOf": [{ "$ref": "./query_rules._types.json#/$defs/query_rules._types__QueryRule" }, { "type": "array", "items": { "$ref": "./query_rules._types.json#/$defs/query_rules._types__QueryRule" } }], "x-found-in": "body" }, "ruleset_id": { "type": "string", "description": "The unique identifier of the query ruleset to be created or updated.", "x-found-in": "path" } }, "required": ["ruleset_id", "rules"], "description": "Create or update a query ruleset.\n\nThere is a limit of 100 rules per ruleset.\nThis limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset` cluster setting.\n\nIMPORTANT: Due to limitations within pinned queries, you can only select documents using `ids` or `docs`, but cannot use both in single rule.\nIt is advised to use one or the other in query rulesets, to avoid errors.\nAdditionally, pinned queries have a maximum limit of 100 pinned hits.\nIf multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset." }

package/lib/es/json/rank_eval.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rank_eval", "type": "object", "properties": { "requests": { "type": "array", "items": { "$ref": "./_global.rank_eval.json#/$defs/_global.rank_eval__RankEvalRequestItem" }, "description": "A set of typical search requests, together with their provided ratings.", "x-found-in": "body" }, "metric": { "$ref": "./_global.rank_eval.json#/$defs/_global.rank_eval__RankEvalMetric", "description": "Definition of the evaluation metric to calculate.", "x-found-in": "body" }, "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "x-found-in": "query" }, "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" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "description": "Search operation type", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A  comma-separated list of data streams, indices, and index aliases used to limit the request.\nWildcard (`*`) expressions are supported.\nTo target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`.", "x-found-in": "path" } }, "required": ["requests"], "description": "Evaluate ranked search results.\n\nEvaluate the quality of ranked search results over a set of typical search queries." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rank_eval", "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": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "description": "Search operation type", "x-found-in": "query" }, "requests": { "type": "array", "items": { "$ref": "./_global.rank_eval.json#/$defs/_global.rank_eval__RankEvalRequestItem" }, "description": "A set of typical search requests, together with their provided ratings.", "x-found-in": "body" }, "metric": { "$ref": "./_global.rank_eval.json#/$defs/_global.rank_eval__RankEvalMetric", "description": "Definition of the evaluation metric to calculate.", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A  comma-separated list of data streams, indices, and index aliases used to limit the request.\nWildcard (`*`) expressions are supported.\nTo target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`.", "x-found-in": "path" } }, "required": ["requests"], "description": "Evaluate ranked search results.\n\nEvaluate the quality of ranked search results over a set of typical search queries." }

package/lib/es/json/reindex.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "reindex", "type": "object", "properties": { "conflicts": { "$ref": "./_types.json#/$defs/_types__Conflicts", "description": "Indicates whether to continue reindexing even when there are conflicts.", "x-found-in": "body" }, "dest": { "$ref": "./_global.reindex.json#/$defs/_global.reindex__Destination", "description": "The destination you are copying to.", "x-found-in": "body" }, "max_docs": { "type": "number", "description": "The maximum number of documents to reindex.\nBy default, all documents are reindexed.\nIf it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation.\n\nIf `conflicts` is set to `proceed`, the reindex operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.\n\nIf `slices` is set, the `max_docs` limit is split evenly across the slices.\nIf the number of documents in the source is equal to or slightly more than `max_docs`, this could result in slightly fewer than `max_docs` documents being reindexed, due to skew in the slicing.", "x-found-in": "query" }, "script": { "$ref": "./_types.json#/$defs/_types__Script", "description": "The script to run to update the document source or metadata when reindexing.", "x-found-in": "body" }, "source": { "$ref": "./_global.reindex.json#/$defs/_global.reindex__Source", "description": "The source you are copying from.", "x-found-in": "body" }, "refresh": { "type": "boolean", "description": "If `true`, the request refreshes affected shards to make this operation visible to search.", "x-found-in": "query" }, "requests_per_second": { "type": "number", "description": "The maximum number of documents to index per second, across the entire reindex operation (including slices).\nIt can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.", "x-found-in": "query" }, "scroll": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period of time that a consistent view of the index should be maintained for scrolled search.\nIn serverless, and stack versions >= v9.5.0, we use PIT rather than scroll for pagination.\nWe only use scroll for reindexing from remote clusters that are older than v7.10.0.\nTherefore, this parameter is ignored unless you are reindexing from a remote cluster that is older than v7.10.0.", "x-found-in": "query" }, "slices": { "$ref": "./_types.json#/$defs/_types__Slices", "description": "The number of slices this task should be divided into.\nIt defaults to one slice, which means the task isn't sliced into subtasks.\n\nReindex supports sliced scroll to parallelize the reindexing process.\nThis parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nNOTE: Reindexing from remote clusters does not support manual or automatic slicing.\n\nIf set to `auto`, Elasticsearch chooses the number of slices to use.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple sources, it will choose the number of slices based on the index or backing index with the smallest number of shards.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.\nBy default, Elasticsearch waits for at least one minute before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "The number of shard copies that must be active before proceeding with the operation.\nSet it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default value is one, which means it waits for each primary shard to be active.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request blocks until the operation is complete. If your requested reindex operation is complex or time-consuming,\nit might timeout due to transport-layer limitations. While the reindex will continue to be processed by the cluster, your\nclient will not receive updates on status automatically after timeout. Set this option `true` if you anticipate a long-running reindex.", "x-found-in": "query" }, "require_alias": { "type": "boolean", "description": "If `true`, the destination must be an index alias.", "x-found-in": "query" } }, "required": ["dest", "source"], "description": "Reindex documents.\n\nCopy documents from a source to a destination.\nYou can copy all documents to the destination index or reindex a subset of the documents.\nThe source can be any existing index, alias, or data stream.\nThe destination must differ from the source.\nFor example, you cannot reindex a data stream into itself.\n\nIMPORTANT: Reindex requires `_source` to be enabled for all documents in the source.\nThe destination should be configured as wanted before calling the reindex API.\nReindex does not copy the settings from the source or its associated template.\nMappings, shard counts, and replicas, for example, must be configured ahead of time.\n\nIf the Elasticsearch security features are enabled, you must have the following security privileges:\n\n* The `read` index privilege for the source data stream, index, or alias.\n* The `write` index privilege for the destination data stream, index, or index alias.\n* To automatically create a data stream or index with a reindex API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege for the destination data stream, index, or alias.\n* If reindexing from a remote cluster, the `source.remote.user` must have the `monitor` cluster privilege and the `read` index privilege for the source data stream, index, or alias.\n\nIf reindexing from a remote cluster into a cluster using Elastic Stack, you must explicitly allow the remote host using the `reindex.remote.whitelist` node setting on the destination cluster.\nIf reindexing from a remote cluster into an Elastic Cloud Serverless project, only remote hosts from [Elastic Cloud Hosted and Elastic Cloud Serverless](https://cloud.elastic.co/registration?page=docs&placement=docs-body) are allowed.\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nThe `dest` element can be configured like the index API to control optimistic concurrency control.\nOmitting `version_type` or setting it to `internal` causes Elasticsearch to blindly dump documents into the destination, overwriting any that happen to have the same ID.\n\nSetting `version_type` to `external` causes Elasticsearch to preserve the `version` from the source, create any documents that are missing, and update any documents that have an older version in the destination than they do in the source.\n\nSetting `op_type` to `create` causes the reindex API to create only missing documents in the destination.\nAll existing documents will cause a version conflict.\n\nIMPORTANT: Because data streams are append-only, any reindex request to a destination data stream must have an `op_type` of `create`.\nA reindex can only add new documents to a destination data stream.\nIt cannot update existing documents in a destination data stream.\n\nBy default, version conflicts abort the reindex process.\nTo continue reindexing if there are conflicts, set the `conflicts` request body property to `proceed`.\nIn this case, the response includes a count of the version conflicts that were encountered.\nNote that the handling of other error types is unaffected by the `conflicts` property.\nAdditionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.\n\nIt's recommended to reindex on indices with a green status. Reindexing can fail when a node shuts down or crashes.\n* When requested with `wait_for_completion=true` (default), the request fails if the node shuts down.\n* When requested with `wait_for_completion=false`, a task id is returned, for use with the task management APIs. The task may disappear or fail if the node shuts down.\nWhen retrying a failed reindex operation, it might be necessary to set `conflicts=proceed` or to first delete the partial destination index.\nAdditionally, dry runs, checking disk space, and fetching index recovery information can help address the root cause.\n\nRefer to the linked documentation for examples of how to reindex documents." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "reindex", "type": "object", "properties": { "refresh": { "type": "boolean", "description": "If `true`, the request refreshes affected shards to make this operation visible to search.", "x-found-in": "query" }, "requests_per_second": { "type": "number", "description": "The maximum number of documents to index per second, across the entire reindex operation (including slices).\nIt can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.", "x-found-in": "query" }, "scroll": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period of time that a consistent view of the index should be maintained for scrolled search.\nIn serverless, and stack versions >= v9.5.0, we use PIT rather than scroll for pagination.\nWe only use scroll for reindexing from remote clusters that are older than v7.10.0.\nTherefore, this parameter is ignored unless you are reindexing from a remote cluster that is older than v7.10.0.", "x-found-in": "query" }, "slices": { "$ref": "./_types.json#/$defs/_types__Slices", "description": "The number of slices this task should be divided into.\nIt defaults to one slice, which means the task isn't sliced into subtasks.\n\nReindex supports sliced scroll to parallelize the reindexing process.\nThis parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nNOTE: Reindexing from remote clusters does not support manual or automatic slicing.\n\nIf set to `auto`, Elasticsearch chooses the number of slices to use.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple sources, it will choose the number of slices based on the index or backing index with the smallest number of shards.", "x-found-in": "query" }, "max_docs": { "type": "number", "description": "The maximum number of documents to reindex.\nBy default, all documents are reindexed.\nIf it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation.\n\nIf `conflicts` is set to `proceed`, the reindex operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.\nBy default, Elasticsearch waits for at least one minute before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "The number of shard copies that must be active before proceeding with the operation.\nSet it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default value is one, which means it waits for each primary shard to be active.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request blocks until the operation is complete. If your requested reindex operation is complex or time-consuming,\nit might timeout due to transport-layer limitations. While the reindex will continue to be processed by the cluster, your\nclient will not receive updates on status automatically after timeout. Set this option `true` if you anticipate a long-running reindex.", "x-found-in": "query" }, "require_alias": { "type": "boolean", "description": "If `true`, the destination must be an index alias.", "x-found-in": "query" }, "conflicts": { "$ref": "./_types.json#/$defs/_types__Conflicts", "description": "Indicates whether to continue reindexing even when there are conflicts.", "x-found-in": "body" }, "dest": { "$ref": "./_global.reindex.json#/$defs/_global.reindex__Destination", "description": "The destination you are copying to.", "x-found-in": "body" }, "script": { "$ref": "./_types.json#/$defs/_types__Script", "description": "The script to run to update the document source or metadata when reindexing.", "x-found-in": "body" }, "source": { "$ref": "./_global.reindex.json#/$defs/_global.reindex__Source", "description": "The source you are copying from.", "x-found-in": "body" } }, "required": ["dest", "source"], "description": "Reindex documents.\n\nCopy documents from a source to a destination.\nYou can copy all documents to the destination index or reindex a subset of the documents.\nThe source can be any existing index, alias, or data stream.\nThe destination must differ from the source.\nFor example, you cannot reindex a data stream into itself.\n\nIMPORTANT: Reindex requires `_source` to be enabled for all documents in the source.\nThe destination should be configured as wanted before calling the reindex API.\nReindex does not copy the settings from the source or its associated template.\nMappings, shard counts, and replicas, for example, must be configured ahead of time.\n\nIf the Elasticsearch security features are enabled, you must have the following security privileges:\n\n* The `read` index privilege for the source data stream, index, or alias.\n* The `write` index privilege for the destination data stream, index, or index alias.\n* To automatically create a data stream or index with a reindex API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege for the destination data stream, index, or alias.\n* If reindexing from a remote cluster, the `source.remote.user` must have the `monitor` cluster privilege and the `read` index privilege for the source data stream, index, or alias.\n\nIf reindexing from a remote cluster into a cluster using Elastic Stack, you must explicitly allow the remote host using the `reindex.remote.whitelist` node setting on the destination cluster.\nIf reindexing from a remote cluster into an Elastic Cloud Serverless project, only remote hosts from [Elastic Cloud Hosted and Elastic Cloud Serverless](https://cloud.elastic.co/registration?page=docs&placement=docs-body) are allowed.\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nThe `dest` element can be configured like the index API to control optimistic concurrency control.\nOmitting `version_type` or setting it to `internal` causes Elasticsearch to blindly dump documents into the destination, overwriting any that happen to have the same ID.\n\nSetting `version_type` to `external` causes Elasticsearch to preserve the `version` from the source, create any documents that are missing, and update any documents that have an older version in the destination than they do in the source.\n\nSetting `op_type` to `create` causes the reindex API to create only missing documents in the destination.\nAll existing documents will cause a version conflict.\n\nIMPORTANT: Because data streams are append-only, any reindex request to a destination data stream must have an `op_type` of `create`.\nA reindex can only add new documents to a destination data stream.\nIt cannot update existing documents in a destination data stream.\n\nBy default, version conflicts abort the reindex process.\nTo continue reindexing if there are conflicts, set the `conflicts` request body property to `proceed`.\nIn this case, the response includes a count of the version conflicts that were encountered.\nNote that the handling of other error types is unaffected by the `conflicts` property.\nAdditionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.\n\nIt's recommended to reindex on indices with a green status. Reindexing can fail when a node shuts down or crashes.\n* When requested with `wait_for_completion=true` (default), the request fails if the node shuts down.\n* When requested with `wait_for_completion=false`, a task id is returned, for use with the task management APIs. The task may disappear or fail if the node shuts down.\nWhen retrying a failed reindex operation, it might be necessary to set `conflicts=proceed` or to first delete the partial destination index.\nAdditionally, dry runs, checking disk space, and fetching index recovery information can help address the root cause.\n\nRefer to the linked documentation for examples of how to reindex documents." }

package/lib/es/json/rollup.rollup_search.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rollup.rollup_search", "type": "object", "properties": { "aggregations": { "type": "object", "additionalProperties": { "$ref": "./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer" }, "description": "Specifies aggregations.", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Specifies a DSL query that is subject to some limitations.", "x-found-in": "body" }, "size": { "type": "number", "description": "Must be zero if set, as rollups work on pre-aggregated data.", "x-found-in": "body" }, "rest_total_hits_as_int": { "type": "boolean", "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "x-found-in": "query" }, "typed_keys": { "type": "boolean", "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams and indices used to limit the request.\nThis parameter has the following rules:\n\n* At least one data stream, index, or wildcard expression must be specified. This target can include a rollup or non-rollup index. For data streams, the stream's backing indices can only serve as non-rollup indices. Omitting the parameter or using `_all` are not permitted.\n* Multiple non-rollup indices may be specified.\n* Only one rollup index may be specified. If more than one are supplied, an exception occurs.\n* Wildcard expressions (`*`) may be used. If they match more than one rollup index, an exception occurs. However, you can use an expression to match multiple non-rollup indices or data streams.", "x-found-in": "path" } }, "required": ["index"], "description": "Search rolled-up data.\n\nThe rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.\nIt rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.\n\nThe request body supports a subset of features from the regular search API.\nThe following functionality is not available:\n\n`size`: Because rollups work on pre-aggregated data, no search hits can be returned and so size must be set to zero or omitted entirely.\n`highlighter`, `suggestors`, `post_filter`, `profile`, `explain`: These are similarly disallowed.\n\nFor more detailed examples of using the rollup search API, including querying rolled-up data only or combining rolled-up and live data, refer to the External documentation." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rollup.rollup_search", "type": "object", "properties": { "rest_total_hits_as_int": { "type": "boolean", "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "x-found-in": "query" }, "typed_keys": { "type": "boolean", "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", "x-found-in": "query" }, "aggregations": { "type": "object", "additionalProperties": { "$ref": "./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer" }, "description": "Specifies aggregations.", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Specifies a DSL query that is subject to some limitations.", "x-found-in": "body" }, "size": { "type": "number", "description": "Must be zero if set, as rollups work on pre-aggregated data.", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams and indices used to limit the request.\nThis parameter has the following rules:\n\n* At least one data stream, index, or wildcard expression must be specified. This target can include a rollup or non-rollup index. For data streams, the stream's backing indices can only serve as non-rollup indices. Omitting the parameter or using `_all` are not permitted.\n* Multiple non-rollup indices may be specified.\n* Only one rollup index may be specified. If more than one are supplied, an exception occurs.\n* Wildcard expressions (`*`) may be used. If they match more than one rollup index, an exception occurs. However, you can use an expression to match multiple non-rollup indices or data streams.", "x-found-in": "path" } }, "required": ["index"], "description": "Search rolled-up data.\n\nThe rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.\nIt rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.\n\nThe request body supports a subset of features from the regular search API.\nThe following functionality is not available:\n\n`size`: Because rollups work on pre-aggregated data, no search hits can be returned and so size must be set to zero or omitted entirely.\n`highlighter`, `suggestors`, `post_filter`, `profile`, `explain`: These are similarly disallowed.\n\nFor more detailed examples of using the rollup search API, including querying rolled-up data only or combining rolled-up and live data, refer to the External documentation." }

package/lib/es/json/scroll.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "scroll", "type": "object", "properties": { "scroll": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to retain the search context for scrolling.", "x-found-in": "query" }, "scroll_id": { "type": "string", "description": "The scroll ID", "x-found-in": "body" }, "rest_total_hits_as_int": { "type": "boolean", "description": "If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object.", "x-found-in": "query" } }, "required": ["scroll_id"], "description": "Run a scrolling search.\n\nIMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "scroll", "type": "object", "properties": { "scroll": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to retain the search context for scrolling.", "x-found-in": "body" }, "scroll_id": { "type": "string", "description": "The scroll ID", "x-found-in": "body" }, "rest_total_hits_as_int": { "type": "boolean", "description": "If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object.", "x-found-in": "query" } }, "required": ["scroll_id"], "description": "Run a scrolling search.\n\nIMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests." }