@elastic/schemas 0.4.3 → 0.4.4

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

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

package/lib/cjs/es/json/query_rules.test.request.json

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search", "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" }, "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "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" }, "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" }, "_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": { "oneOf": [{ "$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" }, "rank": { "$ref": "./_types.json#/$defs/_types__RankContainer", "description": "The Reciprocal Rank Fusion (RRF) to use.", "x-found-in": "body" }, "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": { "oneOf": [{ "$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" }, "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" } }, "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search", "type": "object", "properties": { "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" }, "explain": { "type": "boolean", "description": "If `true`, the request returns detailed information about score computation as part of a hit.", "x-found-in": "query" }, "ext": { "type": "object", "additionalProperties": {}, "description": "Configuration of search extensions defined by Elasticsearch plugins.", "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": "query" }, "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" }, "track_total_hits": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__TrackHits", "description": "The 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": "query" }, "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" }, "docvalue_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit.", "x-found-in": "query" }, "knn": { "oneOf": [{ "$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" }, "rank": { "$ref": "./_types.json#/$defs/_types__RankContainer", "description": "The Reciprocal Rank Fusion (RRF) to use.", "x-found-in": "body" }, "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": { "oneOf": [{ "$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" }, "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" }, "size": { "type": "number", "description": "The number of hits to return.\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": "query" }, "slice": { "$ref": "./_types.json#/$defs/_types__SlicedScroll", "description": "Split a scrolled search into multiple slices that can be consumed independently.", "x-found-in": "body" }, "sort": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A comma-separated list of `<field>:<direction>` pairs.", "x-found-in": "query" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nValid values are:\n\n* `true` to return the entire document source.\n* `false` to not return the document source.\n* `<string>` to return the source fields that are specified as a comma-separated list that supports wildcard (`*`) patterns.", "x-found-in": "query" }, "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" }, "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 parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.\nIf set to `0` (default), the query does not terminate early.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.\nIt defaults to no timeout.", "x-found-in": "query" }, "track_scores": { "type": "boolean", "description": "If `true`, the request calculates and returns document scores, even if the scores are not used for sorting.", "x-found-in": "query" }, "version": { "type": "boolean", "description": "If `true`, the request returns the document version as part of a hit.", "x-found-in": "query" }, "seq_no_primary_term": { "type": "boolean", "description": "If `true`, the request returns the sequence number and primary term of the last modification of each hit.", "x-found-in": "query" }, "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` parameter defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", "x-found-in": "query" }, "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" }, "stats": { "oneOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "string" }], "description": "Specific `tag` of the request for logging and statistical purposes.", "x-found-in": "query" }, "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "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" }, "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" }, "ignore_throttled": { "type": "boolean", "description": "If `true`, concrete, expanded or aliased indices will be ignored when frozen.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "include_named_queries_score": { "type": "boolean", "description": "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" }, "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" }, "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" }, "_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" }, "_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" }, "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" }, "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" } }, "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." }

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", "type": "object", "properties": { "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" }, "debug": { "type": "boolean", "description": "Whether the response type has to include more details", "x-found-in": "query" } }, "required": ["collection_name", "event_type"], "description": "Create a behavioral analytics collection event." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_application.post_behavioral_analytics_event", "type": "object", "properties": { "debug": { "type": "boolean", "description": "Whether the response type has to include more details", "x-found-in": "query" }, "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"], "description": "Create a behavioral analytics collection event." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_application.put", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the search application to be created or updated.", "x-found-in": "path" }, "create": { "type": "boolean", "description": "If `true`, this request cannot replace or update existing Search Applications.", "x-found-in": "query" } }, "required": ["name"], "description": "Create or update a search application." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_application.put", "type": "object", "properties": { "create": { "type": "boolean", "description": "If `true`, this request cannot replace or update existing Search Applications.", "x-found-in": "query" }, "name": { "type": "string", "description": "The name of the search application to be created or updated.", "x-found-in": "path" } }, "required": ["name"], "description": "Create or update a search application." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_application.render_query", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the search application to render teh query for.", "x-found-in": "path" }, "params": { "type": "object", "additionalProperties": {}, "x-found-in": "body" } }, "required": ["name"], "description": "Render a search application query.\n\nGenerate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified.\nIf a parameter used in the search template is not specified in `params`, the parameter's default value will be used.\nThe API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.\n\nYou must have `read` privileges on the backing alias of the search application." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_application.render_query", "type": "object", "properties": { "params": { "type": "object", "additionalProperties": {}, "x-found-in": "body" }, "name": { "type": "string", "description": "The name of the search application to render teh query for.", "x-found-in": "path" } }, "required": ["name"], "description": "Render a search application query.\n\nGenerate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified.\nIf a parameter used in the search template is not specified in `params`, the parameter's default value will be used.\nThe API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.\n\nYou must have `read` privileges on the backing alias of the search application." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_application.search", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the search application to be searched.", "x-found-in": "path" }, "typed_keys": { "type": "boolean", "description": "Determines whether aggregation names are prefixed by their respective types in the response.", "x-found-in": "query" }, "params": { "type": "object", "additionalProperties": {}, "description": "Query parameters specific to this request, which will override any defaults specified in the template.", "x-found-in": "body" } }, "required": ["name"], "description": "Run a search application search.\n\nGenerate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.\nUnspecified template parameters are assigned their default values if applicable." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_application.search", "type": "object", "properties": { "params": { "type": "object", "additionalProperties": {}, "description": "Query parameters specific to this request, which will override any defaults specified in the template.", "x-found-in": "body" }, "typed_keys": { "type": "boolean", "description": "Determines whether aggregation names are prefixed by their respective types in the response.", "x-found-in": "query" }, "name": { "type": "string", "description": "The name of the search application to be searched.", "x-found-in": "path" } }, "required": ["name"], "description": "Run a search application search.\n\nGenerate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.\nUnspecified template parameters are assigned their default values if applicable." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_mvt", "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A list of indices, data streams, or aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.\nTo search a remote cluster, use the `<cluster>:<target>` syntax.", "x-found-in": "path" }, "field": { "type": "string", "description": "A field that contains the geospatial data to return.\nIt must be a `geo_point` or `geo_shape` field.\nThe field must have doc values enabled. It cannot be a nested field.\n\nNOTE: Vector tiles do not natively support geometry collections.\nFor `geometrycollection` values in a `geo_shape` field, the API returns a hits layer feature for each element of the collection.\nThis behavior may change in a future release.", "x-found-in": "path" }, "zoom": { "type": "number", "description": "The zoom level of the vector tile to search. It accepts `0` to `29`.", "x-found-in": "path" }, "x": { "type": "number", "description": "The X coordinate for the vector tile to search.", "x-found-in": "path" }, "y": { "type": "number", "description": "The Y coordinate for the vector tile to search.", "x-found-in": "path" }, "exact_bounds": { "type": "boolean", "description": "If `false`, the meta layer's feature is the bounding box of the tile.\nIf `true`, the meta layer's feature is a bounding box resulting from a\n`geo_bounds` aggregation. The aggregation runs on <field> values that intersect\nthe `<zoom>/<x>/<y>` tile with `wrap_longitude` set to `false`. The resulting\nbounding box may be larger than the vector tile.", "x-found-in": "body" }, "extent": { "type": "number", "description": "The size, in pixels, of a side of the tile. Vector tiles are square with equal sides.", "x-found-in": "body" }, "grid_agg": { "$ref": "./_global.search_mvt._types.json#/$defs/_global.search_mvt._types__GridAggregationType", "description": "The aggregation used to create a grid for the `field`.", "x-found-in": "body" }, "grid_precision": { "type": "number", "description": "Additional zoom levels available through the aggs layer. For example, if `<zoom>` is `7`\nand `grid_precision` is `8`, you can zoom in up to level 15. Accepts 0-8. If 0, results\ndon't include the aggs layer.", "x-found-in": "body" }, "grid_type": { "$ref": "./_global.search_mvt._types.json#/$defs/_global.search_mvt._types__GridType", "description": "Determines the geometry type for features in the aggs layer. In the aggs layer,\neach feature represents a `geotile_grid` cell. If `grid, each feature is a polygon\nof the cells bounding box. If `point`, each feature is a Point that is the centroid\nof the cell.", "x-found-in": "body" }, "size": { "type": "number", "description": "The maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don't include the hits layer.", "x-found-in": "body" }, "track_total_hits": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__TrackHits", "description": "The number of hits matching the query to count accurately. If `true`, the exact number\nof hits is returned at the cost of some performance. If `false`, the response does\nnot include the total number of hits matching the query.", "x-found-in": "body" }, "with_labels": { "type": "boolean", "description": "If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.\n\n* `Point` and `MultiPoint` features will have one of the points selected.\n* `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree.\n* `LineString` features will likewise provide a roughly central point selected from the triangle-tree.\n* The aggregation results will provide one central point for each aggregation bucket.\n\nAll attributes from the original features will also be copied to the new label features.\nIn addition, the new features will be distinguishable using the tag `_mvt_label_position`.", "x-found-in": "body" }, "aggs": { "type": "object", "additionalProperties": { "$ref": "./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer" }, "description": "Sub-aggregations for the geotile_grid.\n\nIt supports the following aggregation types:\n\n- `avg`\n- `boxplot`\n- `cardinality`\n- `extended stats`\n- `max`\n- `median absolute deviation`\n- `min`\n- `percentile`\n- `percentile-rank`\n- `stats`\n- `sum`\n- `value count`\n\nThe aggregation names can't start with `_mvt_`. The `_mvt_` prefix is reserved for internal aggregations.", "x-found-in": "body" }, "buffer": { "type": "number", "description": "The size, in pixels, of a clipping buffer outside the tile. This allows renderers\nto avoid outline artifacts from geometries that extend past the extent of the tile.", "x-found-in": "body" }, "fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "The fields to return in the `hits` layer.\nIt supports wildcards (`*`).\nThis parameter does not support fields with array values. Fields with array\nvalues may return inconsistent results.", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "The query DSL used to filter documents for the search.", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", "x-found-in": "body" }, "sort": { "$ref": "./_types.json#/$defs/_types__Sort", "description": "Sort the features in the hits layer. By default, the API calculates a bounding\nbox for each feature. It sorts features based on this box's diagonal length,\nfrom longest to shortest.", "x-found-in": "body" } }, "required": ["index", "field", "zoom", "x", "y"], "description": "Search a vector tile.\n\nSearch a vector tile for geospatial values.\nBefore using this API, you should be familiar with the Mapbox vector tile specification.\nThe API returns results as a binary mapbox vector tile.\n\nInternally, Elasticsearch translates a vector tile search API request into a search containing:\n\n* A `geo_bounding_box` query on the `<field>`. The query uses the `<zoom>/<x>/<y>` tile as a bounding box.\n* A `geotile_grid` or `geohex_grid` aggregation on the `<field>`. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `<zoom>/<x>/<y>` tile as a bounding box.\n* Optionally, a `geo_bounds` aggregation on the `<field>`. The search only includes this aggregation if the `exact_bounds` parameter is `true`.\n* If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.\n\nThe API returns results as a binary Mapbox vector tile.\nMapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:\n\n* A `hits` layer containing a feature for each `<field>` value matching the `geo_bounding_box` query.\n* An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data.\n* A meta layer containing:\n  * A feature containing a bounding box. By default, this is the bounding box of the tile.\n  * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`.\n  * Metadata for the search.\n\nThe API only returns features that can display at its zoom level.\nFor example, if a polygon feature has no area at its zoom level, the API omits it.\nThe API returns errors as UTF-8 encoded JSON.\n\nIMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.\nIf you specify both parameters, the query parameter takes precedence.\n\n**Grid precision for geotile**\n\nFor a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels.\n`grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: `<zoom> + grid_precision`.\nFor example, if `<zoom>` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15.\nThe maximum final precision is 29.\nThe `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`.\nFor example, a value of 8 divides the tile into a grid of 256 x 256 cells.\nThe `aggs` layer only contains features for cells with matching data.\n\n**Grid precision for geohex**\n\nFor a `grid_agg` of `geohex`, Elasticsearch uses `<zoom>` and `grid_precision` to calculate a final precision as follows: `<zoom> + grid_precision`.\n\nThis precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation.\nThe following table maps the H3 resolution for each precision.\nFor example, if `<zoom>` is 3 and `grid_precision` is 3, the precision is 6.\nAt a precision of 6, hexagonal cells have an H3 resolution of 2.\nIf `<zoom>` is 3 and `grid_precision` is 4, the precision is 7.\nAt a precision of 7, hexagonal cells have an H3 resolution of 3.\n\n| Precision | Unique tile bins | H3 resolution | Unique hex bins |\tRatio |\n| --------- | ---------------- | ------------- | ----------------| ----- |\n| 1  | 4                  | 0  | 122             | 30.5           |\n| 2  | 16                 | 0  | 122             | 7.625          |\n| 3  | 64                 | 1  | 842             | 13.15625       |\n| 4  | 256                | 1  | 842             | 3.2890625      |\n| 5  | 1024               | 2  | 5882            | 5.744140625    |\n| 6  | 4096               | 2  | 5882            | 1.436035156    |\n| 7  | 16384              | 3  | 41162           | 2.512329102    |\n| 8  | 65536              | 3  | 41162           | 0.6280822754   |\n| 9  | 262144             | 4  | 288122          | 1.099098206    |\n| 10 | 1048576            | 4  | 288122          | 0.2747745514   |\n| 11 | 4194304            | 5  | 2016842         | 0.4808526039   |\n| 12 | 16777216           | 6  | 14117882        | 0.8414913416   |\n| 13 | 67108864           | 6  | 14117882        | 0.2103728354   |\n| 14 | 268435456          | 7  | 98825162        | 0.3681524172   |\n| 15 | 1073741824         | 8  | 691776122       | 0.644266719    |\n| 16 | 4294967296         | 8  | 691776122       | 0.1610666797   |\n| 17 | 17179869184        | 9  | 4842432842      | 0.2818666889   |\n| 18 | 68719476736        | 10 | 33897029882     | 0.4932667053   |\n| 19 | 274877906944       | 11 | 237279209162    | 0.8632167343   |\n| 20 | 1099511627776      | 11 | 237279209162    | 0.2158041836   |\n| 21 | 4398046511104      | 12 | 1660954464122   | 0.3776573213   |\n| 22 | 17592186044416     | 13 | 11626681248842  | 0.6609003122   |\n| 23 | 70368744177664     | 13 | 11626681248842  | 0.165225078    |\n| 24 | 281474976710656    | 14 | 81386768741882  | 0.2891438866   |\n| 25 | 1125899906842620   | 15 | 569707381193162 | 0.5060018015   |\n| 26 | 4503599627370500   | 15 | 569707381193162 | 0.1265004504   |\n| 27 | 18014398509482000  | 15 | 569707381193162 | 0.03162511259  |\n| 28 | 72057594037927900  | 15 | 569707381193162 | 0.007906278149 |\n| 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |\n\nHexagonal cells don't align perfectly on a vector tile.\nSome cells may intersect more than one vector tile.\nTo compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.\nElasticsearch uses the H3 resolution that is closest to the corresponding geotile density.\n\nLearn how to use the vector tile search API with practical examples in the [Vector tile search examples](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search) guide." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_mvt", "type": "object", "properties": { "aggs": { "type": "object", "additionalProperties": { "$ref": "./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer" }, "description": "Sub-aggregations for the geotile_grid.\n\nIt supports the following aggregation types:\n\n- `avg`\n- `boxplot`\n- `cardinality`\n- `extended stats`\n- `max`\n- `median absolute deviation`\n- `min`\n- `percentile`\n- `percentile-rank`\n- `stats`\n- `sum`\n- `value count`\n\nThe aggregation names can't start with `_mvt_`. The `_mvt_` prefix is reserved for internal aggregations.", "x-found-in": "body" }, "buffer": { "type": "number", "description": "The size, in pixels, of a clipping buffer outside the tile. This allows renderers\nto avoid outline artifacts from geometries that extend past the extent of the tile.", "x-found-in": "body" }, "exact_bounds": { "type": "boolean", "description": "If `false`, the meta layer's feature is the bounding box of the tile.\nIf true, the meta layer's feature is a bounding box resulting from a\ngeo_bounds aggregation. The aggregation runs on <field> values that intersect\nthe <zoom>/<x>/<y> tile with wrap_longitude set to false. The resulting\nbounding box may be larger than the vector tile.", "x-found-in": "query" }, "extent": { "type": "number", "description": "The size, in pixels, of a side of the tile. Vector tiles are square with equal sides.", "x-found-in": "query" }, "fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "The fields to return in the `hits` layer.\nIt supports wildcards (`*`).\nThis parameter does not support fields with array values. Fields with array\nvalues may return inconsistent results.", "x-found-in": "body" }, "grid_agg": { "$ref": "./_global.search_mvt._types.json#/$defs/_global.search_mvt._types__GridAggregationType", "description": "Aggregation used to create a grid for `field`.", "x-found-in": "query" }, "grid_precision": { "type": "number", "description": "Additional zoom levels available through the aggs layer. For example, if <zoom> is 7\nand grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results\ndon't include the aggs layer.", "x-found-in": "query" }, "grid_type": { "$ref": "./_global.search_mvt._types.json#/$defs/_global.search_mvt._types__GridType", "description": "Determines the geometry type for features in the aggs layer. In the aggs layer,\neach feature represents a geotile_grid cell. If 'grid' each feature is a Polygon\nof the cells bounding box. If 'point' each feature is a Point that is the centroid\nof the cell.", "x-found-in": "query" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "The query DSL used to filter documents for the search.", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", "x-found-in": "body" }, "size": { "type": "number", "description": "Maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don't include the hits layer.", "x-found-in": "query" }, "sort": { "$ref": "./_types.json#/$defs/_types__Sort", "description": "Sort the features in the hits layer. By default, the API calculates a bounding\nbox for each feature. It sorts features based on this box's diagonal length,\nfrom longest to shortest.", "x-found-in": "body" }, "track_total_hits": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__TrackHits", "description": "The 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": "query" }, "with_labels": { "type": "boolean", "description": "If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.\n\n* `Point` and `MultiPoint` features will have one of the points selected.\n* `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree.\n* `LineString` features will likewise provide a roughly central point selected from the triangle-tree.\n* The aggregation results will provide one central point for each aggregation bucket.\n\nAll attributes from the original features will also be copied to the new label features.\nIn addition, the new features will be distinguishable using the tag `_mvt_label_position`.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A list of indices, data streams, or aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.\nTo search a remote cluster, use the `<cluster>:<target>` syntax.", "x-found-in": "path" }, "field": { "type": "string", "description": "A field that contains the geospatial data to return.\nIt must be a `geo_point` or `geo_shape` field.\nThe field must have doc values enabled. It cannot be a nested field.\n\nNOTE: Vector tiles do not natively support geometry collections.\nFor `geometrycollection` values in a `geo_shape` field, the API returns a hits layer feature for each element of the collection.\nThis behavior may change in a future release.", "x-found-in": "path" }, "zoom": { "type": "number", "description": "The zoom level of the vector tile to search. It accepts `0` to `29`.", "x-found-in": "path" }, "x": { "type": "number", "description": "The X coordinate for the vector tile to search.", "x-found-in": "path" }, "y": { "type": "number", "description": "The Y coordinate for the vector tile to search.", "x-found-in": "path" } }, "required": ["index", "field", "zoom", "x", "y"], "description": "Search a vector tile.\n\nSearch a vector tile for geospatial values.\nBefore using this API, you should be familiar with the Mapbox vector tile specification.\nThe API returns results as a binary mapbox vector tile.\n\nInternally, Elasticsearch translates a vector tile search API request into a search containing:\n\n* A `geo_bounding_box` query on the `<field>`. The query uses the `<zoom>/<x>/<y>` tile as a bounding box.\n* A `geotile_grid` or `geohex_grid` aggregation on the `<field>`. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `<zoom>/<x>/<y>` tile as a bounding box.\n* Optionally, a `geo_bounds` aggregation on the `<field>`. The search only includes this aggregation if the `exact_bounds` parameter is `true`.\n* If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.\n\nThe API returns results as a binary Mapbox vector tile.\nMapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:\n\n* A `hits` layer containing a feature for each `<field>` value matching the `geo_bounding_box` query.\n* An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data.\n* A meta layer containing:\n  * A feature containing a bounding box. By default, this is the bounding box of the tile.\n  * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`.\n  * Metadata for the search.\n\nThe API only returns features that can display at its zoom level.\nFor example, if a polygon feature has no area at its zoom level, the API omits it.\nThe API returns errors as UTF-8 encoded JSON.\n\nIMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.\nIf you specify both parameters, the query parameter takes precedence.\n\n**Grid precision for geotile**\n\nFor a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels.\n`grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: `<zoom> + grid_precision`.\nFor example, if `<zoom>` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15.\nThe maximum final precision is 29.\nThe `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`.\nFor example, a value of 8 divides the tile into a grid of 256 x 256 cells.\nThe `aggs` layer only contains features for cells with matching data.\n\n**Grid precision for geohex**\n\nFor a `grid_agg` of `geohex`, Elasticsearch uses `<zoom>` and `grid_precision` to calculate a final precision as follows: `<zoom> + grid_precision`.\n\nThis precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation.\nThe following table maps the H3 resolution for each precision.\nFor example, if `<zoom>` is 3 and `grid_precision` is 3, the precision is 6.\nAt a precision of 6, hexagonal cells have an H3 resolution of 2.\nIf `<zoom>` is 3 and `grid_precision` is 4, the precision is 7.\nAt a precision of 7, hexagonal cells have an H3 resolution of 3.\n\n| Precision | Unique tile bins | H3 resolution | Unique hex bins |\tRatio |\n| --------- | ---------------- | ------------- | ----------------| ----- |\n| 1  | 4                  | 0  | 122             | 30.5           |\n| 2  | 16                 | 0  | 122             | 7.625          |\n| 3  | 64                 | 1  | 842             | 13.15625       |\n| 4  | 256                | 1  | 842             | 3.2890625      |\n| 5  | 1024               | 2  | 5882            | 5.744140625    |\n| 6  | 4096               | 2  | 5882            | 1.436035156    |\n| 7  | 16384              | 3  | 41162           | 2.512329102    |\n| 8  | 65536              | 3  | 41162           | 0.6280822754   |\n| 9  | 262144             | 4  | 288122          | 1.099098206    |\n| 10 | 1048576            | 4  | 288122          | 0.2747745514   |\n| 11 | 4194304            | 5  | 2016842         | 0.4808526039   |\n| 12 | 16777216           | 6  | 14117882        | 0.8414913416   |\n| 13 | 67108864           | 6  | 14117882        | 0.2103728354   |\n| 14 | 268435456          | 7  | 98825162        | 0.3681524172   |\n| 15 | 1073741824         | 8  | 691776122       | 0.644266719    |\n| 16 | 4294967296         | 8  | 691776122       | 0.1610666797   |\n| 17 | 17179869184        | 9  | 4842432842      | 0.2818666889   |\n| 18 | 68719476736        | 10 | 33897029882     | 0.4932667053   |\n| 19 | 274877906944       | 11 | 237279209162    | 0.8632167343   |\n| 20 | 1099511627776      | 11 | 237279209162    | 0.2158041836   |\n| 21 | 4398046511104      | 12 | 1660954464122   | 0.3776573213   |\n| 22 | 17592186044416     | 13 | 11626681248842  | 0.6609003122   |\n| 23 | 70368744177664     | 13 | 11626681248842  | 0.165225078    |\n| 24 | 281474976710656    | 14 | 81386768741882  | 0.2891438866   |\n| 25 | 1125899906842620   | 15 | 569707381193162 | 0.5060018015   |\n| 26 | 4503599627370500   | 15 | 569707381193162 | 0.1265004504   |\n| 27 | 18014398509482000  | 15 | 569707381193162 | 0.03162511259  |\n| 28 | 72057594037927900  | 15 | 569707381193162 | 0.007906278149 |\n| 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |\n\nHexagonal cells don't align perfectly on a vector tile.\nSome cells may intersect more than one vector tile.\nTo compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.\nElasticsearch uses the H3 resolution that is closest to the corresponding geotile density.\n\nLearn how to use the vector tile search API with practical examples in the [Vector tile search examples](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search) guide." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_shards", "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" }, "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "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" }, "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIT can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nIt is random by default.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.", "x-found-in": "query" } }, "description": "Get the search shards.\n\nGet the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the `indices` section.\n\nIf the Elasticsearch security features are enabled, you must have the `view_index_metadata` or `manage` index privilege for the target data stream, index, or alias." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_shards", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "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" }, "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIT can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nIt is random by default.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.", "x-found-in": "query" }, "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" } }, "description": "Get the search shards.\n\nGet the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the `indices` section.\n\nIf the Elasticsearch security features are enabled, you must have the `view_index_metadata` or `manage` index privilege for the target data stream, index, or alias." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_template", "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).", "x-found-in": "path" }, "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "explain": { "type": "boolean", "description": "If `true`, returns detailed information about score calculation as part of each hit.\nIf you specify both this and the `explain` query parameter, the API uses only the query parameter.", "x-found-in": "body" }, "ignore_throttled": { "type": "boolean", "description": "If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nIt is random by default.", "x-found-in": "query" }, "profile": { "type": "boolean", "description": "If `true`, the query execution is profiled.", "x-found-in": "body" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value used to route operations to a specific shard.", "x-found-in": "query" }, "scroll": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies how long a consistent view of the index\nshould be maintained for scrolled search.", "x-found-in": "query" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "description": "The type of the search operation.", "x-found-in": "query" }, "rest_total_hits_as_int": { "type": "boolean", "description": "If `true`, `hits.total` is rendered as an integer in the response.\nIf `false`, it is rendered as an object.", "x-found-in": "query" }, "typed_keys": { "type": "boolean", "description": "If `true`, the response prefixes aggregation and suggester names with their respective types.", "x-found-in": "query" }, "id": { "type": "string", "description": "The ID of the search template to use. If no `source` is specified,\nthis parameter is required.", "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. Supports the same parameters as the search API's\nrequest body. It also supports Mustache variables. If no `id` is specified, this\nparameter is required.", "x-found-in": "body" } }, "description": "Run a search with a search template." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "search_template", "type": "object", "properties": { "explain": { "type": "boolean", "description": "If `true`, the response includes additional details about score computation as part of a hit.", "x-found-in": "query" }, "id": { "type": "string", "description": "The ID of the search template to use. If no `source` is specified,\nthis parameter is required.", "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" }, "profile": { "type": "boolean", "description": "If `true`, the query execution is profiled.", "x-found-in": "query" }, "source": { "$ref": "./_types.json#/$defs/_types__ScriptSource", "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. It also supports Mustache variables. If no `id` is specified, this\nparameter is required.", "x-found-in": "body" }, "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_throttled": { "type": "boolean", "description": "If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nIt is random by default.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value used to route operations to a specific shard.", "x-found-in": "query" }, "scroll": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies how long a consistent view of the index\nshould be maintained for scrolled search.", "x-found-in": "query" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "description": "The type of the search operation.", "x-found-in": "query" }, "rest_total_hits_as_int": { "type": "boolean", "description": "If `true`, `hits.total` is rendered as an integer in the response.\nIf `false`, it is rendered as an object.", "x-found-in": "query" }, "typed_keys": { "type": "boolean", "description": "If `true`, the response prefixes aggregation and suggester names with their respective types.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).", "x-found-in": "path" } }, "description": "Run a search with a search template." }

package/lib/cjs/es/json/searchable_snapshots.clear_cache.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "searchable_snapshots.clear_cache", "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and aliases to clear from the cache.\nIt supports wildcards (`*`).", "x-found-in": "path" }, "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" }, "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" }, "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" } }, "description": "Clear the cache.\n\nClear indices and data streams from the shared cache for partially mounted indices." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "searchable_snapshots.clear_cache", "type": "object", "properties": { "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" }, "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" }, "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" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and aliases to clear from the cache.\nIt supports wildcards (`*`).", "x-found-in": "path" } }, "description": "Clear the cache.\n\nClear indices and data streams from the shared cache for partially mounted indices." }

package/lib/cjs/es/json/searchable_snapshots.mount.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "searchable_snapshots.mount", "type": "object", "properties": { "repository": { "type": "string", "description": "The name of the repository containing the snapshot of the index to mount.", "x-found-in": "path" }, "snapshot": { "type": "string", "description": "The name of the snapshot of the index to mount.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If true, the request blocks until the operation is complete.", "x-found-in": "query" }, "storage": { "$ref": "./searchable_snapshots.mount.json#/$defs/searchable_snapshots.mount__StorageOption", "description": "The mount option for the searchable snapshot index.\nFor further information on mount options, refer to: [Mount options](https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots#searchable-snapshot-mount-storage-options)", "x-found-in": "query" }, "index": { "type": "string", "description": "The name of the index contained in the snapshot whose data is to be mounted.\nIf no `renamed_index` is specified, this name will also be used to create the new index.", "x-found-in": "body" }, "renamed_index": { "type": "string", "description": "The name of the index that will be created.", "x-found-in": "body" }, "index_settings": { "type": "object", "additionalProperties": {}, "description": "The settings that should be added to the index when it is mounted.", "x-found-in": "body" }, "ignore_index_settings": { "type": "array", "items": { "type": "string" }, "description": "The names of settings that should be removed from the index when it is mounted.", "x-found-in": "body" } }, "required": ["repository", "snapshot", "index"], "description": "Mount a snapshot.\n\nMount a snapshot as a searchable snapshot index.\nDo not use this API for snapshots managed by index lifecycle management (ILM).\nManually mounting ILM-managed snapshots can interfere with ILM processes." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "searchable_snapshots.mount", "type": "object", "properties": { "index": { "type": "string", "description": "The name of the index contained in the snapshot whose data is to be mounted.\nIf no `renamed_index` is specified, this name will also be used to create the new index.", "x-found-in": "body" }, "renamed_index": { "type": "string", "description": "The name of the index that will be created.", "x-found-in": "body" }, "index_settings": { "type": "object", "additionalProperties": {}, "description": "The settings that should be added to the index when it is mounted.", "x-found-in": "body" }, "ignore_index_settings": { "type": "array", "items": { "type": "string" }, "description": "The names of settings that should be removed from the index when it is mounted.", "x-found-in": "body" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If true, the request blocks until the operation is complete.", "x-found-in": "query" }, "storage": { "$ref": "./searchable_snapshots.mount.json#/$defs/searchable_snapshots.mount__StorageOption", "description": "The mount option for the searchable snapshot index.\nFor further information on mount options, refer to: [Mount options](https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots#searchable-snapshot-mount-storage-options)", "x-found-in": "query" }, "repository": { "type": "string", "description": "The name of the repository containing the snapshot of the index to mount.", "x-found-in": "path" }, "snapshot": { "type": "string", "description": "The name of the snapshot of the index to mount.", "x-found-in": "path" } }, "required": ["repository", "snapshot", "index"], "description": "Mount a snapshot.\n\nMount a snapshot as a searchable snapshot index.\nDo not use this API for snapshots managed by index lifecycle management (ILM).\nManually mounting ILM-managed snapshots can interfere with ILM processes." }

package/lib/cjs/es/json/searchable_snapshots.stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "searchable_snapshots.stats", "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams and indices to retrieve statistics for.", "x-found-in": "path" }, "level": { "$ref": "./searchable_snapshots._types.json#/$defs/searchable_snapshots._types__StatsLevel", "description": "Return stats aggregated at cluster, index or shard level", "x-found-in": "query" } }, "description": "Get searchable snapshot statistics." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "searchable_snapshots.stats", "type": "object", "properties": { "level": { "$ref": "./searchable_snapshots._types.json#/$defs/searchable_snapshots._types__StatsLevel", "description": "Return stats aggregated at cluster, index or shard level", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams and indices to retrieve statistics for.", "x-found-in": "path" } }, "description": "Get searchable snapshot statistics." }

package/lib/cjs/es/json/security.bulk_delete_role.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.bulk_delete_role", "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "names": { "type": "array", "items": { "type": "string" }, "description": "An array of role names to delete", "x-found-in": "body" } }, "required": ["names"], "description": "Bulk delete roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.bulk_delete_role", "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string" }, "description": "An array of role names to delete", "x-found-in": "body" }, "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" } }, "required": ["names"], "description": "Bulk delete roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files." }

package/lib/cjs/es/json/security.bulk_put_role.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.bulk_put_role", "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "roles": { "type": "object", "additionalProperties": { "$ref": "./security._types.json#/$defs/security._types__RoleDescriptor" }, "description": "A dictionary of role name to RoleDescriptor objects to add or update", "x-found-in": "body" } }, "required": ["roles"], "description": "Bulk create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.bulk_put_role", "type": "object", "properties": { "roles": { "type": "object", "additionalProperties": { "$ref": "./security._types.json#/$defs/security._types__RoleDescriptor" }, "description": "A dictionary of role name to RoleDescriptor objects to add or update", "x-found-in": "body" }, "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" } }, "required": ["roles"], "description": "Bulk create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files." }

package/lib/cjs/es/json/security.change_password.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.change_password", "type": "object", "properties": { "username": { "type": "string", "description": "The user whose password you want to change. If you do not specify this\nparameter, the password is changed for the current user.", "x-found-in": "path" }, "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "password": { "type": "string", "description": "The new password value. Passwords must be at least 6 characters long.", "x-found-in": "body" }, "password_hash": { "type": "string", "description": "A hash of the new password value. This must be produced using the same\nhashing algorithm as has been configured for password storage. For more details,\nsee the explanation of the `xpack.security.authc.password_hashing.algorithm`\nsetting.", "x-found-in": "body" } }, "description": "Change passwords.\n\nChange the passwords of users in the native realm and built-in users." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.change_password", "type": "object", "properties": { "password": { "type": "string", "description": "The new password value. Passwords must be at least 6 characters long.", "x-found-in": "body" }, "password_hash": { "type": "string", "description": "A hash of the new password value. This must be produced using the same\nhashing algorithm as has been configured for password storage. For more details,\nsee the explanation of the `xpack.security.authc.password_hashing.algorithm`\nsetting.", "x-found-in": "body" }, "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "username": { "type": "string", "description": "The user whose password you want to change. If you do not specify this\nparameter, the password is changed for the current user.", "x-found-in": "path" } }, "description": "Change passwords.\n\nChange the passwords of users in the native realm and built-in users." }

package/lib/cjs/es/json/security.clear_cached_realms.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.clear_cached_realms", "type": "object", "properties": { "realms": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of realms.\nTo clear all realms, use an asterisk (`*`).\nIt does not support other wildcard patterns.", "x-found-in": "path" }, "usernames": { "type": "array", "items": { "type": "string" }, "description": "A comma-separated list of the users to clear from the cache.\nIf you do not specify this parameter, the API evicts all users from the user cache.", "x-found-in": "query" } }, "required": ["realms"], "description": "Clear the user cache.\n\nEvict users from the user cache.\nYou can completely clear the cache or evict specific users.\n\nUser credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request.\nThere are realm settings that you can use to configure the user cache.\nFor more information, refer to the documentation about controlling the user cache." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.clear_cached_realms", "type": "object", "properties": { "usernames": { "type": "array", "items": { "type": "string" }, "description": "A comma-separated list of the users to clear from the cache.\nIf you do not specify this parameter, the API evicts all users from the user cache.", "x-found-in": "query" }, "realms": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of realms.\nTo clear all realms, use an asterisk (`*`).\nIt does not support other wildcard patterns.", "x-found-in": "path" } }, "required": ["realms"], "description": "Clear the user cache.\n\nEvict users from the user cache.\nYou can completely clear the cache or evict specific users.\n\nUser credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request.\nThere are realm settings that you can use to configure the user cache.\nFor more information, refer to the documentation about controlling the user cache." }

package/lib/cjs/es/json/security.clone_api_key.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.clone_api_key", "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "api_key": { "type": "string", "description": "The credentials of the API key to clone.\nThis is the secret value returned when the key was originally created.", "x-found-in": "body" }, "name": { "type": "string", "description": "A name for the cloned API key.\nIf not provided, the name of the source key is used.", "x-found-in": "body" }, "expiration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The expiration time for the cloned API key.\nBy default, API keys never expire.\nSet to `null` to explicitly create a key with no expiration.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary metadata to associate with the cloned API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.", "x-found-in": "body" } }, "required": ["api_key"], "description": "Clone an API key.\n\nCreate a copy of an existing API key with a new ID.\nThe cloned key inherits the role descriptors of the source key.\nThis is intended for applications (such as Kibana) that need to\ncreate API keys on behalf of a user using an existing API key credential,\nsince derived API keys (API keys created by API keys) are not otherwise supported." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.clone_api_key", "type": "object", "properties": { "api_key": { "type": "string", "description": "The credentials of the API key to clone.\nThis is the secret value returned when the key was originally created.", "x-found-in": "body" }, "name": { "type": "string", "description": "A name for the cloned API key.\nIf not provided, the name of the source key is used.", "x-found-in": "body" }, "expiration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The expiration time for the cloned API key.\nBy default, API keys never expire.\nSet to `null` to explicitly create a key with no expiration.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary metadata to associate with the cloned API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.", "x-found-in": "body" }, "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" } }, "required": ["api_key"], "description": "Clone an API key.\n\nCreate a copy of an existing API key with a new ID.\nThe cloned key inherits the role descriptors of the source key.\nThis is intended for applications (such as Kibana) that need to\ncreate API keys on behalf of a user using an existing API key credential,\nsince derived API keys (API keys created by API keys) are not otherwise supported." }