@elastic/schemas 0.4.4 → 0.4.5

package/src/es/json/indices.rollover.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.rollover","type":"object","properties":{"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"},"description":"Aliases for the target index.\nData streams do not support this parameter.","x-found-in":"body"},"conditions":{"$ref":"./indices.rollover.json#/$defs/indices.rollover__RolloverConditions","description":"Conditions for the rollover.\nIf specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.\nIf this parameter is not specified, Elasticsearch performs the rollover unconditionally.\nIf conditions are specified, at least one of them must be a `max_*` condition.\nThe index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied.","x-found-in":"body"},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","description":"Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping paramaters.","x-found-in":"body"},"settings":{"type":"object","additionalProperties":{},"description":"Configuration options for the index.\nData streams do not support this parameter.","x-found-in":"body"},"dry_run":{"type":"boolean","description":"If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover.","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"},"lazy":{"type":"boolean","description":"If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write.\nOnly allowed on data streams.","x-found-in":"query"},"alias":{"type":"string","description":"Name of the data stream or index alias to roll over.","x-found-in":"path"},"new_index":{"type":"string","description":"Name of the index to create.\nSupports date math.\nData streams do not support this parameter.","x-found-in":"path"}},"required":["alias"],"description":"Roll over to a new index.\n\nTIP: We recommend using the index lifecycle rollover action to automate rollovers. However, Serverless does not support Index Lifecycle Management (ILM), so don't use this approach in the Serverless context.\n\nThe rollover API creates a new index for a data stream or index alias.\nThe API behavior depends on the rollover target.\n\n**Roll over a data stream**\n\nIf you roll over a data stream, the API creates a new write index for the stream.\nThe stream's previous write index becomes a regular backing index.\nA rollover also increments the data stream's generation.\n\n**Roll over an index alias with a write index**\n\nTIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data.\nData streams replace this functionality, require less maintenance, and automatically integrate with data tiers.\n\nIf an index alias points to multiple indices, one of the indices must be a write index.\nThe rollover API creates a new write index for the alias with `is_write_index` set to `true`.\nThe API also `sets is_write_index` to `false` for the previous write index.\n\n**Roll over an index alias with one index**\n\nIf you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.\n\nNOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting.\n\n**Increment index names for an alias**\n\nWhen you roll over an index alias, you can specify a name for the new index.\nIf you don't specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number.\nFor example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`.\nThis number is always six characters and zero-padded, regardless of the previous index's name.\n\nIf you use an index alias for time series data, you can use date math in the index name to track the rollover date.\nFor example, you can create an alias that points to an index named `<my-index-{now/d}-000001>`.\nIf you create the index on May 6, 2099, the index's name is `my-index-2099.05.06-000001`.\nIf you roll over the alias on May 7, 2099, the new index's name is `my-index-2099.05.07-000002`."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.rollover","type":"object","properties":{"dry_run":{"type":"boolean","description":"If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover.","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"},"lazy":{"type":"boolean","description":"If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write.\nOnly allowed on data streams.","x-found-in":"query"},"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"},"description":"Aliases for the target index.\nData streams do not support this parameter.","x-found-in":"body"},"conditions":{"$ref":"./indices.rollover.json#/$defs/indices.rollover__RolloverConditions","description":"Conditions for the rollover.\nIf specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.\nIf this parameter is not specified, Elasticsearch performs the rollover unconditionally.\nIf conditions are specified, at least one of them must be a `max_*` condition.\nThe index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied.","x-found-in":"body"},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","description":"Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping paramaters.","x-found-in":"body"},"settings":{"type":"object","additionalProperties":{},"description":"Configuration options for the index.\nData streams do not support this parameter.","x-found-in":"body"},"alias":{"type":"string","description":"Name of the data stream or index alias to roll over.","x-found-in":"path"},"new_index":{"type":"string","description":"Name of the index to create.\nSupports date math.\nData streams do not support this parameter.","x-found-in":"path"}},"required":["alias"],"description":"Roll over to a new index.\n\nTIP: We recommend using the index lifecycle rollover action to automate rollovers. However, Serverless does not support Index Lifecycle Management (ILM), so don't use this approach in the Serverless context.\n\nThe rollover API creates a new index for a data stream or index alias.\nThe API behavior depends on the rollover target.\n\n**Roll over a data stream**\n\nIf you roll over a data stream, the API creates a new write index for the stream.\nThe stream's previous write index becomes a regular backing index.\nA rollover also increments the data stream's generation.\n\n**Roll over an index alias with a write index**\n\nTIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data.\nData streams replace this functionality, require less maintenance, and automatically integrate with data tiers.\n\nIf an index alias points to multiple indices, one of the indices must be a write index.\nThe rollover API creates a new write index for the alias with `is_write_index` set to `true`.\nThe API also `sets is_write_index` to `false` for the previous write index.\n\n**Roll over an index alias with one index**\n\nIf you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.\n\nNOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting.\n\n**Increment index names for an alias**\n\nWhen you roll over an index alias, you can specify a name for the new index.\nIf you don't specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number.\nFor example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`.\nThis number is always six characters and zero-padded, regardless of the previous index's name.\n\nIf you use an index alias for time series data, you can use date math in the index name to track the rollover date.\nFor example, you can create an alias that points to an index named `<my-index-{now/d}-000001>`.\nIf you create the index on May 6, 2099, the index's name is `my-index-2099.05.06-000001`.\nIf you roll over the alias on May 7, 2099, the new index's name is `my-index-2099.05.07-000002`."}

package/src/es/json/indices.segments.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices.segments__IndexSegment":{"type":"object","properties":{"shards":{"type":"object","additionalProperties":{"oneOf":[{"$ref":"./indices.segments.json#/$defs/indices.segments__ShardsSegment"},{"type":"array","items":{"$ref":"./indices.segments.json#/$defs/indices.segments__ShardsSegment"}}]}}},"required":["shards"]},"indices.segments__ShardsSegment":{"type":"object","properties":{"num_committed_segments":{"type":"number"},"routing":{"$ref":"./indices.segments.json#/$defs/indices.segments__ShardSegmentRouting"},"num_search_segments":{"type":"number"},"segments":{"type":"object","additionalProperties":{"$ref":"./indices.segments.json#/$defs/indices.segments__Segment"}}},"required":["num_committed_segments","routing","num_search_segments","segments"]},"indices.segments__ShardSegmentRouting":{"type":"object","properties":{"node":{"type":"string","description":"The node ID of the node that holds the shard."},"primary":{"type":"boolean","description":"If `true`, the shard is a primary shard."},"state":{"type":"string","description":"The state of the shard, such as `STARTED` or `RELOCATING`."}},"required":["node","primary","state"]},"indices.segments__Segment":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"},"description":"Contains information about whether high compression was enabled and per-field vector formats."},"committed":{"type":"boolean","description":"If `true`, the segment is synced to disk. Segments that are synced can survive a hard reboot.\nIf `false`, the data from uncommitted segments is also stored in the transaction log so that Elasticsearch is able to replay changes on the next start."},"compound":{"type":"boolean","description":"If `true`, Lucene merged all files from the segment into a single file to save file descriptors."},"deleted_docs":{"type":"number","description":"The number of deleted documents as reported by Lucene, which may be higher or lower than the number of delete operations you have performed.\nThis number excludes deletes that were performed recently and do not yet belong to a segment.\nDeleted documents are cleaned up by the automatic merge process if it makes sense to do so.\nAlso, Elasticsearch creates extra deleted documents to internally track the recent history of operations on a shard."},"generation":{"type":"number","description":"Generation number, such as `0`. Elasticsearch increments this generation number for each segment written then uses this number to derive the segment name."},"search":{"type":"boolean","description":"If `true`, the segment is searchable.\nIf `false`, the segment has most likely been written to disk but needs a refresh to be searchable."},"size_in_bytes":{"type":"number","description":"Disk space used by the segment, in bytes."},"num_docs":{"type":"number","description":"The number of documents as reported by Lucene.\nThis excludes deleted documents and counts any nested documents separately from their parents.\nIt also excludes documents which were indexed recently and do not yet belong to a segment."},"version":{"type":"string","description":"Version of Lucene used to write the segment."}},"required":["attributes","committed","compound","deleted_docs","generation","search","size_in_bytes","num_docs","version"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices.segments__IndexSegment":{"type":"object","properties":{"shards":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"./indices.segments.json#/$defs/indices.segments__ShardsSegment"},{"type":"array","items":{"$ref":"./indices.segments.json#/$defs/indices.segments__ShardsSegment"}}]}}},"required":["shards"]},"indices.segments__ShardsSegment":{"type":"object","properties":{"num_committed_segments":{"type":"number"},"routing":{"$ref":"./indices.segments.json#/$defs/indices.segments__ShardSegmentRouting"},"num_search_segments":{"type":"number"},"segments":{"type":"object","additionalProperties":{"$ref":"./indices.segments.json#/$defs/indices.segments__Segment"}}},"required":["num_committed_segments","routing","num_search_segments","segments"]},"indices.segments__ShardSegmentRouting":{"type":"object","properties":{"node":{"type":"string","description":"The node ID of the node that holds the shard."},"primary":{"type":"boolean","description":"If `true`, the shard is a primary shard."},"state":{"type":"string","description":"The state of the shard, such as `STARTED` or `RELOCATING`."}},"required":["node","primary","state"]},"indices.segments__Segment":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"},"description":"Contains information about whether high compression was enabled and per-field vector formats."},"committed":{"type":"boolean","description":"If `true`, the segment is synced to disk. Segments that are synced can survive a hard reboot.\nIf `false`, the data from uncommitted segments is also stored in the transaction log so that Elasticsearch is able to replay changes on the next start."},"compound":{"type":"boolean","description":"If `true`, Lucene merged all files from the segment into a single file to save file descriptors."},"deleted_docs":{"type":"number","description":"The number of deleted documents as reported by Lucene, which may be higher or lower than the number of delete operations you have performed.\nThis number excludes deletes that were performed recently and do not yet belong to a segment.\nDeleted documents are cleaned up by the automatic merge process if it makes sense to do so.\nAlso, Elasticsearch creates extra deleted documents to internally track the recent history of operations on a shard."},"generation":{"type":"number","description":"Generation number, such as `0`. Elasticsearch increments this generation number for each segment written then uses this number to derive the segment name."},"search":{"type":"boolean","description":"If `true`, the segment is searchable.\nIf `false`, the segment has most likely been written to disk but needs a refresh to be searchable."},"size_in_bytes":{"type":"number","description":"Disk space used by the segment, in bytes."},"num_docs":{"type":"number","description":"The number of documents as reported by Lucene.\nThis excludes deleted documents and counts any nested documents separately from their parents.\nIt also excludes documents which were indexed recently and do not yet belong to a segment."},"version":{"type":"string","description":"Version of Lucene used to write the segment."}},"required":["attributes","committed","compound","deleted_docs","generation","search","size_in_bytes","num_docs","version"]}}}

package/src/es/json/indices.shard_stores.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.shard_stores","type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard patterns can match. If the request can target data streams,\nthis argument determines whether wildcard expressions match hidden data streams.","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"},"status":{"oneOf":[{"$ref":"./indices.shard_stores.json#/$defs/indices.shard_stores__ShardStoreStatus"},{"type":"array","items":{"$ref":"./indices.shard_stores.json#/$defs/indices.shard_stores__ShardStoreStatus"}}],"description":"List of shard health statuses used to limit the request.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"List of data streams, indices, and aliases used to limit the request.","x-found-in":"path"}},"description":"Get index shard stores.\n\nGet store information about replica shards in one or more indices.\nFor data streams, the API retrieves store information for the stream's backing indices.\n\nThe index shard stores API returns the following information:\n\n* The node on which each replica shard exists.\n* The allocation ID for each replica shard.\n* A unique ID for each replica shard.\n* Any errors encountered while opening the shard index or from an earlier failure.\n\nBy default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.shard_stores","type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard patterns can match. If the request can target data streams,\nthis argument determines whether wildcard expressions match hidden data streams.","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"},"status":{"anyOf":[{"$ref":"./indices.shard_stores.json#/$defs/indices.shard_stores__ShardStoreStatus"},{"type":"array","items":{"$ref":"./indices.shard_stores.json#/$defs/indices.shard_stores__ShardStoreStatus"}}],"description":"List of shard health statuses used to limit the request.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"List of data streams, indices, and aliases used to limit the request.","x-found-in":"path"}},"description":"Get index shard stores.\n\nGet store information about replica shards in one or more indices.\nFor data streams, the API retrieves store information for the stream's backing indices.\n\nThe index shard stores API returns the following information:\n\n* The node on which each replica shard exists.\n* The allocation ID for each replica shard.\n* A unique ID for each replica shard.\n* Any errors encountered while opening the shard index or from an earlier failure.\n\nBy default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards."}

package/src/es/json/indices.shrink.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.shrink","type":"object","properties":{"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"},"description":"The key is the alias name.\nIndex alias names support date math.","x-found-in":"body"},"settings":{"type":"object","additionalProperties":{},"description":"Configuration options for the target index.","x-found-in":"body"},"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":{"type":"string","description":"Name of the source index to shrink.","x-found-in":"path"},"target":{"type":"string","description":"Name of the target index to create.","x-found-in":"path"}},"required":["index","target"],"description":"Shrink an index.\n\nShrink an index into a new index with fewer primary shards.\n\nBefore you can shrink an index:\n\n* The index must be read-only.\n* A copy of every shard in the index must reside on the same node.\n* The index must have a green health status.\n\nTo make shard allocation easier, we recommend you also remove the index's replica shards.\nYou can later re-add replica shards as part of the shrink operation.\n\nThe requested number of primary shards in the target index must be a factor of the number of shards in the source index.\nFor example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1.\nIf the number of shards in the index is a prime number it can only be shrunk into a single primary shard\n Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node.\n\nIMPORTANT: If the source index already has one primary shard, configuring the shrink operation with 'index.number_of_shards: 1' will cause the request to fail. An index with one primary shard cannot be shrunk further.\n\nThe current write index on a data stream cannot be shrunk. In order to shrink 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 shrunk.\n\nA shrink operation:\n\n* Creates a new target index with the same definition as the source index, but with a smaller number of primary shards.\n* Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks.\n* Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the `.routing.allocation.initial_recovery._id` index setting.\n\nIMPORTANT: Indices can only be shrunk if they satisfy the following requirements:\n\n* The target index must not exist.\n* The source index must have more primary shards than the target index.\n* The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index.\n* The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard.\n* The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.shrink","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":"The key is the alias name.\nIndex alias names support date math.","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 shrink.","x-found-in":"path"},"target":{"type":"string","description":"Name of the target index to create.","x-found-in":"path"}},"required":["index","target"],"description":"Shrink an index.\n\nShrink an index into a new index with fewer primary shards.\n\nBefore you can shrink an index:\n\n* The index must be read-only.\n* A copy of every shard in the index must reside on the same node.\n* The index must have a green health status.\n\nTo make shard allocation easier, we recommend you also remove the index's replica shards.\nYou can later re-add replica shards as part of the shrink operation.\n\nThe requested number of primary shards in the target index must be a factor of the number of shards in the source index.\nFor example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1.\nIf the number of shards in the index is a prime number it can only be shrunk into a single primary shard\n Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node.\n\nIMPORTANT: If the source index already has one primary shard, configuring the shrink operation with 'index.number_of_shards: 1' will cause the request to fail. An index with one primary shard cannot be shrunk further.\n\nThe current write index on a data stream cannot be shrunk. In order to shrink 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 shrunk.\n\nA shrink operation:\n\n* Creates a new target index with the same definition as the source index, but with a smaller number of primary shards.\n* Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks.\n* Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the `.routing.allocation.initial_recovery._id` index setting.\n\nIMPORTANT: Indices can only be shrunk if they satisfy the following requirements:\n\n* The target index must not exist.\n* The source index must have more primary shards than the target index.\n* The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index.\n* The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard.\n* The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index."}

package/src/es/json/indices.simulate_index_template.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.simulate_index_template","type":"object","properties":{"create":{"type":"boolean","description":"Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one","x-found-in":"query"},"cause":{"type":"string","description":"User defined reason for dry-run creating the new template for simulation purposes","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"},"include_defaults":{"type":"boolean","description":"If true, returns all relevant default configurations for the index template.","x-found-in":"query"},"name":{"type":"string","description":"Name of the index to simulate","x-found-in":"path"}},"required":["name"],"description":"Simulate an index.\n\nGet the index configuration that would be applied to the specified index from an existing index template."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.simulate_index_template","type":"object","properties":{"create":{"type":"boolean","description":"Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one","x-found-in":"query"},"cause":{"type":"string","description":"User defined reason for dry-run creating the new template for simulation purposes","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"},"include_defaults":{"type":"boolean","description":"If true, returns all relevant default configurations for the index template.","x-found-in":"query"},"index_template":{"$ref":"./indices._types.json#/$defs/indices._types__IndexTemplate","x-found-in":"body"},"name":{"type":"string","description":"Name of the index to simulate","x-found-in":"path"}},"required":["name"],"description":"Simulate an index.\n\nGet the index configuration that would be applied to the specified index from an existing index template."}

package/src/es/json/indices.simulate_template.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.simulate_template","type":"object","properties":{"allow_auto_create":{"type":"boolean","description":"This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.","x-found-in":"body"},"index_patterns":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.","x-found-in":"body"},"composed_of":{"type":"array","items":{"type":"string"},"description":"An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.","x-found-in":"body"},"template":{"$ref":"./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping","description":"Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.","x-found-in":"body"},"data_stream":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamVisibility","description":"If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.","x-found-in":"body"},"priority":{"type":"number","description":"Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.","x-found-in":"body"},"version":{"type":"number","description":"Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional user metadata about the index template.\nMay have any contents.\nThis map is not automatically generated by Elasticsearch.","x-found-in":"body"},"ignore_missing_component_templates":{"type":"array","items":{"type":"string"},"description":"The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist","x-found-in":"body"},"deprecated":{"type":"boolean","description":"Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.","x-found-in":"body"},"create":{"type":"boolean","description":"If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.","x-found-in":"query"},"cause":{"type":"string","description":"User defined reason for dry-run creating the new template for simulation purposes","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"},"include_defaults":{"type":"boolean","description":"If true, returns all relevant default configurations for the index template.","x-found-in":"query"},"name":{"type":"string","description":"Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit\nthis parameter and specify the template configuration in the request body.","x-found-in":"path"}},"description":"Simulate an index template.\n\nGet the index configuration that would be applied by a particular index template."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.simulate_template","type":"object","properties":{"create":{"type":"boolean","description":"If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.","x-found-in":"query"},"cause":{"type":"string","description":"User defined reason for dry-run creating the new template for simulation purposes","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"},"include_defaults":{"type":"boolean","description":"If true, returns all relevant default configurations for the index template.","x-found-in":"query"},"allow_auto_create":{"type":"boolean","description":"This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.","x-found-in":"body"},"index_patterns":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.","x-found-in":"body"},"composed_of":{"type":"array","items":{"type":"string"},"description":"An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.","x-found-in":"body"},"template":{"$ref":"./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping","description":"Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.","x-found-in":"body"},"data_stream":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamVisibility","description":"If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.","x-found-in":"body"},"priority":{"type":"number","description":"Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.","x-found-in":"body"},"version":{"type":"number","description":"Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional user metadata about the index template.\nMay have any contents.\nThis map is not automatically generated by Elasticsearch.","x-found-in":"body"},"ignore_missing_component_templates":{"type":"array","items":{"type":"string"},"description":"The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist","x-found-in":"body"},"deprecated":{"type":"boolean","description":"Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.","x-found-in":"body"},"name":{"type":"string","description":"Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit\nthis parameter and specify the template configuration in the request body.","x-found-in":"path"}},"description":"Simulate an index template.\n\nGet the index configuration that would be applied by a particular index template."}

package/src/es/json/indices.split.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.split","type":"object","properties":{"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"},"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":{"type":"string","description":"Name of the source index to split.","x-found-in":"path"},"target":{"type":"string","description":"Name of the target index to create.","x-found-in":"path"}},"required":["index","target"],"description":"Split an index.\n\nSplit an index into a new index with more primary shards.\n* Before you can split an index:\n\n* The index must be read-only.\n* The cluster health status must be green.\n\nYou can do make an index read-only with the following request using the add index block API:\n\n```\nPUT /my_source_index/_block/write\n```\n\nThe current write index on a data stream cannot be split.\nIn order to split 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 split.\n\nThe number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the `index.number_of_routing_shards` setting.\nThe number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing.\nFor instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3.\n\nA split operation:\n\n* Creates a new target index with the same definition as the source index, but with a larger number of primary shards.\n* Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Hashes all documents again, after low level files are created, to delete documents that belong to a different shard.\n* Recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be split if they satisfy the following requirements:\n\n* The target index must not exist.\n* The source index must have fewer primary shards than the target index.\n* The number of primary shards in the target index must be a multiple of the number of primary shards in the source index.\n* The number of primary shards in the target index must be a divisor of the source index's `index.number_of_routing_shards`.\n* The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.split","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 split.","x-found-in":"path"},"target":{"type":"string","description":"Name of the target index to create.","x-found-in":"path"}},"required":["index","target"],"description":"Split an index.\n\nSplit an index into a new index with more primary shards.\n* Before you can split an index:\n\n* The index must be read-only.\n* The cluster health status must be green.\n\nYou can do make an index read-only with the following request using the add index block API:\n\n```\nPUT /my_source_index/_block/write\n```\n\nThe current write index on a data stream cannot be split.\nIn order to split 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 split.\n\nThe number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the `index.number_of_routing_shards` setting.\nThe number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing.\nFor instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3.\n\nA split operation:\n\n* Creates a new target index with the same definition as the source index, but with a larger number of primary shards.\n* Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Hashes all documents again, after low level files are created, to delete documents that belong to a different shard.\n* Recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be split if they satisfy the following requirements:\n\n* The target index must not exist.\n* The source index must have fewer primary shards than the target index.\n* The number of primary shards in the target index must be a multiple of the number of primary shards in the source index.\n* The number of primary shards in the target index must be a divisor of the source index's `index.number_of_routing_shards`.\n* The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index."}

package/src/es/json/indices.stats.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices.stats__ShardFileSizeInfo":{"type":"object","properties":{"description":{"type":"string"},"size_in_bytes":{"type":"number"},"min_size_in_bytes":{"type":"number"},"max_size_in_bytes":{"type":"number"},"average_size_in_bytes":{"type":"number"},"count":{"type":"number"}},"required":["description","size_in_bytes"]},"indices.stats__IndicesStats":{"type":"object","properties":{"primaries":{"$ref":"./indices.stats.json#/$defs/indices.stats__IndexStats"},"shards":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardStats"}}},"total":{"$ref":"./indices.stats.json#/$defs/indices.stats__IndexStats"},"uuid":{"type":"string"},"health":{"$ref":"./_types.json#/$defs/_types__HealthStatus"},"status":{"$ref":"./indices.stats.json#/$defs/indices.stats__IndexMetadataState"}}},"indices.stats__IndexStats":{"type":"object","properties":{"completion":{"$ref":"./_types.json#/$defs/_types__CompletionStats","description":"Contains statistics about completions across all shards assigned to the node."},"docs":{"$ref":"./_types.json#/$defs/_types__DocStats","description":"Contains statistics about documents across all primary shards assigned to the node."},"fielddata":{"$ref":"./_types.json#/$defs/_types__FielddataStats","description":"Contains statistics about the field data cache across all shards assigned to the node."},"flush":{"$ref":"./_types.json#/$defs/_types__FlushStats","description":"Contains statistics about flush operations for the node."},"get":{"$ref":"./_types.json#/$defs/_types__GetStats","description":"Contains statistics about get operations for the node."},"indexing":{"$ref":"./_types.json#/$defs/_types__IndexingStats","description":"Contains statistics about indexing operations for the node."},"indices":{"$ref":"./indices.stats.json#/$defs/indices.stats__IndicesStats","description":"Contains statistics about indices operations for the node."},"merges":{"$ref":"./_types.json#/$defs/_types__MergesStats","description":"Contains statistics about merge operations for the node."},"query_cache":{"$ref":"./_types.json#/$defs/_types__QueryCacheStats","description":"Contains statistics about the query cache across all shards assigned to the node."},"recovery":{"$ref":"./_types.json#/$defs/_types__RecoveryStats","description":"Contains statistics about recovery operations for the node."},"refresh":{"$ref":"./_types.json#/$defs/_types__RefreshStats","description":"Contains statistics about refresh operations for the node."},"request_cache":{"$ref":"./_types.json#/$defs/_types__RequestCacheStats","description":"Contains statistics about the request cache across all shards assigned to the node."},"search":{"$ref":"./_types.json#/$defs/_types__SearchStats","description":"Contains statistics about search operations for the node."},"segments":{"$ref":"./_types.json#/$defs/_types__SegmentsStats","description":"Contains statistics about segments across all shards assigned to the node."},"store":{"$ref":"./_types.json#/$defs/_types__StoreStats","description":"Contains statistics about the size of shards assigned to the node."},"translog":{"$ref":"./_types.json#/$defs/_types__TranslogStats","description":"Contains statistics about transaction log operations for the node."},"warmer":{"$ref":"./_types.json#/$defs/_types__WarmerStats","description":"Contains statistics about index warming operations for the node."},"bulk":{"$ref":"./_types.json#/$defs/_types__BulkStats"},"shard_stats":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardsTotalStats"}}},"indices.stats__ShardsTotalStats":{"type":"object","properties":{"total_count":{"type":"number"}},"required":["total_count"]},"indices.stats__ShardStats":{"type":"object","properties":{"commit":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardCommit"},"completion":{"$ref":"./_types.json#/$defs/_types__CompletionStats"},"dense_vector":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__DenseVectorStats"},"docs":{"$ref":"./_types.json#/$defs/_types__DocStats"},"fielddata":{"$ref":"./_types.json#/$defs/_types__FielddataStats"},"flush":{"$ref":"./_types.json#/$defs/_types__FlushStats"},"get":{"$ref":"./_types.json#/$defs/_types__GetStats"},"indexing":{"$ref":"./_types.json#/$defs/_types__IndexingStats"},"mappings":{"$ref":"./indices.stats.json#/$defs/indices.stats__MappingStats"},"merges":{"$ref":"./_types.json#/$defs/_types__MergesStats"},"shard_path":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardPath"},"query_cache":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardQueryCache"},"recovery":{"$ref":"./_types.json#/$defs/_types__RecoveryStats"},"refresh":{"$ref":"./_types.json#/$defs/_types__RefreshStats"},"request_cache":{"$ref":"./_types.json#/$defs/_types__RequestCacheStats"},"retention_leases":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardRetentionLeases"},"routing":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardRouting"},"search":{"$ref":"./_types.json#/$defs/_types__SearchStats"},"segments":{"$ref":"./_types.json#/$defs/_types__SegmentsStats"},"seq_no":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardSequenceNumber"},"sparse_vector":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__SparseVectorStats"},"store":{"$ref":"./_types.json#/$defs/_types__StoreStats"},"translog":{"$ref":"./_types.json#/$defs/_types__TranslogStats"},"warmer":{"$ref":"./_types.json#/$defs/_types__WarmerStats"},"bulk":{"$ref":"./_types.json#/$defs/_types__BulkStats"},"shards":{"type":"object","additionalProperties":{}},"shard_stats":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardsTotalStats"},"indices":{"type":"object","additionalProperties":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardStats"}}}},"indices.stats__ShardCommit":{"type":"object","properties":{"generation":{"type":"number"},"id":{"type":"string"},"num_docs":{"type":"number"},"user_data":{"type":"object","additionalProperties":{"type":"string"}}},"required":["generation","id","num_docs","user_data"]},"indices.stats__MappingStats":{"type":"object","properties":{"total_count":{"type":"number"},"total_estimated_overhead":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total_estimated_overhead_in_bytes":{"type":"number"},"total_segments":{"type":"number"},"total_segment_fields":{"type":"number"},"average_fields_per_segment":{"type":"number"}},"required":["total_count","total_estimated_overhead_in_bytes","total_segments","total_segment_fields","average_fields_per_segment"]},"indices.stats__ShardPath":{"type":"object","properties":{"data_path":{"type":"string"},"is_custom_data_path":{"type":"boolean"},"state_path":{"type":"string"}},"required":["data_path","is_custom_data_path","state_path"]},"indices.stats__ShardQueryCache":{"type":"object","properties":{"cache_count":{"type":"number"},"cache_size":{"type":"number"},"evictions":{"type":"number"},"hit_count":{"type":"number"},"memory_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"memory_size_in_bytes":{"type":"number"},"miss_count":{"type":"number"},"total_count":{"type":"number"}},"required":["cache_count","cache_size","evictions","hit_count","memory_size_in_bytes","miss_count","total_count"]},"indices.stats__ShardRetentionLeases":{"type":"object","properties":{"primary_term":{"type":"number"},"version":{"type":"number"},"leases":{"type":"array","items":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardLease"}}},"required":["primary_term","version","leases"]},"indices.stats__ShardLease":{"type":"object","properties":{"id":{"type":"string"},"retaining_seq_no":{"type":"number"},"timestamp":{"type":"number"},"source":{"type":"string"}},"required":["id","retaining_seq_no","timestamp","source"]},"indices.stats__ShardRouting":{"type":"object","properties":{"node":{"type":"string"},"primary":{"type":"boolean"},"relocating_node":{"oneOf":[{"type":"string"},{"type":"null"}]},"state":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardRoutingState"}},"required":["node","primary","state"]},"indices.stats__ShardRoutingState":{"enum":["UNASSIGNED","INITIALIZING","STARTED","RELOCATING"]},"indices.stats__ShardSequenceNumber":{"type":"object","properties":{"global_checkpoint":{"type":"number"},"local_checkpoint":{"type":"number"},"max_seq_no":{"type":"number"}},"required":["global_checkpoint","local_checkpoint","max_seq_no"]},"indices.stats__IndexMetadataState":{"enum":["open","close"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices.stats__ShardFileSizeInfo":{"type":"object","properties":{"description":{"type":"string"},"size_in_bytes":{"type":"number"},"min_size_in_bytes":{"type":"number"},"max_size_in_bytes":{"type":"number"},"average_size_in_bytes":{"type":"number"},"count":{"type":"number"}},"required":["description","size_in_bytes"]},"indices.stats__IndicesStats":{"type":"object","properties":{"primaries":{"$ref":"./indices.stats.json#/$defs/indices.stats__IndexStats"},"shards":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardStats"}}},"total":{"$ref":"./indices.stats.json#/$defs/indices.stats__IndexStats"},"uuid":{"type":"string"},"health":{"$ref":"./_types.json#/$defs/_types__HealthStatus"},"status":{"$ref":"./indices.stats.json#/$defs/indices.stats__IndexMetadataState"}}},"indices.stats__IndexStats":{"type":"object","properties":{"completion":{"$ref":"./_types.json#/$defs/_types__CompletionStats","description":"Contains statistics about completions across all shards assigned to the node."},"docs":{"$ref":"./_types.json#/$defs/_types__DocStats","description":"Contains statistics about documents across all primary shards assigned to the node."},"fielddata":{"$ref":"./_types.json#/$defs/_types__FielddataStats","description":"Contains statistics about the field data cache across all shards assigned to the node."},"flush":{"$ref":"./_types.json#/$defs/_types__FlushStats","description":"Contains statistics about flush operations for the node."},"get":{"$ref":"./_types.json#/$defs/_types__GetStats","description":"Contains statistics about get operations for the node."},"indexing":{"$ref":"./_types.json#/$defs/_types__IndexingStats","description":"Contains statistics about indexing operations for the node."},"indices":{"$ref":"./indices.stats.json#/$defs/indices.stats__IndicesStats","description":"Contains statistics about indices operations for the node."},"merges":{"$ref":"./_types.json#/$defs/_types__MergesStats","description":"Contains statistics about merge operations for the node."},"query_cache":{"$ref":"./_types.json#/$defs/_types__QueryCacheStats","description":"Contains statistics about the query cache across all shards assigned to the node."},"recovery":{"$ref":"./_types.json#/$defs/_types__RecoveryStats","description":"Contains statistics about recovery operations for the node."},"refresh":{"$ref":"./_types.json#/$defs/_types__RefreshStats","description":"Contains statistics about refresh operations for the node."},"request_cache":{"$ref":"./_types.json#/$defs/_types__RequestCacheStats","description":"Contains statistics about the request cache across all shards assigned to the node."},"search":{"$ref":"./_types.json#/$defs/_types__SearchStats","description":"Contains statistics about search operations for the node."},"segments":{"$ref":"./_types.json#/$defs/_types__SegmentsStats","description":"Contains statistics about segments across all shards assigned to the node."},"store":{"$ref":"./_types.json#/$defs/_types__StoreStats","description":"Contains statistics about the size of shards assigned to the node."},"translog":{"$ref":"./_types.json#/$defs/_types__TranslogStats","description":"Contains statistics about transaction log operations for the node."},"warmer":{"$ref":"./_types.json#/$defs/_types__WarmerStats","description":"Contains statistics about index warming operations for the node."},"bulk":{"$ref":"./_types.json#/$defs/_types__BulkStats"},"shard_stats":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardsTotalStats"}}},"indices.stats__ShardsTotalStats":{"type":"object","properties":{"total_count":{"type":"number"}},"required":["total_count"]},"indices.stats__ShardStats":{"type":"object","properties":{"commit":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardCommit"},"completion":{"$ref":"./_types.json#/$defs/_types__CompletionStats"},"dense_vector":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__DenseVectorStats"},"docs":{"$ref":"./_types.json#/$defs/_types__DocStats"},"fielddata":{"$ref":"./_types.json#/$defs/_types__FielddataStats"},"flush":{"$ref":"./_types.json#/$defs/_types__FlushStats"},"get":{"$ref":"./_types.json#/$defs/_types__GetStats"},"indexing":{"$ref":"./_types.json#/$defs/_types__IndexingStats"},"mappings":{"$ref":"./indices.stats.json#/$defs/indices.stats__MappingStats"},"merges":{"$ref":"./_types.json#/$defs/_types__MergesStats"},"shard_path":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardPath"},"query_cache":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardQueryCache"},"recovery":{"$ref":"./_types.json#/$defs/_types__RecoveryStats"},"refresh":{"$ref":"./_types.json#/$defs/_types__RefreshStats"},"request_cache":{"$ref":"./_types.json#/$defs/_types__RequestCacheStats"},"retention_leases":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardRetentionLeases"},"routing":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardRouting"},"search":{"$ref":"./_types.json#/$defs/_types__SearchStats"},"segments":{"$ref":"./_types.json#/$defs/_types__SegmentsStats"},"seq_no":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardSequenceNumber"},"sparse_vector":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__SparseVectorStats"},"store":{"$ref":"./_types.json#/$defs/_types__StoreStats"},"translog":{"$ref":"./_types.json#/$defs/_types__TranslogStats"},"warmer":{"$ref":"./_types.json#/$defs/_types__WarmerStats"},"bulk":{"$ref":"./_types.json#/$defs/_types__BulkStats"},"shards":{"type":"object","additionalProperties":{}},"shard_stats":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardsTotalStats"},"indices":{"type":"object","additionalProperties":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardStats"}}}},"indices.stats__ShardCommit":{"type":"object","properties":{"generation":{"type":"number"},"id":{"type":"string"},"num_docs":{"type":"number"},"user_data":{"type":"object","additionalProperties":{"type":"string"}}},"required":["generation","id","num_docs","user_data"]},"indices.stats__MappingStats":{"type":"object","properties":{"total_count":{"type":"number"},"total_estimated_overhead":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total_estimated_overhead_in_bytes":{"type":"number"},"total_segments":{"type":"number"},"total_segment_fields":{"type":"number"},"average_fields_per_segment":{"type":"number"}},"required":["total_count","total_estimated_overhead_in_bytes","total_segments","total_segment_fields","average_fields_per_segment"]},"indices.stats__ShardPath":{"type":"object","properties":{"data_path":{"type":"string"},"is_custom_data_path":{"type":"boolean"},"state_path":{"type":"string"}},"required":["data_path","is_custom_data_path","state_path"]},"indices.stats__ShardQueryCache":{"type":"object","properties":{"cache_count":{"type":"number"},"cache_size":{"type":"number"},"evictions":{"type":"number"},"hit_count":{"type":"number"},"memory_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"memory_size_in_bytes":{"type":"number"},"miss_count":{"type":"number"},"total_count":{"type":"number"}},"required":["cache_count","cache_size","evictions","hit_count","memory_size_in_bytes","miss_count","total_count"]},"indices.stats__ShardRetentionLeases":{"type":"object","properties":{"primary_term":{"type":"number"},"version":{"type":"number"},"leases":{"type":"array","items":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardLease"}}},"required":["primary_term","version","leases"]},"indices.stats__ShardLease":{"type":"object","properties":{"id":{"type":"string"},"retaining_seq_no":{"type":"number"},"timestamp":{"type":"number"},"source":{"type":"string"}},"required":["id","retaining_seq_no","timestamp","source"]},"indices.stats__ShardRouting":{"type":"object","properties":{"node":{"type":"string"},"primary":{"type":"boolean"},"relocating_node":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"$ref":"./indices.stats.json#/$defs/indices.stats__ShardRoutingState"}},"required":["node","primary","state"]},"indices.stats__ShardRoutingState":{"enum":["UNASSIGNED","INITIALIZING","STARTED","RELOCATING"]},"indices.stats__ShardSequenceNumber":{"type":"object","properties":{"global_checkpoint":{"type":"number"},"local_checkpoint":{"type":"number"},"max_seq_no":{"type":"number"}},"required":["global_checkpoint","local_checkpoint","max_seq_no"]},"indices.stats__IndexMetadataState":{"enum":["open","close"]}}}

package/src/es/json/indices.stats.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.stats","type":"object","properties":{"completion_fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard patterns can match. If the request can target data streams, this argument\ndetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,\nsuch as `open,hidden`.","x-found-in":"query"},"fielddata_fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"Comma-separated list or wildcard expressions of fields to include in fielddata statistics.","x-found-in":"query"},"fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"Comma-separated list or wildcard expressions of fields to include in the statistics.","x-found-in":"query"},"forbid_closed_indices":{"type":"boolean","description":"If true, statistics are not collected from closed indices.","x-found-in":"query"},"groups":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of search groups to include in the search statistics.","x-found-in":"query"},"include_segment_file_sizes":{"type":"boolean","description":"If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).","x-found-in":"query"},"include_unloaded_segments":{"type":"boolean","description":"If true, the response includes information from segments that are not loaded into memory.","x-found-in":"query"},"level":{"$ref":"./_types.json#/$defs/_types__Level","description":"Indicates whether statistics are aggregated at the cluster, indices, or shards level.","x-found-in":"query"},"metric":{"$ref":"./_types.json#/$defs/_types__CommonStatsFlags","description":"Comma-separated list of metrics used to limit the request.","x-found-in":"path"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices","x-found-in":"path"}},"description":"Get index statistics.\n\nFor data streams, the API retrieves statistics for the stream's backing indices.\n\nBy default, the returned statistics are index-level with `primaries` and `total` aggregations.\n`primaries` are the values for only the primary shards.\n`total` are the accumulated values for both primary and replica shards.\n\nTo get shard-level statistics, set the `level` parameter to `shards`.\n\nNOTE: When moving to another node, the shard-level statistics for a shard are cleared.\nAlthough the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.stats","type":"object","properties":{"completion_fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard patterns can match. If the request can target data streams, this argument\ndetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,\nsuch as `open,hidden`.","x-found-in":"query"},"fielddata_fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"Comma-separated list or wildcard expressions of fields to include in fielddata statistics.","x-found-in":"query"},"fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"Comma-separated list or wildcard expressions of fields to include in the statistics.","x-found-in":"query"},"forbid_closed_indices":{"type":"boolean","description":"If true, statistics are not collected from closed indices.","x-found-in":"query"},"groups":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of search groups to include in the search statistics.","x-found-in":"query"},"include_segment_file_sizes":{"type":"boolean","description":"If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).","x-found-in":"query"},"include_unloaded_segments":{"type":"boolean","description":"If true, the response includes information from segments that are not loaded into memory.","x-found-in":"query"},"level":{"$ref":"./_types.json#/$defs/_types__Level","description":"Indicates whether statistics are aggregated at the cluster, indices, or shards level.","x-found-in":"query"},"metric":{"$ref":"./_types.json#/$defs/_types__CommonStatsFlags","description":"Comma-separated list of metrics used to limit the request.","x-found-in":"path"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices","x-found-in":"path"}},"description":"Get index statistics.\n\nFor data streams, the API retrieves statistics for the stream's backing indices.\n\nBy default, the returned statistics are index-level with `primaries` and `total` aggregations.\n`primaries` are the values for only the primary shards.\n`total` are the accumulated values for both primary and replica shards.\n\nTo get shard-level statistics, set the `level` parameter to `shards`.\n\nNOTE: When moving to another node, the shard-level statistics for a shard are cleared.\nAlthough the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed."}

package/src/es/json/indices.update_aliases.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices.update_aliases__Action":{"type":"object","properties":{"add":{"$ref":"./indices.update_aliases.json#/$defs/indices.update_aliases__AddAction","description":"Adds a data stream or index to an alias.\nIf the alias doesn’t exist, the `add` action creates it."},"remove":{"$ref":"./indices.update_aliases.json#/$defs/indices.update_aliases__RemoveAction","description":"Removes a data stream or index from an alias."},"remove_index":{"$ref":"./indices.update_aliases.json#/$defs/indices.update_aliases__RemoveIndexAction","description":"Deletes an index.\nYou cannot use this action on aliases or data streams."}}},"indices.update_aliases__AddAction":{"type":"object","properties":{"alias":{"type":"string","description":"Alias for the action.\nIndex alias names support date math."},"aliases":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Aliases for the action.\nIndex alias names support date math."},"filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Query used to limit documents the alias can access."},"index":{"type":"string","description":"Data stream or index for the action.\nSupports wildcards (`*`)."},"indices":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Data streams or indices for the action.\nSupports wildcards (`*`)."},"index_routing":{"type":"string","description":"Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.\nData stream aliases don’t support this parameter."},"is_hidden":{"type":"boolean","description":"If `true`, the alias is hidden."},"is_write_index":{"type":"boolean","description":"If `true`, sets the write index or data stream for the alias."},"routing":{"type":"string","description":"Value used to route indexing and search operations to a specific shard.\nData stream aliases don’t support this parameter."},"search_routing":{"type":"string","description":"Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.\nData stream aliases don’t support this parameter."},"must_exist":{"type":"boolean","description":"If `true`, the alias must exist to perform the action."}}},"indices.update_aliases__RemoveAction":{"type":"object","properties":{"alias":{"type":"string","description":"Alias for the action.\nIndex alias names support date math."},"aliases":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Aliases for the action.\nIndex alias names support date math."},"index":{"type":"string","description":"Data stream or index for the action.\nSupports wildcards (`*`)."},"indices":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Data streams or indices for the action.\nSupports wildcards (`*`)."},"must_exist":{"type":"boolean","description":"If `true`, the alias must exist to perform the action."}}},"indices.update_aliases__RemoveIndexAction":{"type":"object","properties":{"index":{"type":"string","description":"Data stream or index for the action.\nSupports wildcards (`*`)."},"indices":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Data streams or indices for the action.\nSupports wildcards (`*`)."},"must_exist":{"type":"boolean","description":"If `true`, the alias must exist to perform the action."}}}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices.update_aliases__Action":{"type":"object","properties":{"add":{"$ref":"./indices.update_aliases.json#/$defs/indices.update_aliases__AddAction","description":"Adds a data stream or index to an alias.\nIf the alias doesn’t exist, the `add` action creates it."},"remove":{"$ref":"./indices.update_aliases.json#/$defs/indices.update_aliases__RemoveAction","description":"Removes a data stream or index from an alias."},"remove_index":{"$ref":"./indices.update_aliases.json#/$defs/indices.update_aliases__RemoveIndexAction","description":"Deletes an index.\nYou cannot use this action on aliases or data streams."}}},"indices.update_aliases__AddAction":{"type":"object","properties":{"alias":{"type":"string","description":"Alias for the action.\nIndex alias names support date math."},"aliases":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Aliases for the action.\nIndex alias names support date math."},"filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Query used to limit documents the alias can access."},"index":{"type":"string","description":"Data stream or index for the action.\nSupports wildcards (`*`)."},"indices":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Data streams or indices for the action.\nSupports wildcards (`*`)."},"index_routing":{"type":"string","description":"Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.\nData stream aliases don’t support this parameter."},"is_hidden":{"type":"boolean","description":"If `true`, the alias is hidden."},"is_write_index":{"type":"boolean","description":"If `true`, sets the write index or data stream for the alias."},"routing":{"type":"string","description":"Value used to route indexing and search operations to a specific shard.\nData stream aliases don’t support this parameter."},"search_routing":{"type":"string","description":"Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.\nData stream aliases don’t support this parameter."},"must_exist":{"type":"boolean","description":"If `true`, the alias must exist to perform the action."}}},"indices.update_aliases__RemoveAction":{"type":"object","properties":{"alias":{"type":"string","description":"Alias for the action.\nIndex alias names support date math."},"aliases":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Aliases for the action.\nIndex alias names support date math."},"index":{"type":"string","description":"Data stream or index for the action.\nSupports wildcards (`*`)."},"indices":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Data streams or indices for the action.\nSupports wildcards (`*`)."},"must_exist":{"type":"boolean","description":"If `true`, the alias must exist to perform the action."}}},"indices.update_aliases__RemoveIndexAction":{"type":"object","properties":{"index":{"type":"string","description":"Data stream or index for the action.\nSupports wildcards (`*`)."},"indices":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Data streams or indices for the action.\nSupports wildcards (`*`)."},"must_exist":{"type":"boolean","description":"If `true`, the alias must exist to perform the action."}}}}}

package/src/es/json/indices.update_aliases.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.update_aliases","type":"object","properties":{"actions":{"type":"array","items":{"$ref":"./indices.update_aliases.json#/$defs/indices.update_aliases__Action"},"description":"Actions to perform.","x-found-in":"body"},"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"}},"description":"Create or update an alias.\n\nAdds a data stream or index to an alias."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.update_aliases","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"},"actions":{"type":"array","items":{"$ref":"./indices.update_aliases.json#/$defs/indices.update_aliases__Action"},"description":"Actions to perform.","x-found-in":"body"}},"description":"Create or update an alias.\n\nAdds a data stream or index to an alias."}

package/src/es/json/indices.validate_query.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.validate_query","type":"object","properties":{"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Query in the Lucene query string syntax.","x-found-in":"body"},"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"all_shards":{"type":"boolean","description":"If `true`, the validation is executed on all shards instead of one random shard per index.","x-found-in":"query"},"analyzer":{"type":"string","description":"Analyzer to use for the query string.\nThis parameter can only be used when the `q` query string parameter is specified.","x-found-in":"query"},"analyze_wildcard":{"type":"boolean","description":"If `true`, wildcard and prefix queries are analyzed.","x-found-in":"query"},"default_operator":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__Operator","description":"The default operator for query string query: `and` or `or`.","x-found-in":"query"},"df":{"type":"string","description":"Field to use as default where no field prefix is given in the query string.\nThis parameter can only be used when the `q` query string parameter is specified.","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"},"explain":{"type":"boolean","description":"If `true`, the response returns detailed information if an error has occurred.","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","description":"If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.","x-found-in":"query"},"rewrite":{"type":"boolean","description":"If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed.","x-found-in":"query"},"q":{"type":"string","description":"Query in the Lucene query string syntax.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}},"description":"Validate a query.\n\nValidates a query without running it."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.validate_query","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"},"all_shards":{"type":"boolean","description":"If `true`, the validation is executed on all shards instead of one random shard per index.","x-found-in":"query"},"analyzer":{"type":"string","description":"Analyzer to use for the query string.\nThis parameter can only be used when the `q` query string parameter is specified.","x-found-in":"query"},"analyze_wildcard":{"type":"boolean","description":"If `true`, wildcard and prefix queries are analyzed.","x-found-in":"query"},"default_operator":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__Operator","description":"The default operator for query string query: `and` or `or`.","x-found-in":"query"},"df":{"type":"string","description":"Field to use as default where no field prefix is given in the query string.\nThis parameter can only be used when the `q` query string parameter is specified.","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"},"explain":{"type":"boolean","description":"If `true`, the response returns detailed information if an error has occurred.","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","description":"If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.","x-found-in":"query"},"rewrite":{"type":"boolean","description":"If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed.","x-found-in":"query"},"q":{"type":"string","description":"Query in the Lucene query string syntax.","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"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Query in the Lucene query string syntax.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}},"description":"Validate a query.\n\nValidates a query without running it."}