@elastic/schemas 0.5.1 → 0.6.0

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

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

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rank_eval", "description": "Evaluate ranked search results.\n\nEvaluate the quality of ranked search results over a set of typical search queries.", "x-api": { "id": "rank_eval", "name": "rank-eval", "namespace": null }, "x-method": "GET", "x-path": "/{index}/_rank_eval", "x-urls": [{ "path": "/_rank_eval", "methods": ["GET", "POST"] }, { "path": "/{index}/_rank_eval", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rank_eval", "description": "Evaluate ranked search results.\n\nEvaluate the quality of ranked search results over a set of typical search queries.", "x-api": { "id": "rank_eval", "name": "rank-eval", "namespace": null }, "x-method": "GET", "x-path": "/{index}/_rank_eval", "x-urls": [{ "path": "/_rank_eval", "methods": ["GET", "POST"] }, { "path": "/{index}/_rank_eval", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["requests"] }

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

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

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

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

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

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

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rollup.delete_job", "description": "Delete a rollup job.\n\nA job must be stopped before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n  \"query\": {\n    \"term\": {\n      \"_rollup.id\": \"the_rollup_job_id\"\n    }\n  }\n}\n```", "x-api": { "id": "rollup.delete_job", "name": "delete-job", "namespace": "rollup" }, "x-method": "DELETE", "x-path": "/_rollup/job/{id}", "x-urls": [{ "path": "/_rollup/job/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.3.0", "stability": "experimental" } }, "x-deprecated": { "since": "8.11.0" }, "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the job.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rollup.delete_job", "description": "Delete a rollup job.\n\nA job must be stopped before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n  \"query\": {\n    \"term\": {\n      \"_rollup.id\": \"the_rollup_job_id\"\n    }\n  }\n}\n```", "x-api": { "id": "rollup.delete_job", "name": "delete-job", "namespace": "rollup" }, "x-method": "DELETE", "x-path": "/_rollup/job/{id}", "x-urls": [{ "path": "/_rollup/job/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.3.0", "stability": "experimental" } }, "x-deprecated": { "since": "8.11.0" }, "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the job.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rollup.get_jobs", "description": "Get rollup job information.\n\nGet the configuration, stats, and status of rollup jobs.\n\nNOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs.\nIf a job was created, ran for a while, then was deleted, the API does not return any details about it.\nFor details about a historical rollup job, the rollup capabilities API may be more useful.", "x-api": { "id": "rollup.get_jobs", "name": "get-jobs", "namespace": "rollup" }, "x-method": "GET", "x-path": "/_rollup/job/{id}", "x-urls": [{ "path": "/_rollup/job/{id}", "methods": ["GET"] }, { "path": "/_rollup/job", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.3.0", "stability": "experimental" } }, "x-deprecated": { "since": "8.11.0" }, "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the rollup job.\nIf it is `_all` or omitted, the API returns all rollup jobs.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rollup.get_jobs", "description": "Get rollup job information.\n\nGet the configuration, stats, and status of rollup jobs.\n\nNOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs.\nIf a job was created, ran for a while, then was deleted, the API does not return any details about it.\nFor details about a historical rollup job, the rollup capabilities API may be more useful.", "x-api": { "id": "rollup.get_jobs", "name": "get-jobs", "namespace": "rollup" }, "x-method": "GET", "x-path": "/_rollup/job/{id}", "x-urls": [{ "path": "/_rollup/job/{id}", "methods": ["GET"] }, { "path": "/_rollup/job", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.3.0", "stability": "experimental" } }, "x-deprecated": { "since": "8.11.0" }, "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the rollup job.\nIf it is `_all` or omitted, the API returns all rollup jobs.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rollup.get_rollup_caps", "description": "Get the rollup job capabilities.\n\nGet the capabilities of any rollup jobs that have been configured for a specific index or index pattern.\n\nThis API is useful because a rollup job is often configured to rollup only a subset of fields from the source index.\nFurthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.\nThis API enables you to inspect an index and determine:\n\n1. Does this index have associated rollup data somewhere in the cluster?\n2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?", "x-api": { "id": "rollup.get_rollup_caps", "name": "get-rollup-caps", "namespace": "rollup" }, "x-method": "GET", "x-path": "/_rollup/data/{id}", "x-urls": [{ "path": "/_rollup/data/{id}", "methods": ["GET"] }, { "path": "/_rollup/data", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.3.0", "stability": "experimental" } }, "x-deprecated": { "since": "8.11.0" }, "type": "object", "properties": { "id": { "type": "string", "description": "Index, indices or index-pattern to return rollup capabilities for.\n`_all` may be used to fetch rollup capabilities from all jobs.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rollup.get_rollup_caps", "description": "Get the rollup job capabilities.\n\nGet the capabilities of any rollup jobs that have been configured for a specific index or index pattern.\n\nThis API is useful because a rollup job is often configured to rollup only a subset of fields from the source index.\nFurthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.\nThis API enables you to inspect an index and determine:\n\n1. Does this index have associated rollup data somewhere in the cluster?\n2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?", "x-api": { "id": "rollup.get_rollup_caps", "name": "get-rollup-caps", "namespace": "rollup" }, "x-method": "GET", "x-path": "/_rollup/data/{id}", "x-urls": [{ "path": "/_rollup/data/{id}", "methods": ["GET"] }, { "path": "/_rollup/data", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.3.0", "stability": "experimental" } }, "x-deprecated": { "since": "8.11.0" }, "type": "object", "properties": { "id": { "type": "string", "description": "Index, indices or index-pattern to return rollup capabilities for.\n`_all` may be used to fetch rollup capabilities from all jobs.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rollup.get_rollup_index_caps", "description": "Get the rollup index capabilities.\n\nGet the rollup capabilities of all jobs inside of a rollup index.\nA single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:\n\n* What jobs are stored in an index (or indices specified via a pattern)?\n* What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?", "x-api": { "id": "rollup.get_rollup_index_caps", "name": "get-rollup-index-caps", "namespace": "rollup" }, "x-method": "GET", "x-path": "/{index}/_rollup/data", "x-urls": [{ "path": "/{index}/_rollup/data", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.4.0", "stability": "experimental" } }, "x-deprecated": { "since": "8.11.0" }, "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "Data stream or index to check for rollup capabilities.\nWildcard (`*`) expressions are supported.", "x-found-in": "path" } }, "required": ["index"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rollup.get_rollup_index_caps", "description": "Get the rollup index capabilities.\n\nGet the rollup capabilities of all jobs inside of a rollup index.\nA single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:\n\n* What jobs are stored in an index (or indices specified via a pattern)?\n* What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?", "x-api": { "id": "rollup.get_rollup_index_caps", "name": "get-rollup-index-caps", "namespace": "rollup" }, "x-method": "GET", "x-path": "/{index}/_rollup/data", "x-urls": [{ "path": "/{index}/_rollup/data", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.4.0", "stability": "experimental" } }, "x-deprecated": { "since": "8.11.0" }, "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "Data stream or index to check for rollup capabilities.\nWildcard (`*`) expressions are supported.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["index"] }

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

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

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rollup.start_job", "description": "Start rollup jobs.\n\nIf you try to start a job that does not exist, an exception occurs.\nIf you try to start a job that is already started, nothing happens.", "x-api": { "id": "rollup.start_job", "name": "start-job", "namespace": "rollup" }, "x-method": "POST", "x-path": "/_rollup/job/{id}/_start", "x-urls": [{ "path": "/_rollup/job/{id}/_start", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.3.0", "stability": "experimental" } }, "x-deprecated": { "since": "8.11.0" }, "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the rollup job.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "rollup.start_job", "description": "Start rollup jobs.\n\nIf you try to start a job that does not exist, an exception occurs.\nIf you try to start a job that is already started, nothing happens.", "x-api": { "id": "rollup.start_job", "name": "start-job", "namespace": "rollup" }, "x-method": "POST", "x-path": "/_rollup/job/{id}/_start", "x-urls": [{ "path": "/_rollup/job/{id}/_start", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.3.0", "stability": "experimental" } }, "x-deprecated": { "since": "8.11.0" }, "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the rollup job.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id"] }

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

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

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "scripts_painless_execute", "description": "Run a script.\n\nRuns a script and returns a result.\nUse this API to build and test scripts, such as when defining a script for a runtime field.\nThis API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster.\n\nThe API uses several _contexts_, which control how scripts are run, what variables are available at runtime, and what the return type is.\n\nEach context requires a script, but additional parameters depend on the context you're using for that script.", "x-api": { "id": "scripts_painless_execute", "name": "scripts-painless-execute", "namespace": null }, "x-method": "GET", "x-path": "/_scripts/painless/_execute", "x-urls": [{ "path": "/_scripts/painless/_execute", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.3.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "type": "object", "properties": { "context": { "$ref": "./_global.scripts_painless_execute.json#/$defs/_global.scripts_painless_execute__PainlessContext", "description": "The context that the script should run in.\nNOTE: Result ordering in the field contexts is not guaranteed.", "x-found-in": "body" }, "context_setup": { "$ref": "./_global.scripts_painless_execute.json#/$defs/_global.scripts_painless_execute__PainlessContextSetup", "description": "Additional parameters for the `context`.\nNOTE: This parameter is required for all contexts except `painless_test`, which is the default if no value is provided for `context`.", "x-found-in": "body" }, "script": { "$ref": "./_types.json#/$defs/_types__Script", "description": "The Painless script to run.", "x-found-in": "body" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "scripts_painless_execute", "description": "Run a script.\n\nRuns a script and returns a result.\nUse this API to build and test scripts, such as when defining a script for a runtime field.\nThis API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster.\n\nThe API uses several _contexts_, which control how scripts are run, what variables are available at runtime, and what the return type is.\n\nEach context requires a script, but additional parameters depend on the context you're using for that script.", "x-api": { "id": "scripts_painless_execute", "name": "scripts-painless-execute", "namespace": null }, "x-method": "GET", "x-path": "/_scripts/painless/_execute", "x-urls": [{ "path": "/_scripts/painless/_execute", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.3.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "type": "object", "properties": { "context": { "$ref": "./_global.scripts_painless_execute.json#/$defs/_global.scripts_painless_execute__PainlessContext", "description": "The context that the script should run in.\nNOTE: Result ordering in the field contexts is not guaranteed.", "x-found-in": "body" }, "context_setup": { "$ref": "./_global.scripts_painless_execute.json#/$defs/_global.scripts_painless_execute__PainlessContextSetup", "description": "Additional parameters for the `context`.\nNOTE: This parameter is required for all contexts except `painless_test`, which is the default if no value is provided for `context`.", "x-found-in": "body" }, "script": { "$ref": "./_types.json#/$defs/_types__Script", "description": "The Painless script to run.", "x-found-in": "body" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

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

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

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search", "description": "Run a search.\n\nGet search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.\n\nIf the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.\nTo search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.\n\n**Search slicing**\n\nWhen paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties.\nBy default the splitting is done first on the shards, then locally on each shard.\n\nFor instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.\n\nIMPORTANT: The same point-in-time ID should be used for all slices.\nIf different PIT IDs are used, slices can overlap and miss documents.\nThis situation can occur because, by default, the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.", "x-api": { "id": "search", "name": "search", "namespace": null }, "x-method": "GET", "x-path": "/{index}/_search", "x-urls": [{ "path": "/_search", "methods": ["GET", "POST"] }, { "path": "/{index}/_search", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "allow_partial_search_results": { "type": "boolean", "description": "If `true` and there are shard request timeouts or shard failures, the request returns partial results.\nIf `false`, it returns an error with no partial results.\n\nTo override the default behavior, you can set the `search.default_allow_partial_results` cluster setting to `false`.", "x-found-in": "query" }, "analyzer": { "type": "string", "description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "analyze_wildcard": { "type": "boolean", "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "batched_reduce_size": { "type": "number", "description": "The number of shard results that should be reduced at once on the coordinating node.\nIf the potential number of shards in the request can be large, this value should be used as a protection mechanism to reduce the memory overhead per search request.", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "If `true`, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests.", "x-found-in": "query" }, "default_operator": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__Operator", "description": "The default operator for the query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "df": { "type": "string", "description": "The field to use as a default when no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "docvalue_fields": { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, "description": "An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.", "x-found-in": "body" }, "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" }, "explain": { "type": "boolean", "description": "If `true`, the request returns detailed information about score computation as part of a hit.", "x-found-in": "body" }, "ignore_throttled": { "type": "boolean", "description": "If `true`, concrete, expanded or aliased indices will be ignored when frozen.", "x-found-in": "query", "x-deprecated": { "since": "7.16.0" } }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "include_named_queries_score": { "type": "boolean", "description": "If `true`, the response includes the score contribution from any named queries.\n\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" }, "lenient": { "type": "boolean", "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "max_concurrent_shard_requests": { "type": "number", "description": "The number of concurrent shard requests per node that the search runs concurrently.\nThis value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", "x-found-in": "query" }, "preference": { "type": "string", "description": "The nodes and shards used for the search.\nBy default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness.\nValid values are:\n\n* `_only_local` to run the search only on shards on the local node.\n* `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method.\n* `_only_nodes:<node-id>,<node-id>` to run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method.\n* `_prefer_nodes:<node-id>,<node-id>` to if possible, run the search on the specified nodes IDs. If not, select shards using the default method.\n* `_shards:<shard>,<shard>` to run the search only on the specified shards. You can combine this value with other `preference` values. However, the `_shards` value must come first. For example: `_shards:2,3|_local`.\n* `<custom-string>` (any string that does not start with `_`) to route searches with the same `<custom-string>` to the same shards in the same order.", "x-found-in": "query" }, "pre_filter_shard_size": { "type": "number", "description": "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.\nThis filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint).\nWhen unspecified, the pre-filter phase is executed if any of these conditions is met:\n\n* The request targets more than 128 shards.\n* The request targets one or more read-only index.\n* The primary sort of the query targets an indexed field.", "x-found-in": "query" }, "request_cache": { "type": "boolean", "description": "If `true`, the caching of search results is enabled for requests where `size` is `0`.\nIt defaults to index level settings.", "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.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.", "x-found-in": "query" }, "scroll": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to retain the search context for scrolling.\nBy default, this value cannot exceed `1d` (24 hours).\nYou can change this limit by using the `search.max_keep_alive` cluster-level setting.", "x-found-in": "query" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "description": "Indicates how distributed term frequencies are calculated for relevance scoring.", "x-found-in": "query" }, "stats": { "type": "array", "items": { "type": "string" }, "description": "The stats groups to associate with the search.\nEach group maintains a statistics aggregation for its associated searches.\nYou can retrieve these stats using the indices stats API.", "x-found-in": "body" }, "stored_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", "x-found-in": "body" }, "suggest_field": { "type": "string", "description": "The field to use for suggestions.", "x-found-in": "query" }, "suggest_mode": { "$ref": "./_types.json#/$defs/_types__SuggestMode", "description": "The suggest mode.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.", "x-found-in": "query" }, "suggest_size": { "type": "number", "description": "The number of suggestions to return.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.", "x-found-in": "query" }, "suggest_text": { "type": "string", "description": "The source text for which the suggestions should be returned.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.", "x-found-in": "query" }, "terminate_after": { "type": "number", "description": "The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this property to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this property for requests that target data streams with backing indices across multiple data tiers.\n\nIf set to `0` (default), the query does not terminate early.", "x-found-in": "body" }, "timeout": { "type": "string", "description": "The period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", "x-found-in": "body" }, "track_total_hits": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__TrackHits", "description": "Number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the  response does not include the total number of hits matching the query.", "x-found-in": "body" }, "track_scores": { "type": "boolean", "description": "If `true`, calculate and return document scores, even if the scores are not used for sorting.", "x-found-in": "body" }, "typed_keys": { "type": "boolean", "description": "If `true`, aggregation and suggester names are be prefixed by their respective types in the response.", "x-found-in": "query" }, "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" }, "version": { "type": "boolean", "description": "If `true`, the request returns the document version as part of a hit.", "x-found-in": "body" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfig", "description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`.", "x-found-in": "body" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "_source_exclude_vectors": { "type": "boolean", "description": "Whether vectors should be excluded from _source", "x-found-in": "query", "x-availability": { "stack": { "since": "9.2.0" }, "serverless": {} } }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "seq_no_primary_term": { "type": "boolean", "description": "If `true`, the request returns sequence number and primary term of the last modification of each hit.", "x-found-in": "body" }, "q": { "type": "string", "description": "A query in the Lucene query string syntax.\nQuery parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.\n\nIMPORTANT: This parameter overrides the query parameter in the request body.\nIf both parameters are specified, documents matching the query request body parameter are not returned.", "x-found-in": "query" }, "size": { "type": "number", "description": "The number of hits to return, which must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` property.", "x-found-in": "body" }, "from": { "type": "number", "description": "The starting document offset, which must be non-negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", "x-found-in": "body" }, "sort": { "$ref": "./_types.json#/$defs/_types__Sort", "description": "A comma-separated list of <field>:<direction> pairs.", "x-found-in": "body" }, "aggregations": { "type": "object", "additionalProperties": { "$ref": "./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer" }, "description": "Defines the aggregations that are run as part of the search request.", "x-found-in": "body" }, "collapse": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__FieldCollapse", "description": "Collapses search results the values of the specified field.", "x-found-in": "body" }, "ext": { "type": "object", "additionalProperties": {}, "description": "Configuration of search extensions defined by Elasticsearch plugins.", "x-found-in": "body" }, "highlight": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Highlight", "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.", "x-found-in": "body" }, "indices_boost": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "number" } }, "description": "Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score.", "x-found-in": "body" }, "knn": { "anyOf": [{ "$ref": "./_types.json#/$defs/_types__KnnSearch" }, { "type": "array", "items": { "$ref": "./_types.json#/$defs/_types__KnnSearch" } }], "description": "The approximate kNN search to run.", "x-found-in": "body", "x-availability": { "stack": { "since": "8.4.0" }, "serverless": {} } }, "rank": { "$ref": "./_types.json#/$defs/_types__RankContainer", "description": "The Reciprocal Rank Fusion (RRF) to use.", "x-found-in": "body", "x-availability": { "stack": { "since": "8.8.0" } } }, "min_score": { "type": "number", "description": "The minimum `_score` for matching documents.\nDocuments with a lower `_score` are not included in search results and results collected by aggregations.", "x-found-in": "body" }, "post_filter": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Use the `post_filter` parameter to filter search results.\nThe search hits are filtered after the aggregations are calculated.\nA post filter has no impact on the aggregation results.", "x-found-in": "body" }, "profile": { "type": "boolean", "description": "Set to `true` to return detailed timing information about the execution of individual components in a search request.\nNOTE: This is a debugging tool and adds significant overhead to search execution.", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "The search definition using the Query DSL.", "x-found-in": "body" }, "rescore": { "anyOf": [{ "$ref": "./_global.search._types.json#/$defs/_global.search._types__Rescore" }, { "type": "array", "items": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Rescore" } }], "description": "Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.", "x-found-in": "body" }, "retriever": { "$ref": "./_types.json#/$defs/_types__RetrieverContainer", "description": "A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.", "x-found-in": "body", "x-availability": { "stack": { "since": "8.14.0", "stability": "stable" }, "serverless": { "stability": "stable" } } }, "script_fields": { "type": "object", "additionalProperties": { "$ref": "./_types.json#/$defs/_types__ScriptField" }, "description": "Retrieve a script evaluation (based on different fields) for each hit.", "x-found-in": "body" }, "search_after": { "$ref": "./_types.json#/$defs/_types__SortResults", "description": "Used to retrieve the next page of hits using a set of sort values from the previous page.", "x-found-in": "body" }, "slice": { "$ref": "./_types.json#/$defs/_types__SlicedScroll", "description": "Split a scrolled search into multiple slices that can be consumed independently.", "x-found-in": "body" }, "fields": { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, "description": "An array of wildcard (`*`) field patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response.", "x-found-in": "body" }, "suggest": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Suggester", "description": "Defines a suggester that provides similar looking terms based on a provided text.", "x-found-in": "body" }, "pit": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__PointInTimeReference", "description": "Limit the search to a point in time (PIT).\nIf you provide a PIT, you cannot specify an `<index>` in the request path.", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "description": "One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.", "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 `*` or `_all`.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search", "description": "Run a search.\n\nGet search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.\n\nIf the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.\nTo search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.\n\n**Search slicing**\n\nWhen paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties.\nBy default the splitting is done first on the shards, then locally on each shard.\n\nFor instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.\n\nIMPORTANT: The same point-in-time ID should be used for all slices.\nIf different PIT IDs are used, slices can overlap and miss documents.\nThis situation can occur because, by default, the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.", "x-api": { "id": "search", "name": "search", "namespace": null }, "x-method": "GET", "x-path": "/{index}/_search", "x-urls": [{ "path": "/_search", "methods": ["GET", "POST"] }, { "path": "/{index}/_search", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "allow_partial_search_results": { "type": "boolean", "description": "If `true` and there are shard request timeouts or shard failures, the request returns partial results.\nIf `false`, it returns an error with no partial results.\n\nTo override the default behavior, you can set the `search.default_allow_partial_results` cluster setting to `false`.", "x-found-in": "query" }, "analyzer": { "type": "string", "description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "analyze_wildcard": { "type": "boolean", "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "batched_reduce_size": { "type": "number", "description": "The number of shard results that should be reduced at once on the coordinating node.\nIf the potential number of shards in the request can be large, this value should be used as a protection mechanism to reduce the memory overhead per search request.", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "If `true`, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests.", "x-found-in": "query" }, "default_operator": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__Operator", "description": "The default operator for the query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "df": { "type": "string", "description": "The field to use as a default when no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "docvalue_fields": { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, "description": "An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.", "x-found-in": "body" }, "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" }, "explain": { "type": "boolean", "description": "If `true`, the request returns detailed information about score computation as part of a hit.", "x-found-in": "body" }, "ignore_throttled": { "type": "boolean", "description": "If `true`, concrete, expanded or aliased indices will be ignored when frozen.", "x-found-in": "query", "x-deprecated": { "since": "7.16.0" } }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "include_named_queries_score": { "type": "boolean", "description": "If `true`, the response includes the score contribution from any named queries.\n\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" }, "lenient": { "type": "boolean", "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "max_concurrent_shard_requests": { "type": "number", "description": "The number of concurrent shard requests per node that the search runs concurrently.\nThis value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", "x-found-in": "query" }, "preference": { "type": "string", "description": "The nodes and shards used for the search.\nBy default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness.\nValid values are:\n\n* `_only_local` to run the search only on shards on the local node.\n* `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method.\n* `_only_nodes:<node-id>,<node-id>` to run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method.\n* `_prefer_nodes:<node-id>,<node-id>` to if possible, run the search on the specified nodes IDs. If not, select shards using the default method.\n* `_shards:<shard>,<shard>` to run the search only on the specified shards. You can combine this value with other `preference` values. However, the `_shards` value must come first. For example: `_shards:2,3|_local`.\n* `<custom-string>` (any string that does not start with `_`) to route searches with the same `<custom-string>` to the same shards in the same order.", "x-found-in": "query" }, "pre_filter_shard_size": { "type": "number", "description": "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.\nThis filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint).\nWhen unspecified, the pre-filter phase is executed if any of these conditions is met:\n\n* The request targets more than 128 shards.\n* The request targets one or more read-only index.\n* The primary sort of the query targets an indexed field.", "x-found-in": "query" }, "request_cache": { "type": "boolean", "description": "If `true`, the caching of search results is enabled for requests where `size` is `0`.\nIt defaults to index level settings.", "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.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.", "x-found-in": "query" }, "scroll": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to retain the search context for scrolling.\nBy default, this value cannot exceed `1d` (24 hours).\nYou can change this limit by using the `search.max_keep_alive` cluster-level setting.", "x-found-in": "query" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "description": "Indicates how distributed term frequencies are calculated for relevance scoring.", "x-found-in": "query" }, "stats": { "type": "array", "items": { "type": "string" }, "description": "The stats groups to associate with the search.\nEach group maintains a statistics aggregation for its associated searches.\nYou can retrieve these stats using the indices stats API.", "x-found-in": "body" }, "stored_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", "x-found-in": "body" }, "suggest_field": { "type": "string", "description": "The field to use for suggestions.", "x-found-in": "query" }, "suggest_mode": { "$ref": "./_types.json#/$defs/_types__SuggestMode", "description": "The suggest mode.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.", "x-found-in": "query" }, "suggest_size": { "type": "number", "description": "The number of suggestions to return.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.", "x-found-in": "query" }, "suggest_text": { "type": "string", "description": "The source text for which the suggestions should be returned.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.", "x-found-in": "query" }, "terminate_after": { "type": "number", "description": "The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this property to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this property for requests that target data streams with backing indices across multiple data tiers.\n\nIf set to `0` (default), the query does not terminate early.", "x-found-in": "body" }, "timeout": { "type": "string", "description": "The period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", "x-found-in": "body" }, "track_total_hits": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__TrackHits", "description": "Number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the  response does not include the total number of hits matching the query.", "x-found-in": "body" }, "track_scores": { "type": "boolean", "description": "If `true`, calculate and return document scores, even if the scores are not used for sorting.", "x-found-in": "body" }, "typed_keys": { "type": "boolean", "description": "If `true`, aggregation and suggester names are be prefixed by their respective types in the response.", "x-found-in": "query" }, "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" }, "version": { "type": "boolean", "description": "If `true`, the request returns the document version as part of a hit.", "x-found-in": "body" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfig", "description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`.", "x-found-in": "body" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "_source_exclude_vectors": { "type": "boolean", "description": "Whether vectors should be excluded from _source", "x-found-in": "query", "x-availability": { "stack": { "since": "9.2.0" }, "serverless": {} } }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "seq_no_primary_term": { "type": "boolean", "description": "If `true`, the request returns sequence number and primary term of the last modification of each hit.", "x-found-in": "body" }, "q": { "type": "string", "description": "A query in the Lucene query string syntax.\nQuery parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.\n\nIMPORTANT: This parameter overrides the query parameter in the request body.\nIf both parameters are specified, documents matching the query request body parameter are not returned.", "x-found-in": "query" }, "size": { "type": "number", "description": "The number of hits to return, which must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` property.", "x-found-in": "body" }, "from": { "type": "number", "description": "The starting document offset, which must be non-negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", "x-found-in": "body" }, "sort": { "$ref": "./_types.json#/$defs/_types__Sort", "description": "A comma-separated list of <field>:<direction> pairs.", "x-found-in": "body" }, "aggregations": { "type": "object", "additionalProperties": { "$ref": "./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer" }, "description": "Defines the aggregations that are run as part of the search request.", "x-found-in": "body" }, "collapse": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__FieldCollapse", "description": "Collapses search results the values of the specified field.", "x-found-in": "body" }, "ext": { "type": "object", "additionalProperties": {}, "description": "Configuration of search extensions defined by Elasticsearch plugins.", "x-found-in": "body" }, "highlight": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Highlight", "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.", "x-found-in": "body" }, "indices_boost": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "number" }, "minProperties": 1, "maxProperties": 1 }, "description": "Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score.", "x-found-in": "body" }, "knn": { "anyOf": [{ "$ref": "./_types.json#/$defs/_types__KnnSearch" }, { "type": "array", "items": { "$ref": "./_types.json#/$defs/_types__KnnSearch" } }], "description": "The approximate kNN search to run.", "x-found-in": "body", "x-availability": { "stack": { "since": "8.4.0" }, "serverless": {} } }, "rank": { "$ref": "./_types.json#/$defs/_types__RankContainer", "description": "The Reciprocal Rank Fusion (RRF) to use.", "x-found-in": "body", "x-availability": { "stack": { "since": "8.8.0" } } }, "min_score": { "type": "number", "description": "The minimum `_score` for matching documents.\nDocuments with a lower `_score` are not included in search results and results collected by aggregations.", "x-found-in": "body" }, "post_filter": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Use the `post_filter` parameter to filter search results.\nThe search hits are filtered after the aggregations are calculated.\nA post filter has no impact on the aggregation results.", "x-found-in": "body" }, "profile": { "type": "boolean", "description": "Set to `true` to return detailed timing information about the execution of individual components in a search request.\nNOTE: This is a debugging tool and adds significant overhead to search execution.", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "The search definition using the Query DSL.", "x-found-in": "body" }, "rescore": { "anyOf": [{ "$ref": "./_global.search._types.json#/$defs/_global.search._types__Rescore" }, { "type": "array", "items": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Rescore" } }], "description": "Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.", "x-found-in": "body" }, "retriever": { "$ref": "./_types.json#/$defs/_types__RetrieverContainer", "description": "A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.", "x-found-in": "body", "x-availability": { "stack": { "since": "8.14.0", "stability": "stable" }, "serverless": { "stability": "stable" } } }, "script_fields": { "type": "object", "additionalProperties": { "$ref": "./_types.json#/$defs/_types__ScriptField" }, "description": "Retrieve a script evaluation (based on different fields) for each hit.", "x-found-in": "body" }, "search_after": { "$ref": "./_types.json#/$defs/_types__SortResults", "description": "Used to retrieve the next page of hits using a set of sort values from the previous page.", "x-found-in": "body" }, "slice": { "$ref": "./_types.json#/$defs/_types__SlicedScroll", "description": "Split a scrolled search into multiple slices that can be consumed independently.", "x-found-in": "body" }, "fields": { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, "description": "An array of wildcard (`*`) field patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response.", "x-found-in": "body" }, "suggest": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Suggester", "description": "Defines a suggester that provides similar looking terms based on a provided text.", "x-found-in": "body" }, "pit": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__PointInTimeReference", "description": "Limit the search to a point in time (PIT).\nIf you provide a PIT, you cannot specify an `<index>` in the request path.", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "description": "One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.", "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 `*` or `_all`.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_application.delete", "description": "Delete a search application.\n\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", "x-api": { "id": "search-application.delete", "name": "delete", "namespace": "search-application" }, "x-method": "DELETE", "x-path": "/_application/search_application/{name}", "x-urls": [{ "path": "/_application/search_application/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.8.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "type": "object", "properties": { "name": { "type": "string", "description": "The name of the search application to delete.", "x-found-in": "path" } }, "required": ["name"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_application.delete", "description": "Delete a search application.\n\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", "x-api": { "id": "search-application.delete", "name": "delete", "namespace": "search-application" }, "x-method": "DELETE", "x-path": "/_application/search_application/{name}", "x-urls": [{ "path": "/_application/search_application/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.8.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "type": "object", "properties": { "name": { "type": "string", "description": "The name of the search application to delete.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["name"] }

package/lib/cjs/es/json/search_application.delete_behavioral_analytics.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_application.delete_behavioral_analytics", "description": "Delete a behavioral analytics collection.\n\nThe associated data stream is also deleted.", "x-api": { "id": "search-application.delete_behavioral_analytics", "name": "delete-behavioral-analytics", "namespace": "search-application" }, "x-method": "DELETE", "x-path": "/_application/analytics/{name}", "x-urls": [{ "path": "/_application/analytics/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.8.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "x-deprecated": { "since": "9.0.0" }, "type": "object", "properties": { "name": { "type": "string", "description": "The name of the analytics collection to be deleted", "x-found-in": "path" } }, "required": ["name"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_application.delete_behavioral_analytics", "description": "Delete a behavioral analytics collection.\n\nThe associated data stream is also deleted.", "x-api": { "id": "search-application.delete_behavioral_analytics", "name": "delete-behavioral-analytics", "namespace": "search-application" }, "x-method": "DELETE", "x-path": "/_application/analytics/{name}", "x-urls": [{ "path": "/_application/analytics/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.8.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "x-deprecated": { "since": "9.0.0" }, "type": "object", "properties": { "name": { "type": "string", "description": "The name of the analytics collection to be deleted", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["name"] }

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

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

package/lib/cjs/es/json/search_application.get_behavioral_analytics.request.json

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

package/lib/cjs/es/json/search_application.list.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_application.list", "description": "Get search applications.\n\nGet information about search applications.", "x-api": { "id": "search-application.list", "name": "list", "namespace": "search-application" }, "x-method": "GET", "x-path": "/_application/search_application", "x-urls": [{ "path": "/_application/search_application", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.8.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "type": "object", "properties": { "q": { "type": "string", "description": "Query in the Lucene query string syntax.", "x-found-in": "query" }, "from": { "type": "number", "description": "Starting offset.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies a max number of results to get.", "x-found-in": "query" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_application.list", "description": "Get search applications.\n\nGet information about search applications.", "x-api": { "id": "search-application.list", "name": "list", "namespace": "search-application" }, "x-method": "GET", "x-path": "/_application/search_application", "x-urls": [{ "path": "/_application/search_application", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.8.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "type": "object", "properties": { "q": { "type": "string", "description": "Query in the Lucene query string syntax.", "x-found-in": "query" }, "from": { "type": "number", "description": "Starting offset.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies a max number of results to get.", "x-found-in": "query" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/search_application.post_behavioral_analytics_event.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_application.post_behavioral_analytics_event", "description": "Create a behavioral analytics collection event.", "x-api": { "id": "search-application.post_behavioral_analytics_event", "name": "post-behavioral-analytics-event", "namespace": "search-application" }, "x-method": "POST", "x-path": "/_application/analytics/{collection_name}/event/{event_type}", "x-urls": [{ "path": "/_application/analytics/{collection_name}/event/{event_type}", "methods": ["POST"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "x-deprecated": { "since": "9.0.0" }, "type": "object", "properties": { "debug": { "type": "boolean", "description": "Whether the response type has to include more details", "x-found-in": "query" }, "payload": { "x-found-in": "body", "x-body-root": true }, "collection_name": { "type": "string", "description": "The name of the behavioral analytics collection.", "x-found-in": "path" }, "event_type": { "$ref": "./search_application._types.json#/$defs/search_application._types__EventType", "description": "The analytics event type.", "x-found-in": "path" } }, "required": ["collection_name", "event_type"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_application.post_behavioral_analytics_event", "description": "Create a behavioral analytics collection event.", "x-api": { "id": "search-application.post_behavioral_analytics_event", "name": "post-behavioral-analytics-event", "namespace": "search-application" }, "x-method": "POST", "x-path": "/_application/analytics/{collection_name}/event/{event_type}", "x-urls": [{ "path": "/_application/analytics/{collection_name}/event/{event_type}", "methods": ["POST"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "x-deprecated": { "since": "9.0.0" }, "type": "object", "properties": { "debug": { "type": "boolean", "description": "Whether the response type has to include more details", "x-found-in": "query" }, "payload": { "x-found-in": "body", "x-body-root": true }, "collection_name": { "type": "string", "description": "The name of the behavioral analytics collection.", "x-found-in": "path" }, "event_type": { "$ref": "./search_application._types.json#/$defs/search_application._types__EventType", "description": "The analytics event type.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["collection_name", "event_type"] }