@elastic/schemas 0.4.3 → 0.4.5

package/lib/cjs/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": { "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" }, "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" } }, "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/cjs/es/json/ml.update_filter.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.update_filter", "type": "object", "properties": { "filter_id": { "type": "string", "description": "A string that uniquely identifies a filter.", "x-found-in": "path" }, "add_items": { "type": "array", "items": { "type": "string" }, "description": "The items to add to the filter.", "x-found-in": "body" }, "description": { "type": "string", "description": "A description for the filter.", "x-found-in": "body" }, "remove_items": { "type": "array", "items": { "type": "string" }, "description": "The items to remove from the filter.", "x-found-in": "body" } }, "required": ["filter_id"], "description": "Update a filter.\n\nUpdates the description of a filter, adds items, or removes items from the list." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.update_filter", "type": "object", "properties": { "add_items": { "type": "array", "items": { "type": "string" }, "description": "The items to add to the filter.", "x-found-in": "body" }, "description": { "type": "string", "description": "A description for the filter.", "x-found-in": "body" }, "remove_items": { "type": "array", "items": { "type": "string" }, "description": "The items to remove from the filter.", "x-found-in": "body" }, "filter_id": { "type": "string", "description": "A string that uniquely identifies a filter.", "x-found-in": "path" } }, "required": ["filter_id"], "description": "Update a filter.\n\nUpdates the description of a filter, adds items, or removes items from the list." }

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

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

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.update_model_snapshot", "type": "object", "properties": { "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "snapshot_id": { "type": "string", "description": "Identifier for the model snapshot.", "x-found-in": "path" }, "description": { "type": "string", "description": "A description of the model snapshot.", "x-found-in": "body" }, "retain": { "type": "boolean", "description": "If `true`, this snapshot will not be deleted during automatic cleanup of\nsnapshots older than `model_snapshot_retention_days`. However, this\nsnapshot will be deleted when the job is deleted.", "x-found-in": "body" } }, "required": ["job_id", "snapshot_id"], "description": "Update a snapshot.\n\nUpdates certain properties of a snapshot." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.update_model_snapshot", "type": "object", "properties": { "description": { "type": "string", "description": "A description of the model snapshot.", "x-found-in": "body" }, "retain": { "type": "boolean", "description": "If `true`, this snapshot will not be deleted during automatic cleanup of\nsnapshots older than `model_snapshot_retention_days`. However, this\nsnapshot will be deleted when the job is deleted.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "snapshot_id": { "type": "string", "description": "Identifier for the model snapshot.", "x-found-in": "path" } }, "required": ["job_id", "snapshot_id"], "description": "Update a snapshot.\n\nUpdates certain properties of a snapshot." }

package/lib/cjs/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": { "model_id": { "type": "string", "description": "The unique identifier of the trained model. Currently, only PyTorch models are supported.", "x-found-in": "path" }, "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" } }, "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/cjs/es/json/ml.upgrade_job_snapshot.request.json

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

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "msearch", "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and index aliases to use as default", "x-found-in": "query" }, "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "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" }, "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/cjs/es/json/msearch_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "msearch_template", "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*`.", "x-found-in": "path" }, "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" } }, "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/cjs/es/json/mtermvectors.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "mtermvectors", "type": "object", "properties": { "index": { "type": "string", "description": "The name of the index that contains the documents.", "x-found-in": "path" }, "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" } }, "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/cjs/es/json/nodes.hot_threads.request.json

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

package/lib/cjs/es/json/nodes.info.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "nodes.info", "type": "object", "properties": { "node_id": { "$ref": "./_types.json#/$defs/_types__NodeIds", "description": "Comma-separated list of node IDs or names used to limit returned information.", "x-found-in": "path" }, "metric": { "$ref": "./nodes.info.json#/$defs/nodes.info__NodesInfoMetrics", "description": "Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.", "x-found-in": "path" }, "flat_settings": { "type": "boolean", "description": "If true, returns settings in flat format.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "description": "Get node information.\n\nBy default, the API returns all attributes and core settings for cluster nodes." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "nodes.info", "type": "object", "properties": { "flat_settings": { "type": "boolean", "description": "If true, returns settings in flat format.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "node_id": { "$ref": "./_types.json#/$defs/_types__NodeIds", "description": "Comma-separated list of node IDs or names used to limit returned information.", "x-found-in": "path" }, "metric": { "$ref": "./nodes.info.json#/$defs/nodes.info__NodesInfoMetrics", "description": "Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.", "x-found-in": "path" } }, "description": "Get node information.\n\nBy default, the API returns all attributes and core settings for cluster nodes." }

package/lib/cjs/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": { "node_id": { "$ref": "./_types.json#/$defs/_types__NodeIds", "description": "The names of particular nodes in the cluster to target.", "x-found-in": "path" }, "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" } }, "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/cjs/es/json/nodes.stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "nodes.stats", "type": "object", "properties": { "node_id": { "$ref": "./_types.json#/$defs/_types__NodeIds", "description": "Comma-separated list of node IDs or names used to limit returned information.", "x-found-in": "path" }, "metric": { "$ref": "./nodes.stats.json#/$defs/nodes.stats__NodeStatsMetrics", "description": "Limits the information returned to the specific metrics.", "x-found-in": "path" }, "index_metric": { "$ref": "./_types.json#/$defs/_types__CommonStatsFlags", "description": "Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified.", "x-found-in": "path" }, "completion_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.", "x-found-in": "query" }, "fielddata_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list or wildcard expressions of fields to include in fielddata statistics.", "x-found-in": "query" }, "fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list or wildcard expressions of fields to include in the statistics.", "x-found-in": "query" }, "groups": { "type": "boolean", "description": "Comma-separated list of search groups to include in the search statistics.", "x-found-in": "query" }, "include_segment_file_sizes": { "type": "boolean", "description": "If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", "x-found-in": "query" }, "level": { "$ref": "./_types.json#/$defs/_types__NodeStatsLevel", "description": "Indicates whether statistics are aggregated at the node, indices, or shards level.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "types": { "type": "array", "items": { "type": "string" }, "description": "A comma-separated list of document types for the indexing index metric.", "x-found-in": "query" }, "include_unloaded_segments": { "type": "boolean", "description": "If `true`, the response includes information from segments that are not loaded into memory.", "x-found-in": "query" } }, "description": "Get node statistics.\n\nGet statistics for nodes in a cluster.\nBy default, all stats are returned. You can limit the returned information by using metrics." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "nodes.stats", "type": "object", "properties": { "completion_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.", "x-found-in": "query" }, "fielddata_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list or wildcard expressions of fields to include in fielddata statistics.", "x-found-in": "query" }, "fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list or wildcard expressions of fields to include in the statistics.", "x-found-in": "query" }, "groups": { "type": "boolean", "description": "Comma-separated list of search groups to include in the search statistics.", "x-found-in": "query" }, "include_segment_file_sizes": { "type": "boolean", "description": "If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", "x-found-in": "query" }, "level": { "$ref": "./_types.json#/$defs/_types__NodeStatsLevel", "description": "Indicates whether statistics are aggregated at the node, indices, or shards level.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "types": { "type": "array", "items": { "type": "string" }, "description": "A comma-separated list of document types for the indexing index metric.", "x-found-in": "query" }, "include_unloaded_segments": { "type": "boolean", "description": "If `true`, the response includes information from segments that are not loaded into memory.", "x-found-in": "query" }, "node_id": { "$ref": "./_types.json#/$defs/_types__NodeIds", "description": "Comma-separated list of node IDs or names used to limit returned information.", "x-found-in": "path" }, "metric": { "$ref": "./nodes.stats.json#/$defs/nodes.stats__NodeStatsMetrics", "description": "Limits the information returned to the specific metrics.", "x-found-in": "path" }, "index_metric": { "$ref": "./_types.json#/$defs/_types__CommonStatsFlags", "description": "Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified.", "x-found-in": "path" } }, "description": "Get node statistics.\n\nGet statistics for nodes in a cluster.\nBy default, all stats are returned. You can limit the returned information by using metrics." }

package/lib/cjs/es/json/nodes.usage.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "nodes.usage", "type": "object", "properties": { "node_id": { "$ref": "./_types.json#/$defs/_types__NodeIds", "description": "A comma-separated list of node IDs or names to limit the returned information.\nUse `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.", "x-found-in": "path" }, "metric": { "$ref": "./nodes.usage.json#/$defs/nodes.usage__NodesUsageMetrics", "description": "Limits the information returned to the specific metrics.\nA comma-separated list of the following options: `_all`, `rest_actions`, `aggregations`.", "x-found-in": "path" }, "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" } }, "description": "Get feature usage information." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "nodes.usage", "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" }, "node_id": { "$ref": "./_types.json#/$defs/_types__NodeIds", "description": "A comma-separated list of node IDs or names to limit the returned information.\nUse `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.", "x-found-in": "path" }, "metric": { "$ref": "./nodes.usage.json#/$defs/nodes.usage__NodesUsageMetrics", "description": "Limits the information returned to the specific metrics.\nA comma-separated list of the following options: `_all`, `rest_actions`, `aggregations`.", "x-found-in": "path" } }, "description": "Get feature usage information." }

package/lib/cjs/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": { "$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" }, "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" } }, "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/cjs/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/cjs/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/cjs/es/json/put_script.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "put_script", "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the stored script or search template.\nIt must be unique within the cluster.", "x-found-in": "path" }, "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.\nIf you specify both this and the `<context>` path parameter, the API uses the request path parameter.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\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" } }, "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/cjs/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": { "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" }, "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" } }, "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/cjs/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": { "ruleset_id": { "type": "string", "description": "The unique identifier of the query ruleset to be created or updated.", "x-found-in": "path" }, "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" } }, "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/cjs/es/json/query_rules.test.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "query_rules.test", "type": "object", "properties": { "ruleset_id": { "type": "string", "description": "The unique identifier of the query ruleset to be created or updated", "x-found-in": "path" }, "match_criteria": { "type": "object", "additionalProperties": {}, "description": "The match criteria to apply to rules in the given query ruleset.\nMatch criteria should match the keys defined in the `criteria.metadata` field of the rule.", "x-found-in": "body" } }, "required": ["ruleset_id", "match_criteria"], "description": "Test a query ruleset.\n\nEvaluate match criteria against a query ruleset to identify the rules that would match that criteria." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "query_rules.test", "type": "object", "properties": { "match_criteria": { "type": "object", "additionalProperties": {}, "description": "The match criteria to apply to rules in the given query ruleset.\nMatch criteria should match the keys defined in the `criteria.metadata` field of the rule.", "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", "match_criteria"], "description": "Test a query ruleset.\n\nEvaluate match criteria against a query ruleset to identify the rules that would match that criteria." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rank_eval", "type": "object", "properties": { "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" }, "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" } }, "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/cjs/es/json/reindex_rethrottle.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "reindex_rethrottle", "type": "object", "properties": { "task_id": { "type": "string", "description": "The task identifier, returned when creating a reindex task, or by listing tasks via\n`GET /_reindex` or `GET /_tasks`.\nIn stack, can be either the original task ID or the task ID of the relocated task.", "x-found-in": "path" }, "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" }, "group_by": { "$ref": "./tasks._types.json#/$defs/tasks._types__GroupBy", "description": "The way to group the tasks in the response.\nWe recommend setting this to `none`, which provides the cleanest response format.", "x-found-in": "query" } }, "required": ["task_id", "requests_per_second"], "description": "Throttle a reindex operation.\n\nChange the maximum number of documents to index per second for a particular reindex operation.\nFor example, to unthrottle to unlimited documents per second:\n\n```\nPOST _reindex/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1\n```\n\nRethrottling that speeds up the query takes effect immediately.\nRethrottling that slows down the query will take effect after completing the current batch of documents.\nThis behavior prevents scroll timeouts.\n\nThis API follows reindex tasks across node-shutdown relocations, so callers can keep using\nthe original task ID throughout the lifetime of the operation.\nThe relocated task ID is also accepted and is followed transparently.\nIn either case, returned task IDs and timings reflect the original task, not its relocated successor.\n\nThe rethrottle may not have been applied to any tasks if either `node_failures` or `task_failures` are non-empty, or if the response contains\nno successfully rethrottled tasks — that is, no entries under `nodes` (returned with the default\n`group_by=nodes` in stack) or under `tasks` (returned in serverless, or in stack with\n`group_by=none` or `group_by=parents`)." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "reindex_rethrottle", "type": "object", "properties": { "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" }, "group_by": { "$ref": "./tasks._types.json#/$defs/tasks._types__GroupBy", "description": "The way to group the tasks in the response.\nWe recommend setting this to `none`, which provides the cleanest response format.", "x-found-in": "query" }, "task_id": { "type": "string", "description": "The task identifier, returned when creating a reindex task, or by listing tasks via\n`GET /_reindex` or `GET /_tasks`.\nIn stack, can be either the original task ID or the task ID of the relocated task.", "x-found-in": "path" } }, "required": ["task_id", "requests_per_second"], "description": "Throttle a reindex operation.\n\nChange the maximum number of documents to index per second for a particular reindex operation.\nFor example, to unthrottle to unlimited documents per second:\n\n```\nPOST _reindex/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1\n```\n\nRethrottling that speeds up the query takes effect immediately.\nRethrottling that slows down the query will take effect after completing the current batch of documents.\nThis behavior prevents scroll timeouts.\n\nThis API follows reindex tasks across node-shutdown relocations, so callers can keep using\nthe original task ID throughout the lifetime of the operation.\nThe relocated task ID is also accepted and is followed transparently.\nIn either case, returned task IDs and timings reflect the original task, not its relocated successor.\n\nThe rethrottle may not have been applied to any tasks if either `node_failures` or `task_failures` are non-empty, or if the response contains\nno successfully rethrottled tasks — that is, no entries under `nodes` (returned with the default\n`group_by=nodes` in stack) or under `tasks` (returned in serverless, or in stack with\n`group_by=none` or `group_by=parents`)." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "render_search_template", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the search template to render.\nIf no `source` is specified, this or the `<template-id>` request path parameter is required.\nIf you specify both this parameter and the `<template-id>` parameter, the API uses only `<template-id>`.", "x-found-in": "body" }, "file": { "type": "string", "x-found-in": "body" }, "params": { "type": "object", "additionalProperties": {}, "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.", "x-found-in": "body" }, "source": { "$ref": "./_types.json#/$defs/_types__ScriptSource", "description": "An inline search template.\nIt supports the same parameters as the search API's request body.\nThese parameters also support Mustache variables.\nIf no `id` or `<templated-id>` is specified, this parameter is required.", "x-found-in": "body" } }, "description": "Render a search template.\n\nRender a search template as a search request body." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "render_search_template", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the search template to render.\nIf no `source` is specified, this or the `id` request body parameter is required.", "x-found-in": "path" }, "file": { "type": "string", "x-found-in": "body" }, "params": { "type": "object", "additionalProperties": {}, "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.", "x-found-in": "body" }, "source": { "$ref": "./_types.json#/$defs/_types__ScriptSource", "description": "An inline search template.\nIt supports the same parameters as the search API's request body.\nThese parameters also support Mustache variables.\nIf no `id` or `<templated-id>` is specified, this parameter is required.", "x-found-in": "body" } }, "description": "Render a search template.\n\nRender a search template as a search request body." }

package/lib/cjs/es/json/rollup.put_job.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rollup.put_job", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the rollup job. This can be any alphanumeric string and uniquely identifies the\ndata that is associated with the rollup job. The ID is persistent; it is stored with the rolled\nup data. If you create a job, let it run for a while, then delete the job, the data that the job\nrolled up is still be associated with this job ID. You cannot create a new job with the same ID\nsince that could lead to problems with mismatched job configurations.", "x-found-in": "path" }, "cron": { "type": "string", "description": "A cron string which defines the intervals when the rollup job should be executed. When the interval\ntriggers, the indexer attempts to rollup the data in the index pattern. The cron pattern is unrelated\nto the time interval of the data being rolled up. For example, you may wish to create hourly rollups\nof your document but to only run the indexer on a daily basis at midnight, as defined by the cron. The\ncron pattern is defined just like a Watcher cron schedule.", "x-found-in": "body" }, "groups": { "$ref": "./rollup._types.json#/$defs/rollup._types__Groupings", "description": "Defines the grouping fields and aggregations that are defined for this rollup job. These fields will then be\navailable later for aggregating into buckets. These aggs and fields can be used in any combination. Think of\nthe groups configuration as defining a set of tools that can later be used in aggregations to partition the\ndata. Unlike raw data, we have to think ahead to which fields and aggregations might be used. Rollups provide\nenough flexibility that you simply need to determine which fields are needed, not in what order they are needed.", "x-found-in": "body" }, "index_pattern": { "type": "string", "description": "The index or index pattern to roll up. Supports wildcard-style patterns (`logstash-*`). The job attempts to\nrollup the entire index or index-pattern.", "x-found-in": "body" }, "metrics": { "type": "array", "items": { "$ref": "./rollup._types.json#/$defs/rollup._types__FieldMetric" }, "description": "Defines the metrics to collect for each grouping tuple. By default, only the doc_counts are collected for each\ngroup. To make rollup useful, you will often add metrics like averages, mins, maxes, etc. Metrics are defined\non a per-field basis and for each field you configure which metric should be collected.", "x-found-in": "body" }, "page_size": { "type": "number", "description": "The number of bucket results that are processed on each iteration of the rollup indexer. A larger value tends\nto execute faster, but requires more memory during processing. This value has no effect on how the data is\nrolled up; it is merely used for tweaking the speed or memory cost of the indexer.", "x-found-in": "body" }, "rollup_index": { "type": "string", "description": "The index that contains the rollup results. The index can be shared with other rollup jobs. The data is stored so that it doesn’t interfere with unrelated jobs.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Time to wait for the request to complete.", "x-found-in": "body" }, "headers": { "$ref": "./_types.json#/$defs/_types__HttpHeaders", "x-found-in": "body" } }, "required": ["id", "cron", "groups", "index_pattern", "page_size", "rollup_index"], "description": "Create a rollup job.\n\nWARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run.\n\nThe rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.\n\nThere are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.\n\nJobs are created in a `STOPPED` state. You can start them with the start rollup jobs API." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rollup.put_job", "type": "object", "properties": { "cron": { "type": "string", "description": "A cron string which defines the intervals when the rollup job should be executed. When the interval\ntriggers, the indexer attempts to rollup the data in the index pattern. The cron pattern is unrelated\nto the time interval of the data being rolled up. For example, you may wish to create hourly rollups\nof your document but to only run the indexer on a daily basis at midnight, as defined by the cron. The\ncron pattern is defined just like a Watcher cron schedule.", "x-found-in": "body" }, "groups": { "$ref": "./rollup._types.json#/$defs/rollup._types__Groupings", "description": "Defines the grouping fields and aggregations that are defined for this rollup job. These fields will then be\navailable later for aggregating into buckets. These aggs and fields can be used in any combination. Think of\nthe groups configuration as defining a set of tools that can later be used in aggregations to partition the\ndata. Unlike raw data, we have to think ahead to which fields and aggregations might be used. Rollups provide\nenough flexibility that you simply need to determine which fields are needed, not in what order they are needed.", "x-found-in": "body" }, "index_pattern": { "type": "string", "description": "The index or index pattern to roll up. Supports wildcard-style patterns (`logstash-*`). The job attempts to\nrollup the entire index or index-pattern.", "x-found-in": "body" }, "metrics": { "type": "array", "items": { "$ref": "./rollup._types.json#/$defs/rollup._types__FieldMetric" }, "description": "Defines the metrics to collect for each grouping tuple. By default, only the doc_counts are collected for each\ngroup. To make rollup useful, you will often add metrics like averages, mins, maxes, etc. Metrics are defined\non a per-field basis and for each field you configure which metric should be collected.", "x-found-in": "body" }, "page_size": { "type": "number", "description": "The number of bucket results that are processed on each iteration of the rollup indexer. A larger value tends\nto execute faster, but requires more memory during processing. This value has no effect on how the data is\nrolled up; it is merely used for tweaking the speed or memory cost of the indexer.", "x-found-in": "body" }, "rollup_index": { "type": "string", "description": "The index that contains the rollup results. The index can be shared with other rollup jobs. The data is stored so that it doesn’t interfere with unrelated jobs.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Time to wait for the request to complete.", "x-found-in": "body" }, "headers": { "$ref": "./_types.json#/$defs/_types__HttpHeaders", "x-found-in": "body" }, "id": { "type": "string", "description": "Identifier for the rollup job. This can be any alphanumeric string and uniquely identifies the\ndata that is associated with the rollup job. The ID is persistent; it is stored with the rolled\nup data. If you create a job, let it run for a while, then delete the job, the data that the job\nrolled up is still be associated with this job ID. You cannot create a new job with the same ID\nsince that could lead to problems with mismatched job configurations.", "x-found-in": "path" } }, "required": ["id", "cron", "groups", "index_pattern", "page_size", "rollup_index"], "description": "Create a rollup job.\n\nWARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run.\n\nThe rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.\n\nThere are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.\n\nJobs are created in a `STOPPED` state. You can start them with the start rollup jobs API." }

package/lib/cjs/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": { "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" }, "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" } }, "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/cjs/es/json/rollup.stop_job.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rollup.stop_job", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the rollup job.", "x-found-in": "path" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "If `wait_for_completion` is `true`, the API blocks for (at maximum) the specified duration while waiting for the job to stop.\nIf more than `timeout` time has passed, the API throws a timeout exception.\nNOTE: Even if a timeout occurs, the stop request is still processing and eventually moves the job to STOPPED.\nThe timeout simply means the API call itself timed out while waiting for the status change.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If set to `true`, causes the API to block until the indexer state completely stops.\nIf set to `false`, the API returns immediately and the indexer is stopped asynchronously in the background.", "x-found-in": "query" } }, "required": ["id"], "description": "Stop rollup jobs.\n\nIf you try to stop a job that does not exist, an exception occurs.\nIf you try to stop a job that is already stopped, nothing happens.\n\nSince only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped.\nThis is accomplished with the `wait_for_completion` query parameter, and optionally a timeout. For example:\n\n```\nPOST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s\n```\nThe parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed.\nIf the specified time elapses without the job moving to STOPPED, a timeout exception occurs." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rollup.stop_job", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "If `wait_for_completion` is `true`, the API blocks for (at maximum) the specified duration while waiting for the job to stop.\nIf more than `timeout` time has passed, the API throws a timeout exception.\nNOTE: Even if a timeout occurs, the stop request is still processing and eventually moves the job to STOPPED.\nThe timeout simply means the API call itself timed out while waiting for the status change.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If set to `true`, causes the API to block until the indexer state completely stops.\nIf set to `false`, the API returns immediately and the indexer is stopped asynchronously in the background.", "x-found-in": "query" }, "id": { "type": "string", "description": "Identifier for the rollup job.", "x-found-in": "path" } }, "required": ["id"], "description": "Stop rollup jobs.\n\nIf you try to stop a job that does not exist, an exception occurs.\nIf you try to stop a job that is already stopped, nothing happens.\n\nSince only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped.\nThis is accomplished with the `wait_for_completion` query parameter, and optionally a timeout. For example:\n\n```\nPOST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s\n```\nThe parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed.\nIf the specified time elapses without the job moving to STOPPED, a timeout exception occurs." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "scroll", "type": "object", "properties": { "scroll_id": { "type": "string", "description": "The scroll ID of the search.", "x-found-in": "body" }, "scroll": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to retain the search context for scrolling.", "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." }