@elastic/schemas 0.4.5 → 0.5.1

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "fleet.msearch", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.", "x-found-in": "query" }, "ignore_throttled": { "type": "boolean", "description": "If true, concrete, expanded or aliased indices are ignored when frozen.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "max_concurrent_searches": { "type": "number", "description": "Maximum number of concurrent searches the multi search API can execute.", "x-found-in": "query" }, "max_concurrent_shard_requests": { "type": "number", "description": "Maximum number of concurrent shard requests that each sub-search request executes per node.", "x-found-in": "query" }, "pre_filter_shard_size": { "type": "number", "description": "Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.", "x-found-in": "query" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "description": "Indicates whether global term and document frequencies should be used when scoring returned documents.", "x-found-in": "query" }, "rest_total_hits_as_int": { "type": "boolean", "description": "If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.", "x-found-in": "query" }, "typed_keys": { "type": "boolean", "description": "Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.", "x-found-in": "query" }, "wait_for_checkpoints": { "type": "array", "items": { "type": "number" }, "description": "A comma separated list of checkpoints. When configured, the search API will only be executed on a shard\nafter the relevant checkpoint has become visible for search. Defaults to an empty list which will cause\nElasticsearch to immediately execute the search.", "x-found-in": "query" }, "allow_partial_search_results": { "type": "boolean", "description": "If true, returns partial results if there are shard request timeouts or shard failures.\nIf false, returns an error with no partial results.\nDefaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default.", "x-found-in": "query" }, "searches": { "type": "array", "items": { "$ref": "./_global.msearch.json#/$defs/_global.msearch__RequestItem" }, "x-found-in": "body" }, "index": { "anyOf": [{ "type": "string" }, { "type": "string" }], "description": "A single target to search. If the target is an index alias, it must resolve to a single index.", "x-found-in": "path" } }, "description": "Run multiple Fleet searches.\n\nRun several Fleet searches with a single API request.\nThe API follows the same structure as the multi search API.\nHowever, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "fleet.msearch", "description": "Run multiple Fleet searches.\n\nRun several Fleet searches with a single API request.\nThe API follows the same structure as the multi search API.\nHowever, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.", "x-api": { "id": "fleet.msearch", "name": "msearch", "namespace": "fleet" }, "x-method": "GET", "x-path": "/{index}/_fleet/_fleet_msearch", "x-urls": [{ "path": "/_fleet/_fleet_msearch", "methods": ["GET", "POST"] }, { "path": "/{index}/_fleet/_fleet_msearch", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.16.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "private" } }, "x-body-format": "ndjson", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.", "x-found-in": "query" }, "ignore_throttled": { "type": "boolean", "description": "If true, concrete, expanded or aliased indices are ignored when frozen.", "x-found-in": "query" }, "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" }, "max_concurrent_searches": { "type": "number", "description": "Maximum number of concurrent searches the multi search API can execute.", "x-found-in": "query" }, "max_concurrent_shard_requests": { "type": "number", "description": "Maximum number of concurrent shard requests that each sub-search request executes per node.", "x-found-in": "query" }, "pre_filter_shard_size": { "type": "number", "description": "Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.", "x-found-in": "query" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "description": "Indicates whether global term and document frequencies should be used when scoring returned documents.", "x-found-in": "query" }, "rest_total_hits_as_int": { "type": "boolean", "description": "If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.", "x-found-in": "query" }, "typed_keys": { "type": "boolean", "description": "Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.", "x-found-in": "query" }, "wait_for_checkpoints": { "type": "array", "items": { "type": "number" }, "description": "A comma separated list of checkpoints. When configured, the search API will only be executed on a shard\nafter the relevant checkpoint has become visible for search. Defaults to an empty list which will cause\nElasticsearch to immediately execute the search.", "x-found-in": "query" }, "allow_partial_search_results": { "type": "boolean", "description": "If true, returns partial results if there are shard request timeouts or shard failures.\nIf false, returns an error with no partial results.\nDefaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default.", "x-found-in": "query" }, "searches": { "type": "array", "items": { "$ref": "./_global.msearch.json#/$defs/_global.msearch__RequestItem" }, "x-found-in": "body", "x-body-root": true }, "index": { "anyOf": [{ "type": "string" }, { "type": "string" }], "description": "A single target to search. If the target is an index alias, it must resolve to a single index.", "x-found-in": "path" } } }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "fleet.search", "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" }, "analyzer": { "type": "string", "x-found-in": "query" }, "analyze_wildcard": { "type": "boolean", "x-found-in": "query" }, "batched_reduce_size": { "type": "number", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "x-found-in": "query" }, "default_operator": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__Operator", "x-found-in": "query" }, "df": { "type": "string", "x-found-in": "query" }, "docvalue_fields": { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, "description": "Array of wildcard (*) patterns. The request returns doc values for field\nnames matching these patterns in the hits.fields property of the response.", "x-found-in": "body" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "x-found-in": "query" }, "explain": { "type": "boolean", "description": "If true, returns detailed information about score computation as part of a hit.", "x-found-in": "body" }, "ignore_throttled": { "type": "boolean", "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" }, "lenient": { "type": "boolean", "x-found-in": "query" }, "max_concurrent_shard_requests": { "type": "number", "x-found-in": "query" }, "preference": { "type": "string", "x-found-in": "query" }, "pre_filter_shard_size": { "type": "number", "x-found-in": "query" }, "request_cache": { "type": "boolean", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "x-found-in": "query" }, "scroll": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "query" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "x-found-in": "query" }, "stats": { "type": "array", "items": { "type": "string" }, "description": "Stats groups to associate with the search. Each group maintains a statistics\naggregation for its associated searches. You can retrieve these stats using\nthe indices stats API.", "x-found-in": "body" }, "stored_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "List of stored fields to return as part of a hit. If no fields are specified,\nno stored fields are included in the response. If this field is specified, the _source\nparameter defaults to false. You can pass _source: true to return both source fields\nand stored fields in the search response.", "x-found-in": "body" }, "suggest_field": { "type": "string", "description": "Specifies which field to use for suggestions.", "x-found-in": "query" }, "suggest_mode": { "$ref": "./_types.json#/$defs/_types__SuggestMode", "x-found-in": "query" }, "suggest_size": { "type": "number", "x-found-in": "query" }, "suggest_text": { "type": "string", "description": "The source text for which the suggestions should be returned.", "x-found-in": "query" }, "terminate_after": { "type": "number", "description": "Maximum number of documents to collect for each shard. If a query reaches this\nlimit, Elasticsearch terminates the query early. Elasticsearch collects documents\nbefore sorting. Defaults to 0, which does not terminate query execution early.", "x-found-in": "body" }, "timeout": { "type": "string", "description": "Specifies the period of time to wait for a response from each shard. If no response\nis 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. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.", "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", "x-found-in": "query" }, "rest_total_hits_as_int": { "type": "boolean", "x-found-in": "query" }, "version": { "type": "boolean", "description": "If true, returns document version as part of a hit.", "x-found-in": "body" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfig", "description": "Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.", "x-found-in": "body" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "x-found-in": "query" }, "seq_no_primary_term": { "type": "boolean", "description": "If true, returns sequence number and primary term of the last modification\nof each hit. See Optimistic concurrency control.", "x-found-in": "body" }, "q": { "type": "string", "x-found-in": "query" }, "size": { "type": "number", "description": "The number of hits to return. By default, you cannot page through more\nthan 10,000 hits using the from and size parameters. To page through more\nhits, use the search_after parameter.", "x-found-in": "body" }, "from": { "type": "number", "description": "Starting document offset. By default, you cannot page through more than 10,000\nhits using the from and size parameters. To page through more hits, use the\nsearch_after parameter.", "x-found-in": "body" }, "sort": { "$ref": "./_types.json#/$defs/_types__Sort", "x-found-in": "body" }, "wait_for_checkpoints": { "type": "array", "items": { "type": "number" }, "description": "A comma separated list of checkpoints. When configured, the search API will only be executed on a shard\nafter the relevant checkpoint has become visible for search. Defaults to an empty list which will cause\nElasticsearch to immediately execute the search.", "x-found-in": "query" }, "allow_partial_search_results": { "type": "boolean", "description": "If true, returns partial results if there are shard request timeouts or shard failures.\nIf false, returns an error with no partial results.\nDefaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default.", "x-found-in": "query" }, "aggregations": { "type": "object", "additionalProperties": { "$ref": "./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer" }, "x-found-in": "body" }, "collapse": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__FieldCollapse", "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", "x-found-in": "body" }, "indices_boost": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "number" } }, "description": "Boosts the _score of documents from specified indices.", "x-found-in": "body" }, "min_score": { "type": "number", "description": "Minimum _score for matching documents. Documents with a lower _score are\nnot 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", "x-found-in": "body" }, "profile": { "type": "boolean", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Defines the search definition using the Query DSL.", "x-found-in": "body" }, "rescore": { "anyOf": [{ "$ref": "./_global.search._types.json#/$defs/_global.search._types__Rescore" }, { "type": "array", "items": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Rescore" } }], "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", "x-found-in": "body" }, "slice": { "$ref": "./_types.json#/$defs/_types__SlicedScroll", "x-found-in": "body" }, "fields": { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching 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", "x-found-in": "body" }, "pit": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__PointInTimeReference", "description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an <index> in the request path.", "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" }, "index": { "anyOf": [{ "type": "string" }, { "type": "string" }], "description": "A single target to search. If the target is an index alias, it must resolve to a single index.", "x-found-in": "path" } }, "required": ["index"], "description": "Run a Fleet search.\n\nThe purpose of the Fleet search API is to provide an API where the search will be run only\nafter the provided checkpoint has been processed and is visible for searches inside of Elasticsearch." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "fleet.search", "description": "Run a Fleet search.\n\nThe purpose of the Fleet search API is to provide an API where the search will be run only\nafter the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.", "x-api": { "id": "fleet.search", "name": "search", "namespace": "fleet" }, "x-method": "GET", "x-path": "/{index}/_fleet/_fleet_search", "x-urls": [{ "path": "/{index}/_fleet/_fleet_search", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.16.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "private" } }, "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" }, "analyzer": { "type": "string", "x-found-in": "query" }, "analyze_wildcard": { "type": "boolean", "x-found-in": "query" }, "batched_reduce_size": { "type": "number", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "x-found-in": "query" }, "default_operator": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__Operator", "x-found-in": "query" }, "df": { "type": "string", "x-found-in": "query" }, "docvalue_fields": { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, "description": "Array of wildcard (*) patterns. The request returns doc values for field\nnames matching these patterns in the hits.fields property of the response.", "x-found-in": "body" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "x-found-in": "query" }, "explain": { "type": "boolean", "description": "If true, returns detailed information about score computation as part of a hit.", "x-found-in": "body" }, "ignore_throttled": { "type": "boolean", "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" }, "lenient": { "type": "boolean", "x-found-in": "query" }, "max_concurrent_shard_requests": { "type": "number", "x-found-in": "query" }, "preference": { "type": "string", "x-found-in": "query" }, "pre_filter_shard_size": { "type": "number", "x-found-in": "query" }, "request_cache": { "type": "boolean", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "x-found-in": "query" }, "scroll": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "query" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "x-found-in": "query" }, "stats": { "type": "array", "items": { "type": "string" }, "description": "Stats groups to associate with the search. Each group maintains a statistics\naggregation for its associated searches. You can retrieve these stats using\nthe indices stats API.", "x-found-in": "body" }, "stored_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "List of stored fields to return as part of a hit. If no fields are specified,\nno stored fields are included in the response. If this field is specified, the _source\nparameter defaults to false. You can pass _source: true to return both source fields\nand stored fields in the search response.", "x-found-in": "body" }, "suggest_field": { "type": "string", "description": "Specifies which field to use for suggestions.", "x-found-in": "query" }, "suggest_mode": { "$ref": "./_types.json#/$defs/_types__SuggestMode", "x-found-in": "query" }, "suggest_size": { "type": "number", "x-found-in": "query" }, "suggest_text": { "type": "string", "description": "The source text for which the suggestions should be returned.", "x-found-in": "query" }, "terminate_after": { "type": "number", "description": "Maximum number of documents to collect for each shard. If a query reaches this\nlimit, Elasticsearch terminates the query early. Elasticsearch collects documents\nbefore sorting. Defaults to 0, which does not terminate query execution early.", "x-found-in": "body" }, "timeout": { "type": "string", "description": "Specifies the period of time to wait for a response from each shard. If no response\nis 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. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.", "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", "x-found-in": "query" }, "rest_total_hits_as_int": { "type": "boolean", "x-found-in": "query" }, "version": { "type": "boolean", "description": "If true, returns document version as part of a hit.", "x-found-in": "body" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfig", "description": "Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.", "x-found-in": "body" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "x-found-in": "query" }, "seq_no_primary_term": { "type": "boolean", "description": "If true, returns sequence number and primary term of the last modification\nof each hit. See Optimistic concurrency control.", "x-found-in": "body" }, "q": { "type": "string", "x-found-in": "query" }, "size": { "type": "number", "description": "The number of hits to return. By default, you cannot page through more\nthan 10,000 hits using the from and size parameters. To page through more\nhits, use the search_after parameter.", "x-found-in": "body" }, "from": { "type": "number", "description": "Starting document offset. By default, you cannot page through more than 10,000\nhits using the from and size parameters. To page through more hits, use the\nsearch_after parameter.", "x-found-in": "body" }, "sort": { "$ref": "./_types.json#/$defs/_types__Sort", "x-found-in": "body" }, "wait_for_checkpoints": { "type": "array", "items": { "type": "number" }, "description": "A comma separated list of checkpoints. When configured, the search API will only be executed on a shard\nafter the relevant checkpoint has become visible for search. Defaults to an empty list which will cause\nElasticsearch to immediately execute the search.", "x-found-in": "query" }, "allow_partial_search_results": { "type": "boolean", "description": "If true, returns partial results if there are shard request timeouts or shard failures.\nIf false, returns an error with no partial results.\nDefaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default.", "x-found-in": "query" }, "aggregations": { "type": "object", "additionalProperties": { "$ref": "./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer" }, "x-found-in": "body" }, "collapse": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__FieldCollapse", "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", "x-found-in": "body" }, "indices_boost": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "number" } }, "description": "Boosts the _score of documents from specified indices.", "x-found-in": "body" }, "min_score": { "type": "number", "description": "Minimum _score for matching documents. Documents with a lower _score are\nnot 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", "x-found-in": "body" }, "profile": { "type": "boolean", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Defines the search definition using the Query DSL.", "x-found-in": "body" }, "rescore": { "anyOf": [{ "$ref": "./_global.search._types.json#/$defs/_global.search._types__Rescore" }, { "type": "array", "items": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Rescore" } }], "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", "x-found-in": "body" }, "slice": { "$ref": "./_types.json#/$defs/_types__SlicedScroll", "x-found-in": "body" }, "fields": { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching 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", "x-found-in": "body" }, "pit": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__PointInTimeReference", "description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an <index> in the request path.", "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" }, "index": { "anyOf": [{ "type": "string" }, { "type": "string" }], "description": "A single target to search. If the target is an index alias, it must resolve to a single index.", "x-found-in": "path" } }, "required": ["index"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get", "type": "object", "properties": { "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nBy default, the operation is randomized between the shard replicas.\n\nIf it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible.\nIf it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value.\nThis can help with \"jumping values\" when hitting different shards in different refresh states.\nA sample value can be something like the web session ID or the user name.", "x-found-in": "query" }, "realtime": { "type": "boolean", "description": "If `true`, the request is real-time as opposed to near-real-time.", "x-found-in": "query" }, "refresh": { "type": "boolean", "description": "If `true`, the request refreshes the relevant shards before retrieving the document.\nSetting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", "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" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", "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" }, "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`.\nOnly leaf fields can be retrieved with the `stored_fields` option.\nObject fields can't be returned; if specified, the request fails.", "x-found-in": "query" }, "version": { "type": "number", "description": "The version number for concurrency control.\nIt must match the current version of the document for the request to succeed.", "x-found-in": "query" }, "version_type": { "$ref": "./_types.json#/$defs/_types__VersionType", "description": "The version type.", "x-found-in": "query" }, "id": { "type": "string", "description": "A unique document identifier.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the index that contains the document.", "x-found-in": "path" } }, "required": ["id", "index"], "description": "Get a document by its ID.\n\nGet a document and its source or stored fields from an index.\n\nBy default, this API is realtime and is not affected by the refresh rate of the index (when data will become visible for search).\nIn the case where stored fields are requested with the `stored_fields` parameter and the document has been updated but is not yet refreshed, the API will have to parse and analyze the source to extract the stored fields.\nTo turn off realtime behavior, set the `realtime` parameter to false.\n\n**Source filtering**\n\nBy default, the API returns the contents of the `_source` field unless you have used the `stored_fields` parameter or the `_source` field is turned off.\nYou can turn off `_source` retrieval by using the `_source` parameter:\n\n```\nGET my-index-000001/_doc/0?_source=false\n```\n\nIf you only need one or two fields from the `_source`, use the `_source_includes` or `_source_excludes` parameters to include or filter out particular fields.\nThis can be helpful with large documents where partial retrieval can save on network overhead\nBoth parameters take a comma separated list of fields or wildcard expressions.\nFor example:\n\n```\nGET my-index-000001/_doc/0?_source_includes=*.id&_source_excludes=entities\n```\n\nIf you only want to specify includes, you can use a shorter notation:\n\n```\nGET my-index-000001/_doc/0?_source=*.id\n```\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to retrieve a document.\nFor example:\n\n```\nGET my-index-000001/_doc/2?routing=user1\n```\n\nThis request gets the document with ID 2, but it is routed based on the user.\nThe document is not fetched if the correct routing is not specified.\n\n**Distributed**\n\nThe GET operation is hashed into a specific shard ID.\nIt is then redirected to one of the replicas within that shard ID and returns the result.\nThe replicas are the primary shard and its replicas within that shard ID group.\nThis means that the more replicas you have, the better your GET scaling will be.\n\n**Versioning support**\n\nYou can use the `version` parameter to retrieve the document only if its current version is equal to the specified one.\n\nInternally, Elasticsearch has marked the old document as deleted and added an entirely new document.\nThe old version of the document doesn't disappear immediately, although you won't be able to access it.\nElasticsearch cleans up deleted documents in the background as you continue to index more data." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get", "description": "Get a document by its ID.\n\nGet a document and its source or stored fields from an index.\n\nBy default, this API is realtime and is not affected by the refresh rate of the index (when data will become visible for search).\nIn the case where stored fields are requested with the `stored_fields` parameter and the document has been updated but is not yet refreshed, the API will have to parse and analyze the source to extract the stored fields.\nTo turn off realtime behavior, set the `realtime` parameter to false.\n\n**Source filtering**\n\nBy default, the API returns the contents of the `_source` field unless you have used the `stored_fields` parameter or the `_source` field is turned off.\nYou can turn off `_source` retrieval by using the `_source` parameter:\n\n```\nGET my-index-000001/_doc/0?_source=false\n```\n\nIf you only need one or two fields from the `_source`, use the `_source_includes` or `_source_excludes` parameters to include or filter out particular fields.\nThis can be helpful with large documents where partial retrieval can save on network overhead\nBoth parameters take a comma separated list of fields or wildcard expressions.\nFor example:\n\n```\nGET my-index-000001/_doc/0?_source_includes=*.id&_source_excludes=entities\n```\n\nIf you only want to specify includes, you can use a shorter notation:\n\n```\nGET my-index-000001/_doc/0?_source=*.id\n```\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to retrieve a document.\nFor example:\n\n```\nGET my-index-000001/_doc/2?routing=user1\n```\n\nThis request gets the document with ID 2, but it is routed based on the user.\nThe document is not fetched if the correct routing is not specified.\n\n**Distributed**\n\nThe GET operation is hashed into a specific shard ID.\nIt is then redirected to one of the replicas within that shard ID and returns the result.\nThe replicas are the primary shard and its replicas within that shard ID group.\nThis means that the more replicas you have, the better your GET scaling will be.\n\n**Versioning support**\n\nYou can use the `version` parameter to retrieve the document only if its current version is equal to the specified one.\n\nInternally, Elasticsearch has marked the old document as deleted and added an entirely new document.\nThe old version of the document doesn't disappear immediately, although you won't be able to access it.\nElasticsearch cleans up deleted documents in the background as you continue to index more data.", "x-api": { "id": "get", "name": "get", "namespace": null }, "x-method": "GET", "x-path": "/{index}/_doc/{id}", "x-urls": [{ "path": "/{index}/_doc/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nBy default, the operation is randomized between the shard replicas.\n\nIf it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible.\nIf it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value.\nThis can help with \"jumping values\" when hitting different shards in different refresh states.\nA sample value can be something like the web session ID or the user name.", "x-found-in": "query" }, "realtime": { "type": "boolean", "description": "If `true`, the request is real-time as opposed to near-real-time.", "x-found-in": "query" }, "refresh": { "type": "boolean", "description": "If `true`, the request refreshes the relevant shards before retrieving the document.\nSetting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", "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" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", "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", "x-availability": { "stack": { "since": "9.2.0" }, "serverless": {} } }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "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`.\nOnly leaf fields can be retrieved with the `stored_fields` option.\nObject fields can't be returned; if specified, the request fails.", "x-found-in": "query" }, "version": { "type": "number", "description": "The version number for concurrency control.\nIt must match the current version of the document for the request to succeed.", "x-found-in": "query" }, "version_type": { "$ref": "./_types.json#/$defs/_types__VersionType", "description": "The version type.", "x-found-in": "query" }, "id": { "type": "string", "description": "A unique document identifier.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the index that contains the document.", "x-found-in": "path" } }, "required": ["id", "index"] }

package/lib/es/json/get_reindex.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get_reindex", "type": "object", "properties": { "wait_for_completion": { "type": "boolean", "description": "If `true`, the request blocks until the reindex task completes, then returns the result.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the reindex task to complete when `wait_for_completion` is `true`.", "x-found-in": "query" }, "task_id": { "type": "string", "description": "The ID of the reindex task to retrieve.", "x-found-in": "path" } }, "required": ["task_id"], "description": "Get the status and progress of a specific reindex task.\n\nThis API follows reindex tasks across node-shutdown relocations, so callers can\nkeep using the original task ID throughout the lifetime of the operation.\nReturned task IDs and timings reflect the original task, not its relocated successor.\nRelocated task IDs are also supported. They are followed transparently and return the task ID and timings of the original task.\n\nWhen the task ID cannot be resolved, the API returns the response below with a 404 status code.\nThis response is used whether the ID is unknown, refers to a non-reindex task, refers to a sliced child subtask, or refers to a task whose node left the cluster with no stored result (e.g. a non-graceful shutdown).\n```\n{\n  \"error\": {\n    \"type\": \"resource_not_found_exception\",\n    \"reason\": \"Reindex operation [r1A2WoRbTwKZ516z6NEs5A:36619] not found\"\n  },\n  \"status\": 404\n}\n```" }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get_reindex", "description": "Get the status and progress of a specific reindex task.\n\nThis API follows reindex tasks across node-shutdown relocations, so callers can\nkeep using the original task ID throughout the lifetime of the operation.\nReturned task IDs and timings reflect the original task, not its relocated successor.\nRelocated task IDs are also supported. They are followed transparently and return the task ID and timings of the original task.\n\nWhen the task ID cannot be resolved, the API returns the response below with a 404 status code.\nThis response is used whether the ID is unknown, refers to a non-reindex task, refers to a sliced child subtask, or refers to a task whose node left the cluster with no stored result (e.g. a non-graceful shutdown).\n```\n{\n  \"error\": {\n    \"type\": \"resource_not_found_exception\",\n    \"reason\": \"Reindex operation [r1A2WoRbTwKZ516z6NEs5A:36619] not found\"\n  },\n  \"status\": 404\n}\n```", "x-api": { "id": "get_reindex", "name": "get-reindex", "namespace": null }, "x-method": "GET", "x-path": "/_reindex/{task_id}", "x-urls": [{ "path": "/_reindex/{task_id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.5.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "wait_for_completion": { "type": "boolean", "description": "If `true`, the request blocks until the reindex task completes, then returns the result.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the reindex task to complete when `wait_for_completion` is `true`.", "x-found-in": "query" }, "task_id": { "type": "string", "description": "The ID of the reindex task to retrieve.", "x-found-in": "path" } }, "required": ["task_id"] }

package/lib/es/json/get_script.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get_script", "type": "object", "properties": { "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.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "id": { "type": "string", "description": "The identifier for the stored script or search template.", "x-found-in": "path" } }, "required": ["id"], "description": "Get a script or search template.\n\nRetrieves a stored script or search template." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get_script", "description": "Get a script or search template.\n\nRetrieves a stored script or search template.", "x-api": { "id": "get_script", "name": "get-script", "namespace": null }, "x-method": "GET", "x-path": "/_scripts/{id}", "x-urls": [{ "path": "/_scripts/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "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.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "id": { "type": "string", "description": "The identifier for the stored script or search template.", "x-found-in": "path" } }, "required": ["id"] }

package/lib/es/json/get_script_context.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get_script_context", "type": "object", "properties": {}, "description": "Get script contexts.\n\nGet a list of supported script contexts and their methods." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get_script_context", "description": "Get script contexts.\n\nGet a list of supported script contexts and their methods.", "x-api": { "id": "get_script_context", "name": "get-script-context", "namespace": null }, "x-method": "GET", "x-path": "/_script_context", "x-urls": [{ "path": "/_script_context", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": {} }

package/lib/es/json/get_script_languages.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get_script_languages", "type": "object", "properties": {}, "description": "Get script languages.\n\nGet a list of available script types, languages, and contexts." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get_script_languages", "description": "Get script languages.\n\nGet a list of available script types, languages, and contexts.", "x-api": { "id": "get_script_languages", "name": "get-script-languages", "namespace": null }, "x-method": "GET", "x-path": "/_script_language", "x-urls": [{ "path": "/_script_language", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": {} }

package/lib/es/json/get_source.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get_source", "type": "object", "properties": { "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nBy default, the operation is randomized between the shard replicas.", "x-found-in": "query" }, "realtime": { "type": "boolean", "description": "If `true`, the request is real-time as opposed to near-real-time.", "x-found-in": "query" }, "refresh": { "type": "boolean", "description": "If `true`, the request refreshes the relevant shards before retrieving the document.\nSetting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", "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" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to exclude in the response.", "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.", "x-found-in": "query" }, "version": { "type": "number", "description": "The version number for concurrency control.\nIt must match the current version of the document for the request to succeed.", "x-found-in": "query" }, "version_type": { "$ref": "./_types.json#/$defs/_types__VersionType", "description": "The version type.", "x-found-in": "query" }, "id": { "type": "string", "description": "A unique document identifier.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the index that contains the document.", "x-found-in": "path" } }, "required": ["id", "index"], "description": "Get a document's source.\n\nGet the source of a document.\nFor example:\n\n```\nGET my-index-000001/_source/1\n```\n\nYou can use the source filtering parameters to control which parts of the `_source` are returned:\n\n```\nGET my-index-000001/_source/1/?_source_includes=*.id&_source_excludes=entities\n```" }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "get_source", "description": "Get a document's source.\n\nGet the source of a document.\nFor example:\n\n```\nGET my-index-000001/_source/1\n```\n\nYou can use the source filtering parameters to control which parts of the `_source` are returned:\n\n```\nGET my-index-000001/_source/1/?_source_includes=*.id&_source_excludes=entities\n```", "x-api": { "id": "get_source", "name": "get-source", "namespace": null }, "x-method": "GET", "x-path": "/{index}/_source/{id}", "x-urls": [{ "path": "/{index}/_source/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nBy default, the operation is randomized between the shard replicas.", "x-found-in": "query" }, "realtime": { "type": "boolean", "description": "If `true`, the request is real-time as opposed to near-real-time.", "x-found-in": "query" }, "refresh": { "type": "boolean", "description": "If `true`, the request refreshes the relevant shards before retrieving the document.\nSetting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", "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" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to exclude in the response.", "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.", "x-found-in": "query" }, "version": { "type": "number", "description": "The version number for concurrency control.\nIt must match the current version of the document for the request to succeed.", "x-found-in": "query" }, "version_type": { "$ref": "./_types.json#/$defs/_types__VersionType", "description": "The version type.", "x-found-in": "query" }, "id": { "type": "string", "description": "A unique document identifier.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the index that contains the document.", "x-found-in": "path" } }, "required": ["id", "index"] }

package/lib/es/json/graph.explore.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "graph.explore", "type": "object", "properties": { "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "Custom value used to route operations to a specific shard.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies 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": "query" }, "connections": { "$ref": "./graph._types.json#/$defs/graph._types__Hop", "description": "Specifies or more fields from which you want to extract terms that are associated with the specified vertices.", "x-found-in": "body" }, "controls": { "$ref": "./graph._types.json#/$defs/graph._types__ExploreControls", "description": "Direct the Graph API how to build the graph.", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.", "x-found-in": "body" }, "vertices": { "type": "array", "items": { "$ref": "./graph._types.json#/$defs/graph._types__VertexDefinition" }, "description": "Specifies one or more fields that contain the terms you want to include in the graph as vertices.", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Name of the index.", "x-found-in": "path" } }, "required": ["index"], "description": "Explore graph analytics.\n\nExtract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behavior of this API is to use the Graph UI to explore connections.\nAn initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "graph.explore", "description": "Explore graph analytics.\n\nExtract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behavior of this API is to use the Graph UI to explore connections.\nAn initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned.", "x-api": { "id": "graph.explore", "name": "explore", "namespace": "graph" }, "x-method": "GET", "x-path": "/{index}/_graph/explore", "x-urls": [{ "path": "/{index}/_graph/explore", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "Custom value used to route operations to a specific shard.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies 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": "query" }, "connections": { "$ref": "./graph._types.json#/$defs/graph._types__Hop", "description": "Specifies or more fields from which you want to extract terms that are associated with the specified vertices.", "x-found-in": "body" }, "controls": { "$ref": "./graph._types.json#/$defs/graph._types__ExploreControls", "description": "Direct the Graph API how to build the graph.", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.", "x-found-in": "body" }, "vertices": { "type": "array", "items": { "$ref": "./graph._types.json#/$defs/graph._types__VertexDefinition" }, "description": "Specifies one or more fields that contain the terms you want to include in the graph as vertices.", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Name of the index.", "x-found-in": "path" } }, "required": ["index"] }

package/lib/es/json/health_report.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "health_report", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Explicit operation timeout.", "x-found-in": "query" }, "verbose": { "type": "boolean", "description": "Opt-in for more information about the health of the system.", "x-found-in": "query" }, "size": { "type": "number", "description": "Limit the number of affected resources the health report API returns.", "x-found-in": "query" }, "feature": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A feature of the cluster, as returned by the top-level health report API.", "x-found-in": "path" } }, "description": "Get the cluster health.\n\nGet a report with the health status of an Elasticsearch cluster.\nThe report contains a list of indicators that compose Elasticsearch functionality.\n\nEach indicator has a health status of: green, unknown, yellow or red.\nThe indicator will provide an explanation and metadata describing the reason for its current health status.\n\nThe cluster’s status is controlled by the worst indicator status.\n\nIn the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue.\nEach impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system.\n\nSome health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system.\nThe root cause and remediation steps are encapsulated in a diagnosis.\nA diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem.\n\nNOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently.\nWhen setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "health_report", "description": "Get the cluster health.\n\nGet a report with the health status of an Elasticsearch cluster.\nThe report contains a list of indicators that compose Elasticsearch functionality.\n\nEach indicator has a health status of: green, unknown, yellow or red.\nThe indicator will provide an explanation and metadata describing the reason for its current health status.\n\nThe cluster’s status is controlled by the worst indicator status.\n\nIn the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue.\nEach impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system.\n\nSome health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system.\nThe root cause and remediation steps are encapsulated in a diagnosis.\nA diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem.\n\nNOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently.\nWhen setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic.", "x-api": { "id": "health_report", "name": "health-report", "namespace": null }, "x-method": "GET", "x-path": "/_health_report/{feature}", "x-urls": [{ "path": "/_health_report", "methods": ["GET"] }, { "path": "/_health_report/{feature}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.7.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Explicit operation timeout.", "x-found-in": "query" }, "verbose": { "type": "boolean", "description": "Opt-in for more information about the health of the system.", "x-found-in": "query" }, "size": { "type": "number", "description": "Limit the number of affected resources the health report API returns.", "x-found-in": "query" }, "feature": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A feature of the cluster, as returned by the top-level health report API.", "x-found-in": "path" } } }

package/lib/es/json/ilm.delete_lifecycle.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.delete_lifecycle", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "policy": { "type": "string", "description": "Identifier for the policy.", "x-found-in": "path" } }, "required": ["policy"], "description": "Delete a lifecycle policy.\n\nYou cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.delete_lifecycle", "description": "Delete a lifecycle policy.\n\nYou cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.", "x-api": { "id": "ilm.delete_lifecycle", "name": "delete-lifecycle", "namespace": "ilm" }, "x-method": "DELETE", "x-path": "/_ilm/policy/{policy}", "x-urls": [{ "path": "/_ilm/policy/{policy}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "policy": { "type": "string", "description": "Identifier for the policy.", "x-found-in": "path" } }, "required": ["policy"] }

package/lib/es/json/ilm.explain_lifecycle.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.explain_lifecycle", "type": "object", "properties": { "only_errors": { "type": "boolean", "description": "Filters the returned indices to only indices that are managed by ILM and are in an error state, either due to an encountering an error while executing the policy, or attempting to use a policy that does not exist.", "x-found-in": "query" }, "only_managed": { "type": "boolean", "description": "Filters the returned indices to only indices that are managed by ILM.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "index": { "type": "string", "description": "Comma-separated list of data streams, indices, and aliases to target. Supports wildcards (`*`).\nTo target all data streams and indices, use `*` or `_all`.", "x-found-in": "path" } }, "required": ["index"], "description": "Explain the lifecycle state.\n\nGet the current lifecycle status for one or more indices.\nFor data streams, the API retrieves the current lifecycle status for the stream's backing indices.\n\nThe response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.explain_lifecycle", "description": "Explain the lifecycle state.\n\nGet the current lifecycle status for one or more indices.\nFor data streams, the API retrieves the current lifecycle status for the stream's backing indices.\n\nThe response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures.", "x-api": { "id": "ilm.explain_lifecycle", "name": "explain-lifecycle", "namespace": "ilm" }, "x-method": "GET", "x-path": "/{index}/_ilm/explain", "x-urls": [{ "path": "/{index}/_ilm/explain", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "type": "object", "properties": { "only_errors": { "type": "boolean", "description": "Filters the returned indices to only indices that are managed by ILM and are in an error state, either due to an encountering an error while executing the policy, or attempting to use a policy that does not exist.", "x-found-in": "query" }, "only_managed": { "type": "boolean", "description": "Filters the returned indices to only indices that are managed by ILM.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "index": { "type": "string", "description": "Comma-separated list of data streams, indices, and aliases to target. Supports wildcards (`*`).\nTo target all data streams and indices, use `*` or `_all`.", "x-found-in": "path" } }, "required": ["index"] }

package/lib/es/json/ilm.get_lifecycle.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.get_lifecycle", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "policy": { "type": "string", "description": "Identifier for the policy.", "x-found-in": "path" } }, "description": "Get lifecycle policies." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.get_lifecycle", "description": "Get lifecycle policies.", "x-api": { "id": "ilm.get_lifecycle", "name": "get-lifecycle", "namespace": "ilm" }, "x-method": "GET", "x-path": "/_ilm/policy/{policy}", "x-urls": [{ "path": "/_ilm/policy/{policy}", "methods": ["GET"] }, { "path": "/_ilm/policy", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "policy": { "type": "string", "description": "Identifier for the policy.", "x-found-in": "path" } } }

package/lib/es/json/ilm.get_status.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.get_status", "type": "object", "properties": {}, "description": "Get the ILM status.\n\nGet the current index lifecycle management status." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.get_status", "description": "Get the ILM status.\n\nGet the current index lifecycle management status.", "x-api": { "id": "ilm.get_status", "name": "get-status", "namespace": "ilm" }, "x-method": "GET", "x-path": "/_ilm/status", "x-urls": [{ "path": "/_ilm/status", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "type": "object", "properties": {} }

package/lib/es/json/ilm.migrate_to_data_tiers.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.migrate_to_data_tiers", "type": "object", "properties": { "dry_run": { "type": "boolean", "description": "If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration.\nThis provides a way to retrieve the indices and ILM policies that need to be migrated.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "legacy_template_to_delete": { "type": "string", "x-found-in": "body" }, "node_attribute": { "type": "string", "x-found-in": "body" } }, "description": "Migrate to data tiers routing.\n\nSwitch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers.\nOptionally, delete one legacy index template.\nUsing node roles enables ILM to automatically move the indices between data tiers.\n\nMigrating away from custom node attributes routing can be manually performed.\nThis API provides an automated way of performing three out of the four manual steps listed in the migration guide:\n\n1. Stop setting the custom hot attribute on new indices.\n1. Remove custom allocation settings from existing ILM policies.\n1. Replace custom allocation settings from existing indices with the corresponding tier preference.\n\nILM must be stopped before performing the migration.\nUse the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.migrate_to_data_tiers", "description": "Migrate to data tiers routing.\n\nSwitch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers.\nOptionally, delete one legacy index template.\nUsing node roles enables ILM to automatically move the indices between data tiers.\n\nMigrating away from custom node attributes routing can be manually performed.\nThis API provides an automated way of performing three out of the four manual steps listed in the migration guide:\n\n1. Stop setting the custom hot attribute on new indices.\n1. Remove custom allocation settings from existing ILM policies.\n1. Replace custom allocation settings from existing indices with the corresponding tier preference.\n\nILM must be stopped before performing the migration.\nUse the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`.", "x-api": { "id": "ilm.migrate_to_data_tiers", "name": "migrate-to-data-tiers", "namespace": "ilm" }, "x-method": "POST", "x-path": "/_ilm/migrate_to_data_tiers", "x-urls": [{ "path": "/_ilm/migrate_to_data_tiers", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.14.0", "stability": "stable" } }, "type": "object", "properties": { "dry_run": { "type": "boolean", "description": "If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration.\nThis provides a way to retrieve the indices and ILM policies that need to be migrated.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "legacy_template_to_delete": { "type": "string", "x-found-in": "body" }, "node_attribute": { "type": "string", "x-found-in": "body" } } }

package/lib/es/json/ilm.move_to_step.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.move_to_step", "type": "object", "properties": { "current_step": { "$ref": "./ilm.move_to_step.json#/$defs/ilm.move_to_step__StepKey", "description": "The step that the index is expected to be in.", "x-found-in": "body" }, "next_step": { "$ref": "./ilm.move_to_step.json#/$defs/ilm.move_to_step__StepKey", "description": "The step that you want to run.", "x-found-in": "body" }, "index": { "type": "string", "description": "The name of the index whose lifecycle step is to change", "x-found-in": "path" } }, "required": ["index", "current_step", "next_step"], "description": "Move to a lifecycle step.\n\nManually move an index into a specific step in the lifecycle policy and run that step.\n\nWARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API.\n\nYou must specify both the current step and the step to be executed in the body of the request.\nThe request will fail if the current step does not match the step currently running for the index\nThis is to prevent the index from being moved from an unexpected step into the next step.\n\nWhen specifying the target (`next_step`) to which the index will be moved, either the name or both the action and name fields are optional.\nIf only the phase is specified, the index will move to the first step of the first action in the target phase.\nIf the phase and action are specified, the index will move to the first step of the specified action in the specified phase.\nOnly actions specified in the ILM policy are considered valid.\nAn index cannot move to a step that is not part of its policy." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.move_to_step", "description": "Move to a lifecycle step.\n\nManually move an index into a specific step in the lifecycle policy and run that step.\n\nWARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API.\n\nYou must specify both the current step and the step to be executed in the body of the request.\nThe request will fail if the current step does not match the step currently running for the index\nThis is to prevent the index from being moved from an unexpected step into the next step.\n\nWhen specifying the target (`next_step`) to which the index will be moved, either the name or both the action and name fields are optional.\nIf only the phase is specified, the index will move to the first step of the first action in the target phase.\nIf the phase and action are specified, the index will move to the first step of the specified action in the specified phase.\nOnly actions specified in the ILM policy are considered valid.\nAn index cannot move to a step that is not part of its policy.", "x-api": { "id": "ilm.move_to_step", "name": "move-to-step", "namespace": "ilm" }, "x-method": "POST", "x-path": "/_ilm/move/{index}", "x-urls": [{ "path": "/_ilm/move/{index}", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "type": "object", "properties": { "current_step": { "$ref": "./ilm.move_to_step.json#/$defs/ilm.move_to_step__StepKey", "description": "The step that the index is expected to be in.", "x-found-in": "body" }, "next_step": { "$ref": "./ilm.move_to_step.json#/$defs/ilm.move_to_step__StepKey", "description": "The step that you want to run.", "x-found-in": "body" }, "index": { "type": "string", "description": "The name of the index whose lifecycle step is to change", "x-found-in": "path" } }, "required": ["index", "current_step", "next_step"] }

package/lib/es/json/ilm.put_lifecycle.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.put_lifecycle", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "policy": { "type": "string", "description": "Identifier for the policy.", "x-found-in": "path" } }, "required": ["policy"], "description": "Create or update a lifecycle policy.\n\nIf the specified policy exists, it is replaced and the policy version is incremented.\n\nNOTE: Only the latest version of the policy is stored, you cannot revert to previous versions." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.put_lifecycle", "description": "Create or update a lifecycle policy.\n\nIf the specified policy exists, it is replaced and the policy version is incremented.\n\nNOTE: Only the latest version of the policy is stored, you cannot revert to previous versions.", "x-api": { "id": "ilm.put_lifecycle", "name": "put-lifecycle", "namespace": "ilm" }, "x-method": "PUT", "x-path": "/_ilm/policy/{policy}", "x-urls": [{ "path": "/_ilm/policy/{policy}", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "policy": { "type": "string", "description": "Identifier for the policy.", "x-found-in": "path" } }, "required": ["policy"] }

package/lib/es/json/ilm.remove_policy.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.remove_policy", "type": "object", "properties": { "index": { "type": "string", "description": "The name of the index to remove policy on", "x-found-in": "path" } }, "required": ["index"], "description": "Remove policies from an index.\n\nRemove the assigned lifecycle policies from an index or a data stream's backing indices.\nIt also stops managing the indices." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.remove_policy", "description": "Remove policies from an index.\n\nRemove the assigned lifecycle policies from an index or a data stream's backing indices.\nIt also stops managing the indices.", "x-api": { "id": "ilm.remove_policy", "name": "remove-policy", "namespace": "ilm" }, "x-method": "POST", "x-path": "/{index}/_ilm/remove", "x-urls": [{ "path": "/{index}/_ilm/remove", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "type": "object", "properties": { "index": { "type": "string", "description": "The name of the index to remove policy on", "x-found-in": "path" } }, "required": ["index"] }

package/lib/es/json/ilm.retry.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.retry", "type": "object", "properties": { "index": { "type": "string", "description": "The name of the indices (comma-separated) whose failed lifecycle step is to be retry", "x-found-in": "path" } }, "required": ["index"], "description": "Retry a policy.\n\nRetry running the lifecycle policy for an index that is in the ERROR step.\nThe API sets the policy back to the step where the error occurred and runs the step.\nUse the explain lifecycle state API to determine whether an index is in the ERROR step." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.retry", "description": "Retry a policy.\n\nRetry running the lifecycle policy for an index that is in the ERROR step.\nThe API sets the policy back to the step where the error occurred and runs the step.\nUse the explain lifecycle state API to determine whether an index is in the ERROR step.", "x-api": { "id": "ilm.retry", "name": "retry", "namespace": "ilm" }, "x-method": "POST", "x-path": "/{index}/_ilm/retry", "x-urls": [{ "path": "/{index}/_ilm/retry", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "type": "object", "properties": { "index": { "type": "string", "description": "The name of the indices (comma-separated) whose failed lifecycle step is to be retry", "x-found-in": "path" } }, "required": ["index"] }

package/lib/es/json/ilm.start.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.start", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "description": "Start the ILM plugin.\n\nStart the index lifecycle management plugin if it is currently stopped.\nILM is started automatically when the cluster is formed.\nRestarting ILM is necessary only when it has been stopped using the stop ILM API." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.start", "description": "Start the ILM plugin.\n\nStart the index lifecycle management plugin if it is currently stopped.\nILM is started automatically when the cluster is formed.\nRestarting ILM is necessary only when it has been stopped using the stop ILM API.", "x-api": { "id": "ilm.start", "name": "start", "namespace": "ilm" }, "x-method": "POST", "x-path": "/_ilm/start", "x-urls": [{ "path": "/_ilm/start", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } } }

package/lib/es/json/ilm.stop.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.stop", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "description": "Stop the ILM plugin.\n\nHalt all lifecycle management operations and stop the index lifecycle management plugin.\nThis is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices.\n\nThe API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped.\nUse the get ILM status API to check whether ILM is running." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.stop", "description": "Stop the ILM plugin.\n\nHalt all lifecycle management operations and stop the index lifecycle management plugin.\nThis is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices.\n\nThe API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped.\nUse the get ILM status API to check whether ILM is running.", "x-api": { "id": "ilm.stop", "name": "stop", "namespace": "ilm" }, "x-method": "POST", "x-path": "/_ilm/stop", "x-urls": [{ "path": "/_ilm/stop", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.6.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } } }

package/lib/es/json/index.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "index", "type": "object", "properties": { "if_primary_term": { "type": "number", "description": "Only perform the operation if the document has this primary term.", "x-found-in": "query" }, "if_seq_no": { "type": "number", "description": "Only perform the operation if the document has this sequence number.", "x-found-in": "query" }, "include_source_on_error": { "type": "boolean", "description": "True or false if to include the document source in the error message in case of parsing errors.", "x-found-in": "query" }, "op_type": { "$ref": "./_types.json#/$defs/_types__OpType", "description": "Set to `create` to only index the document if it does not already exist (put if absent).\nIf a document with the specified `_id` already exists, the indexing operation will fail.\nThe behavior is the same as using the `<index>/_create` endpoint.\nIf a document ID is specified, this paramater defaults to `index`.\nOtherwise, it defaults to `create`.\nIf the request targets a data stream, an `op_type` of `create` is required.", "x-found-in": "query" }, "pipeline": { "type": "string", "description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", "x-found-in": "query" }, "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf `wait_for`, it waits for a refresh to make this operation visible to search.\nIf `false`, it does nothing with refreshes.", "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" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.\n\nThis parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation.\nBy default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error.\nThe actual wait time could be longer, particularly when multiple waits occur.", "x-found-in": "query" }, "version": { "type": "number", "description": "An explicit version number for concurrency control.\nIt must be a non-negative long number.", "x-found-in": "query" }, "version_type": { "$ref": "./_types.json#/$defs/_types__VersionType", "description": "The version type.", "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.\nYou can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default value of `1` means it waits for each primary shard to be active.", "x-found-in": "query" }, "require_alias": { "type": "boolean", "description": "If `true`, the destination must be an index alias.", "x-found-in": "query" }, "require_data_stream": { "type": "boolean", "description": "If `true`, the request's actions must target a data stream (existing or to be created).", "x-found-in": "query" }, "document": { "x-found-in": "body" }, "id": { "type": "string", "description": "A unique identifier for the document.\nTo automatically generate a document ID, use the `POST /<target>/_doc/` request format and omit this parameter.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the data stream or index to target.\nIf the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.\nIf the target doesn't exist and doesn't match a data stream template, this request creates the index.\nYou can check for existing targets with the resolve index API.", "x-found-in": "path" } }, "required": ["index"], "description": "Create or update a document in an index.\n\nAdd a JSON document to the specified data stream or index and make it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.\n\nNOTE: You cannot use this API to send update requests for existing documents in a data stream.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add or overwrite a document using the `PUT /<target>/_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege.\n* To add a document using the `POST /<target>/_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nNOTE: Replica shards might not all be started when an indexing operation returns successfully.\nBy default, only the primary is required. Set `wait_for_active_shards` to change this default behavior (this parameter is not available in Elasticsearch Serverless).\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Optimistic concurrency control**\n\nIndex operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter (this parameter is not available in Elasticsearch Serverless).\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.\n\n**No operation (noop) updates**\n\nWhen updating a document by using this API, a new version of the document is always created even if the document hasn't changed.\nIf this isn't acceptable use the `_update` API with `detect_noop` set to `true`.\nThe `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.\n\nThere isn't a definitive rule for when noop updates aren't acceptable.\nIt's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.\n\n**Versioning**\n\nEach indexed document is given a version number.\nBy default, internal versioning is used that starts at 1 and increments with each update, deletes included.\nOptionally, the version number can be set to an external value (for example, if maintained in a database).\nTo enable this functionality, `version_type` should be set to `external`.\nThe value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.\n\nNOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations.\nIf no version is provided, the operation runs without any version checks.\n\nWhen using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.\nIf true, the document will be indexed and the new version number used.\nIf the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:\n\n```\nPUT my-index-000001/_doc/1?version=2&version_type=external\n{\n  \"user\": {\n    \"id\": \"elkbee\"\n  }\n}\n```\n\nIn this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.\nIf the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).\n\nA nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.\nEven the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "index", "description": "Create or update a document in an index.\n\nAdd a JSON document to the specified data stream or index and make it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.\n\nNOTE: You cannot use this API to send update requests for existing documents in a data stream.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add or overwrite a document using the `PUT /<target>/_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege.\n* To add a document using the `POST /<target>/_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nNOTE: Replica shards might not all be started when an indexing operation returns successfully.\nBy default, only the primary is required. Set `wait_for_active_shards` to change this default behavior (this parameter is not available in Elasticsearch Serverless).\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Optimistic concurrency control**\n\nIndex operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter (this parameter is not available in Elasticsearch Serverless).\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.\n\n**No operation (noop) updates**\n\nWhen updating a document by using this API, a new version of the document is always created even if the document hasn't changed.\nIf this isn't acceptable use the `_update` API with `detect_noop` set to `true`.\nThe `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.\n\nThere isn't a definitive rule for when noop updates aren't acceptable.\nIt's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.\n\n**Versioning**\n\nEach indexed document is given a version number.\nBy default, internal versioning is used that starts at 1 and increments with each update, deletes included.\nOptionally, the version number can be set to an external value (for example, if maintained in a database).\nTo enable this functionality, `version_type` should be set to `external`.\nThe value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.\n\nNOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations.\nIf no version is provided, the operation runs without any version checks.\n\nWhen using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.\nIf true, the document will be indexed and the new version number used.\nIf the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:\n\n```\nPUT my-index-000001/_doc/1?version=2&version_type=external\n{\n  \"user\": {\n    \"id\": \"elkbee\"\n  }\n}\n```\n\nIn this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.\nIf the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).\n\nA nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.\nEven the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order.", "x-api": { "id": "index", "name": "index", "namespace": null }, "x-method": "PUT", "x-path": "/{index}/_doc/{id}", "x-urls": [{ "path": "/{index}/_doc/{id}", "methods": ["PUT", "POST"] }, { "path": "/{index}/_doc", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "if_primary_term": { "type": "number", "description": "Only perform the operation if the document has this primary term.", "x-found-in": "query" }, "if_seq_no": { "type": "number", "description": "Only perform the operation if the document has this sequence number.", "x-found-in": "query" }, "include_source_on_error": { "type": "boolean", "description": "True or false if to include the document source in the error message in case of parsing errors.", "x-found-in": "query" }, "op_type": { "$ref": "./_types.json#/$defs/_types__OpType", "description": "Set to `create` to only index the document if it does not already exist (put if absent).\nIf a document with the specified `_id` already exists, the indexing operation will fail.\nThe behavior is the same as using the `<index>/_create` endpoint.\nIf a document ID is specified, this paramater defaults to `index`.\nOtherwise, it defaults to `create`.\nIf the request targets a data stream, an `op_type` of `create` is required.", "x-found-in": "query" }, "pipeline": { "type": "string", "description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", "x-found-in": "query" }, "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf `wait_for`, it waits for a refresh to make this operation visible to search.\nIf `false`, it does nothing with refreshes.", "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" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.\n\nThis parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation.\nBy default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error.\nThe actual wait time could be longer, particularly when multiple waits occur.", "x-found-in": "query" }, "version": { "type": "number", "description": "An explicit version number for concurrency control.\nIt must be a non-negative long number.", "x-found-in": "query" }, "version_type": { "$ref": "./_types.json#/$defs/_types__VersionType", "description": "The version type.", "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.\nYou can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default value of `1` means it waits for each primary shard to be active.", "x-found-in": "query", "x-availability": { "stack": {} } }, "require_alias": { "type": "boolean", "description": "If `true`, the destination must be an index alias.", "x-found-in": "query" }, "require_data_stream": { "type": "boolean", "description": "If `true`, the request's actions must target a data stream (existing or to be created).", "x-found-in": "query" }, "document": { "x-found-in": "body", "x-body-root": true }, "id": { "type": "string", "description": "A unique identifier for the document.\nTo automatically generate a document ID, use the `POST /<target>/_doc/` request format and omit this parameter.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the data stream or index to target.\nIf the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.\nIf the target doesn't exist and doesn't match a data stream template, this request creates the index.\nYou can check for existing targets with the resolve index API.", "x-found-in": "path" } }, "required": ["index"] }

package/lib/es/json/indices.add_block.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.add_block", "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": "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_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" }, "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.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list or wildcard expression of index names used to limit the request.\nBy default, you must explicitly name the indices you are adding blocks to.\nTo allow the adding of blocks to indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.\nYou can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API.", "x-found-in": "path" }, "block": { "$ref": "./indices._types.json#/$defs/indices._types__IndicesBlockOptions", "description": "The block type to add to the index.", "x-found-in": "path" } }, "required": ["index", "block"], "description": "Add an index block.\n\nAdd an index block to an index.\nIndex blocks limit the operations allowed on an index by blocking specific operation types." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.add_block", "description": "Add an index block.\n\nAdd an index block to an index.\nIndex blocks limit the operations allowed on an index by blocking specific operation types.", "x-api": { "id": "indices.add_block", "name": "add-block", "namespace": "indices" }, "x-method": "PUT", "x-path": "/{index}/_block/{block}", "x-urls": [{ "path": "/{index}/_block/{block}", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "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_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" }, "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.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list or wildcard expression of index names used to limit the request.\nBy default, you must explicitly name the indices you are adding blocks to.\nTo allow the adding of blocks to indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.\nYou can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API.", "x-found-in": "path" }, "block": { "$ref": "./indices._types.json#/$defs/indices._types__IndicesBlockOptions", "description": "The block type to add to the index.", "x-found-in": "path" } }, "required": ["index", "block"] }

package/lib/es/json/indices.analyze.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.analyze", "type": "object", "properties": { "index": { "type": "string", "description": "Index used to derive the analyzer.\nIf specified, the `analyzer` or field parameter overrides this value.\nIf no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.", "x-found-in": "path" }, "analyzer": { "type": "string", "description": "The name of the analyzer that should be applied to the provided `text`.\nThis could be a built-in analyzer, or an analyzer that’s been configured in the index.", "x-found-in": "body" }, "attributes": { "type": "array", "items": { "type": "string" }, "description": "Array of token attributes used to filter the output of the `explain` parameter.", "x-found-in": "body" }, "char_filter": { "type": "array", "items": { "$ref": "./_types.analysis.json#/$defs/_types.analysis__CharFilter" }, "description": "Array of character filters used to preprocess characters before the tokenizer.", "x-found-in": "body" }, "explain": { "type": "boolean", "description": "If `true`, the response includes token attributes and additional details.", "x-found-in": "body" }, "field": { "type": "string", "description": "Field used to derive the analyzer.\nTo use this parameter, you must specify an index.\nIf specified, the `analyzer` parameter overrides this value.", "x-found-in": "body" }, "filter": { "type": "array", "items": { "$ref": "./_types.analysis.json#/$defs/_types.analysis__TokenFilter" }, "description": "Array of token filters used to apply after the tokenizer.", "x-found-in": "body" }, "normalizer": { "type": "string", "description": "Normalizer to use to convert text into a single token.", "x-found-in": "body" }, "text": { "$ref": "./indices.analyze.json#/$defs/indices.analyze__TextToAnalyze", "description": "Text to analyze.\nIf an array of strings is provided, it is analyzed as a multi-value field.", "x-found-in": "body" }, "tokenizer": { "$ref": "./_types.analysis.json#/$defs/_types.analysis__Tokenizer", "description": "Tokenizer to use to convert text into tokens.", "x-found-in": "body" } }, "description": "Get tokens from text analysis.\n\nThe analyze API performs analysis on a text string and returns the resulting tokens.\n\nGenerating excessive amount of tokens may cause a node to run out of memory.\nThe `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced.\nIf more than this limit of tokens gets generated, an error occurs.\nThe `_analyze` endpoint without a specified index will always use `10000` as its limit." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.analyze", "description": "Get tokens from text analysis.\n\nThe analyze API performs analysis on a text string and returns the resulting tokens.\n\nGenerating excessive amount of tokens may cause a node to run out of memory.\nThe `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced.\nIf more than this limit of tokens gets generated, an error occurs.\nThe `_analyze` endpoint without a specified index will always use `10000` as its limit.", "x-api": { "id": "indices.analyze", "name": "analyze", "namespace": "indices" }, "x-method": "GET", "x-path": "/{index}/_analyze", "x-urls": [{ "path": "/_analyze", "methods": ["GET", "POST"] }, { "path": "/{index}/_analyze", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "index": { "type": "string", "description": "Index used to derive the analyzer.\nIf specified, the `analyzer` or field parameter overrides this value.\nIf no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.", "x-found-in": "path" }, "analyzer": { "type": "string", "description": "The name of the analyzer that should be applied to the provided `text`.\nThis could be a built-in analyzer, or an analyzer that’s been configured in the index.", "x-found-in": "body" }, "attributes": { "type": "array", "items": { "type": "string" }, "description": "Array of token attributes used to filter the output of the `explain` parameter.", "x-found-in": "body" }, "char_filter": { "type": "array", "items": { "$ref": "./_types.analysis.json#/$defs/_types.analysis__CharFilter" }, "description": "Array of character filters used to preprocess characters before the tokenizer.", "x-found-in": "body" }, "explain": { "type": "boolean", "description": "If `true`, the response includes token attributes and additional details.", "x-found-in": "body" }, "field": { "type": "string", "description": "Field used to derive the analyzer.\nTo use this parameter, you must specify an index.\nIf specified, the `analyzer` parameter overrides this value.", "x-found-in": "body" }, "filter": { "type": "array", "items": { "$ref": "./_types.analysis.json#/$defs/_types.analysis__TokenFilter" }, "description": "Array of token filters used to apply after the tokenizer.", "x-found-in": "body" }, "normalizer": { "type": "string", "description": "Normalizer to use to convert text into a single token.", "x-found-in": "body" }, "text": { "$ref": "./indices.analyze.json#/$defs/indices.analyze__TextToAnalyze", "description": "Text to analyze.\nIf an array of strings is provided, it is analyzed as a multi-value field.", "x-found-in": "body" }, "tokenizer": { "$ref": "./_types.analysis.json#/$defs/_types.analysis__Tokenizer", "description": "Tokenizer to use to convert text into tokens.", "x-found-in": "body" } } }

package/lib/es/json/indices.cancel_migrate_reindex.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.cancel_migrate_reindex", "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "The index or data stream name", "x-found-in": "path" } }, "required": ["index"], "description": "Cancel a migration reindex operation.\n\nCancel a migration reindex attempt for a data stream or index." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.cancel_migrate_reindex", "description": "Cancel a migration reindex operation.\n\nCancel a migration reindex attempt for a data stream or index.", "x-api": { "id": "indices.cancel_migrate_reindex", "name": "cancel-migrate-reindex", "namespace": "indices" }, "x-method": "POST", "x-path": "/_migration/reindex/{index}/_cancel", "x-urls": [{ "path": "/_migration/reindex/{index}/_cancel", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.18.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "The index or data stream name", "x-found-in": "path" } }, "required": ["index"] }

package/lib/es/json/indices.clear_cache.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.clear_cache", "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo target 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" }, "fielddata": { "type": "boolean", "description": "If `true`, clears the fields cache.\nUse the `fields` parameter to clear the cache of specific fields only.", "x-found-in": "query" }, "fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list of field names used to limit the `fielddata` parameter.", "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" }, "query": { "type": "boolean", "description": "If `true`, clears the query cache.", "x-found-in": "query" }, "request": { "type": "boolean", "description": "If `true`, clears the request cache.", "x-found-in": "query" } }, "description": "Clear the cache.\n\nClear the cache of one or more indices.\nFor data streams, the API clears the caches of the stream's backing indices.\n\nBy default, the clear cache API clears all caches.\nTo clear only specific caches, use the `fielddata`, `query`, or `request` parameters.\nTo clear the cache only of specific fields, use the `fields` parameter." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.clear_cache", "description": "Clear the cache.\n\nClear the cache of one or more indices.\nFor data streams, the API clears the caches of the stream's backing indices.\n\nBy default, the clear cache API clears all caches.\nTo clear only specific caches, use the `fielddata`, `query`, or `request` parameters.\nTo clear the cache only of specific fields, use the `fields` parameter.", "x-api": { "id": "indices.clear_cache", "name": "clear-cache", "namespace": "indices" }, "x-method": "POST", "x-path": "/{index}/_cache/clear", "x-urls": [{ "path": "/_cache/clear", "methods": ["POST"] }, { "path": "/{index}/_cache/clear", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo target 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" }, "fielddata": { "type": "boolean", "description": "If `true`, clears the fields cache.\nUse the `fields` parameter to clear the cache of specific fields only.", "x-found-in": "query" }, "fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list of field names used to limit the `fielddata` parameter.", "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" }, "query": { "type": "boolean", "description": "If `true`, clears the query cache.", "x-found-in": "query" }, "request": { "type": "boolean", "description": "If `true`, clears the request cache.", "x-found-in": "query" } } }

package/lib/es/json/indices.clone.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.clone", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "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 to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "x-found-in": "query" }, "aliases": { "type": "object", "additionalProperties": { "$ref": "./indices._types.json#/$defs/indices._types__Alias" }, "description": "Aliases for the resulting index.", "x-found-in": "body" }, "settings": { "type": "object", "additionalProperties": {}, "description": "Configuration options for the target index.", "x-found-in": "body" }, "index": { "type": "string", "description": "Name of the source index to clone.", "x-found-in": "path" }, "target": { "type": "string", "description": "Name of the target index to create.", "x-found-in": "path" } }, "required": ["index", "target"], "description": "Clone an index.\n\nClone an existing index into a new index.\nEach original primary shard is cloned into a new primary shard in the new index.\n\nIMPORTANT: Elasticsearch does not apply index templates to the resulting index.\nThe API also does not copy index metadata from the original index.\nIndex metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information.\nFor example, if you clone a CCR follower index, the resulting clone will not be a follower index.\n\nThe clone API copies most index settings from the source index to the resulting index, with the exception of `index.number_of_replicas` and `index.auto_expand_replicas`.\nTo set the number of replicas in the resulting index, configure these settings in the clone request.\n\nCloning works as follows:\n\n* First, it creates a new target index with the same definition as the source index.\n* Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Finally, it recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be cloned if they meet the following requirements:\n\n* The index must be marked as read-only and have a cluster health status of green.\n* The target index must not exist.\n* The source index must have the same number of primary shards as the target index.\n* The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index.\n\nThe current write index on a data stream cannot be cloned.\nIn order to clone the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be cloned.\n\nNOTE: Mappings cannot be specified in the `_clone` request. The mappings of the source index will be used for the target index.\n\n**Monitor the cloning process**\n\nThe cloning process can be monitored with the cat recovery API or the cluster health API can be used to wait until all primary shards have been allocated by setting the `wait_for_status` parameter to `yellow`.\n\nThe `_clone` API returns as soon as the target index has been added to the cluster state, before any shards have been allocated.\nAt this point, all shards are in the state unassigned.\nIf, for any reason, the target index can't be allocated, its primary shard will remain unassigned until it can be allocated on that node.\n\nOnce the primary shard is allocated, it moves to state initializing, and the clone process begins.\nWhen the clone operation completes, the shard will become active.\nAt that point, Elasticsearch will try to allocate any replicas and may decide to relocate the primary shard to another node.\n\n**Wait for active shards**\n\nBecause the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.clone", "description": "Clone an index.\n\nClone an existing index into a new index.\nEach original primary shard is cloned into a new primary shard in the new index.\n\nIMPORTANT: Elasticsearch does not apply index templates to the resulting index.\nThe API also does not copy index metadata from the original index.\nIndex metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information.\nFor example, if you clone a CCR follower index, the resulting clone will not be a follower index.\n\nThe clone API copies most index settings from the source index to the resulting index, with the exception of `index.number_of_replicas` and `index.auto_expand_replicas`.\nTo set the number of replicas in the resulting index, configure these settings in the clone request.\n\nCloning works as follows:\n\n* First, it creates a new target index with the same definition as the source index.\n* Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Finally, it recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be cloned if they meet the following requirements:\n\n* The index must be marked as read-only and have a cluster health status of green.\n* The target index must not exist.\n* The source index must have the same number of primary shards as the target index.\n* The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index.\n\nThe current write index on a data stream cannot be cloned.\nIn order to clone the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be cloned.\n\nNOTE: Mappings cannot be specified in the `_clone` request. The mappings of the source index will be used for the target index.\n\n**Monitor the cloning process**\n\nThe cloning process can be monitored with the cat recovery API or the cluster health API can be used to wait until all primary shards have been allocated by setting the `wait_for_status` parameter to `yellow`.\n\nThe `_clone` API returns as soon as the target index has been added to the cluster state, before any shards have been allocated.\nAt this point, all shards are in the state unassigned.\nIf, for any reason, the target index can't be allocated, its primary shard will remain unassigned until it can be allocated on that node.\n\nOnce the primary shard is allocated, it moves to state initializing, and the clone process begins.\nWhen the clone operation completes, the shard will become active.\nAt that point, Elasticsearch will try to allocate any replicas and may decide to relocate the primary shard to another node.\n\n**Wait for active shards**\n\nBecause the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well.", "x-api": { "id": "indices.clone", "name": "clone", "namespace": "indices" }, "x-method": "PUT", "x-path": "/{index}/_clone/{target}", "x-urls": [{ "path": "/{index}/_clone/{target}", "methods": ["PUT", "POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.4.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "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 to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "x-found-in": "query", "x-availability": { "stack": {} } }, "aliases": { "type": "object", "additionalProperties": { "$ref": "./indices._types.json#/$defs/indices._types__Alias" }, "description": "Aliases for the resulting index.", "x-found-in": "body" }, "settings": { "type": "object", "additionalProperties": {}, "description": "Configuration options for the target index.", "x-found-in": "body" }, "index": { "type": "string", "description": "Name of the source index to clone.", "x-found-in": "path" }, "target": { "type": "string", "description": "Name of the target index to create.", "x-found-in": "path" } }, "required": ["index", "target"] }

package/lib/es/json/indices.close.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.close", "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" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "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 to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list or wildcard expression of index names used to limit the request.", "x-found-in": "path" } }, "required": ["index"], "description": "Close an index.\n\nA closed index is blocked for read or write operations and does not allow all operations that opened indices allow.\nIt is not possible to index documents or to search for documents in a closed index.\nClosed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster.\n\nWhen opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index.\nThe shards will then go through the normal recovery process.\nThe data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.\n\nYou can open and close multiple indices.\nAn error is thrown if the request explicitly refers to a missing index.\nThis behaviour can be turned off using the `ignore_unavailable=true` parameter.\n\nBy default, you must explicitly name the indices you are opening or closing.\nTo open or close indices with `_all`, `*`, or other wildcard expressions, change the` action.destructive_requires_name` setting to `false`. This setting can also be changed with the cluster update settings API.\n\nClosed indices consume a significant amount of disk-space which can cause problems in managed environments.\nClosing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.close", "description": "Close an index.\n\nA closed index is blocked for read or write operations and does not allow all operations that opened indices allow.\nIt is not possible to index documents or to search for documents in a closed index.\nClosed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster.\n\nWhen opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index.\nThe shards will then go through the normal recovery process.\nThe data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.\n\nYou can open and close multiple indices.\nAn error is thrown if the request explicitly refers to a missing index.\nThis behaviour can be turned off using the `ignore_unavailable=true` parameter.\n\nBy default, you must explicitly name the indices you are opening or closing.\nTo open or close indices with `_all`, `*`, or other wildcard expressions, change the` action.destructive_requires_name` setting to `false`. This setting can also be changed with the cluster update settings API.\n\nClosed indices consume a significant amount of disk-space which can cause problems in managed environments.\nClosing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`.", "x-api": { "id": "indices.close", "name": "close", "namespace": "indices" }, "x-method": "POST", "x-path": "/{index}/_close", "x-urls": [{ "path": "/{index}/_close", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "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" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "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 to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "x-found-in": "query", "x-availability": { "stack": {} } }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list or wildcard expression of index names used to limit the request.", "x-found-in": "path" } }, "required": ["index"] }