@elastic/schemas 0.4.3 → 0.4.5

package/src/es/json/cat.ml_trained_models.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.ml_trained_models","type":"object","properties":{"model_id":{"type":"string","description":"A unique identifier for the trained model.","x-found-in":"path"},"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.\nIf `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the API returns a 404 status code when there are no matches or only partial matches.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatTrainedModelsColumns","description":"A comma-separated list of column names to display.","x-found-in":"query"},"s":{"$ref":"./cat._types.json#/$defs/cat._types__CatTrainedModelsColumns","description":"A comma-separated list of column names or aliases used to sort the response.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of transforms.","x-found-in":"query"},"size":{"type":"number","description":"The maximum number of transforms to display.","x-found-in":"query"}},"description":"Get trained models.\n\nGet configuration and usage information about inference trained models.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.ml_trained_models","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.\nIf `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the API returns a 404 status code when there are no matches or only partial matches.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatTrainedModelsColumns","description":"A comma-separated list of column names to display.","x-found-in":"query"},"s":{"$ref":"./cat._types.json#/$defs/cat._types__CatTrainedModelsColumns","description":"A comma-separated list of column names or aliases used to sort the response.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of transforms.","x-found-in":"query"},"size":{"type":"number","description":"The maximum number of transforms to display.","x-found-in":"query"},"model_id":{"type":"string","description":"A unique identifier for the trained model.","x-found-in":"path"}},"description":"Get trained models.\n\nGet configuration and usage information about inference trained models.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API."}

package/src/es/json/cat.recovery.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.recovery","type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Comma-separated list or wildcard expression of index names to limit the returned information","x-found-in":"query"},"active_only":{"type":"boolean","description":"If `true`, the response only includes ongoing shard recoveries.","x-found-in":"query"},"detailed":{"type":"boolean","description":"If `true`, the response includes detailed information about shard recoveries.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatRecoveryColumns","description":"A comma-separated list of columns names to display.\nIt supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"}},"description":"Get shard recovery information.\n\nGet information about ongoing and completed shard recoveries.\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.recovery","type":"object","properties":{"active_only":{"type":"boolean","description":"If `true`, the response only includes ongoing shard recoveries.","x-found-in":"query"},"detailed":{"type":"boolean","description":"If `true`, the response includes detailed information about shard recoveries.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatRecoveryColumns","description":"A comma-separated list of columns names to display.\nIt supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"}},"description":"Get shard recovery information.\n\nGet information about ongoing and completed shard recoveries.\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API."}

package/src/es/json/cat.segments.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.segments","type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A 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"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatSegmentsColumns","description":"A comma-separated list of columns names to display.\nIt supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","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\ndetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,\nsuch as open,hidden.","x-found-in":"query"},"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"ignore_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"},"allow_closed":{"type":"boolean","description":"If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour\nof throwing an exception if index pattern matches closed indices","x-found-in":"query"}},"description":"Get segment information.\n\nGet low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.segments","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatSegmentsColumns","description":"A comma-separated list of columns names to display.\nIt supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","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\ndetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,\nsuch as open,hidden.","x-found-in":"query"},"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"ignore_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"},"allow_closed":{"type":"boolean","description":"If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour\nof throwing an exception if index pattern matches closed indices","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A 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"}},"description":"Get segment information.\n\nGet low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API."}

package/src/es/json/cat.shards.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat.shards__ShardsRecord":{"type":"object","properties":{"index":{"type":"string","description":"The index name."},"shard":{"type":"string","description":"The shard name."},"prirep":{"type":"string","description":"The shard type: `primary` or `replica`."},"state":{"type":"string","description":"The shard state.\nReturned values include:\n`INITIALIZING`: The shard is recovering from a peer shard or gateway.\n`RELOCATING`: The shard is relocating.\n`STARTED`: The shard has started.\n`UNASSIGNED`: The shard is not assigned to any node."},"docs":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"The number of documents in the shard."},"store":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"The disk space used by the shard."},"dataset":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"total size of dataset (including the cache for partially mounted indices)"},"ip":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"The IP address of the node."},"id":{"type":"string","description":"The unique identifier for the node."},"node":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"The name of node."},"sync_id":{"type":"string","description":"The sync identifier."},"unassigned.reason":{"type":"string","description":"The reason for the last change to the state of an unassigned shard.\nIt does not explain why the shard is currently unassigned; use the cluster allocation explain API for that information.\nReturned values include:\n`ALLOCATION_FAILED`: Unassigned as a result of a failed allocation of the shard.\n`CLUSTER_RECOVERED`: Unassigned as a result of a full cluster recovery.\n`DANGLING_INDEX_IMPORTED`: Unassigned as a result of importing a dangling index.\n`EXISTING_INDEX_RESTORED`: Unassigned as a result of restoring into a closed index.\n`FORCED_EMPTY_PRIMARY`: The shard’s allocation was last modified by forcing an empty primary using the cluster reroute API.\n`INDEX_CLOSED`: Unassigned because the index was closed.\n`INDEX_CREATED`: Unassigned as a result of an API creation of an index.\n`INDEX_REOPENED`: Unassigned as a result of opening a closed index.\n`MANUAL_ALLOCATION`: The shard’s allocation was last modified by the cluster reroute API.\n`NEW_INDEX_RESTORED`: Unassigned as a result of restoring into a new index.\n`NODE_LEFT`: Unassigned as a result of the node hosting it leaving the cluster.\n`NODE_RESTARTING`: Similar to `NODE_LEFT`, except that the node was registered as restarting using the node shutdown API.\n`PRIMARY_FAILED`: The shard was initializing as a replica, but the primary shard failed before the initialization completed.\n`REALLOCATED_REPLICA`: A better replica location is identified and causes the existing replica allocation to be cancelled.\n`REINITIALIZED`: When a shard moves from started back to initializing.\n`REPLICA_ADDED`: Unassigned as a result of explicit addition of a replica.\n`REROUTE_CANCELLED`: Unassigned as a result of explicit cancel reroute command."},"unassigned.at":{"type":"string","description":"The time at which the shard became unassigned in Coordinated Universal Time (UTC)."},"unassigned.for":{"type":"string","description":"The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC)."},"unassigned.details":{"type":"string","description":"Additional details as to why the shard became unassigned.\nIt does not explain why the shard is not assigned; use the cluster allocation explain API for that information."},"recoverysource.type":{"type":"string","description":"The type of recovery source."},"completion.size":{"type":"string","description":"The size of completion."},"fielddata.memory_size":{"type":"string","description":"The used fielddata cache memory."},"fielddata.evictions":{"type":"string","description":"The fielddata cache evictions."},"query_cache.memory_size":{"type":"string","description":"The used query cache memory."},"query_cache.evictions":{"type":"string","description":"The query cache evictions."},"flush.total":{"type":"string","description":"The number of flushes."},"flush.total_time":{"type":"string","description":"The time spent in flush."},"get.current":{"type":"string","description":"The number of current get operations."},"get.time":{"type":"string","description":"The time spent in get operations."},"get.total":{"type":"string","description":"The number of get operations."},"get.exists_time":{"type":"string","description":"The time spent in successful get operations."},"get.exists_total":{"type":"string","description":"The number of successful get operations."},"get.missing_time":{"type":"string","description":"The time spent in failed get operations."},"get.missing_total":{"type":"string","description":"The number of failed get operations."},"indexing.delete_current":{"type":"string","description":"The number of current deletion operations."},"indexing.delete_time":{"type":"string","description":"The time spent in deletion operations."},"indexing.delete_total":{"type":"string","description":"The number of delete operations."},"indexing.index_current":{"type":"string","description":"The number of current indexing operations."},"indexing.index_time":{"type":"string","description":"The time spent in indexing operations."},"indexing.index_total":{"type":"string","description":"The number of indexing operations."},"indexing.index_failed":{"type":"string","description":"The number of failed indexing operations."},"merges.current":{"type":"string","description":"The number of current merge operations."},"merges.current_docs":{"type":"string","description":"The number of current merging documents."},"merges.current_size":{"type":"string","description":"The size of current merge operations."},"merges.total":{"type":"string","description":"The number of completed merge operations."},"merges.total_docs":{"type":"string","description":"The nuber of merged documents."},"merges.total_size":{"type":"string","description":"The size of current merges."},"merges.total_time":{"type":"string","description":"The time spent merging documents."},"refresh.total":{"type":"string","description":"The total number of refreshes."},"refresh.time":{"type":"string","description":"The time spent in refreshes."},"refresh.external_total":{"type":"string","description":"The total nunber of external refreshes."},"refresh.external_time":{"type":"string","description":"The time spent in external refreshes."},"refresh.listeners":{"type":"string","description":"The number of pending refresh listeners."},"search.fetch_current":{"type":"string","description":"The current fetch phase operations."},"search.fetch_time":{"type":"string","description":"The time spent in fetch phase."},"search.fetch_total":{"type":"string","description":"The total number of fetch operations."},"search.open_contexts":{"type":"string","description":"The number of open search contexts."},"search.query_current":{"type":"string","description":"The current query phase operations."},"search.query_time":{"type":"string","description":"The time spent in query phase."},"search.query_total":{"type":"string","description":"The total number of query phase operations."},"search.scroll_current":{"type":"string","description":"The open scroll contexts."},"search.scroll_time":{"type":"string","description":"The time scroll contexts were held open."},"search.scroll_total":{"type":"string","description":"The number of completed scroll contexts."},"segments.count":{"type":"string","description":"The number of segments."},"segments.memory":{"type":"string","description":"The memory used by segments."},"segments.index_writer_memory":{"type":"string","description":"The memory used by the index writer."},"segments.version_map_memory":{"type":"string","description":"The memory used by the version map."},"segments.fixed_bitset_memory":{"type":"string","description":"The memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields."},"seq_no.max":{"type":"string","description":"The maximum sequence number."},"seq_no.local_checkpoint":{"type":"string","description":"The local checkpoint."},"seq_no.global_checkpoint":{"type":"string","description":"The global checkpoint."},"warmer.current":{"type":"string","description":"The number of current warmer operations."},"warmer.total":{"type":"string","description":"The total number of warmer operations."},"warmer.total_time":{"type":"string","description":"The time spent in warmer operations."},"path.data":{"type":"string","description":"The shard data path."},"path.state":{"type":"string","description":"The shard state path."},"bulk.total_operations":{"type":"string","description":"The number of bulk shard operations."},"bulk.total_time":{"type":"string","description":"The time spent in shard bulk operations."},"bulk.total_size_in_bytes":{"type":"string","description":"The total size in bytes of shard bulk operations."},"bulk.avg_time":{"type":"string","description":"The average time spent in shard bulk operations."},"bulk.avg_size_in_bytes":{"type":"string","description":"The average size in bytes of shard bulk operations."}}}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat.shards__ShardsRecord":{"type":"object","properties":{"index":{"type":"string","description":"The index name."},"shard":{"type":"string","description":"The shard name."},"prirep":{"type":"string","description":"The shard type: `primary` or `replica`."},"state":{"type":"string","description":"The shard state.\nReturned values include:\n`INITIALIZING`: The shard is recovering from a peer shard or gateway.\n`RELOCATING`: The shard is relocating.\n`STARTED`: The shard has started.\n`UNASSIGNED`: The shard is not assigned to any node."},"docs":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of documents in the shard."},"store":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The disk space used by the shard."},"dataset":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"total size of dataset (including the cache for partially mounted indices)"},"ip":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IP address of the node."},"id":{"type":"string","description":"The unique identifier for the node."},"node":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of node."},"sync_id":{"type":"string","description":"The sync identifier."},"unassigned.reason":{"type":"string","description":"The reason for the last change to the state of an unassigned shard.\nIt does not explain why the shard is currently unassigned; use the cluster allocation explain API for that information.\nReturned values include:\n`ALLOCATION_FAILED`: Unassigned as a result of a failed allocation of the shard.\n`CLUSTER_RECOVERED`: Unassigned as a result of a full cluster recovery.\n`DANGLING_INDEX_IMPORTED`: Unassigned as a result of importing a dangling index.\n`EXISTING_INDEX_RESTORED`: Unassigned as a result of restoring into a closed index.\n`FORCED_EMPTY_PRIMARY`: The shard’s allocation was last modified by forcing an empty primary using the cluster reroute API.\n`INDEX_CLOSED`: Unassigned because the index was closed.\n`INDEX_CREATED`: Unassigned as a result of an API creation of an index.\n`INDEX_REOPENED`: Unassigned as a result of opening a closed index.\n`MANUAL_ALLOCATION`: The shard’s allocation was last modified by the cluster reroute API.\n`NEW_INDEX_RESTORED`: Unassigned as a result of restoring into a new index.\n`NODE_LEFT`: Unassigned as a result of the node hosting it leaving the cluster.\n`NODE_RESTARTING`: Similar to `NODE_LEFT`, except that the node was registered as restarting using the node shutdown API.\n`PRIMARY_FAILED`: The shard was initializing as a replica, but the primary shard failed before the initialization completed.\n`REALLOCATED_REPLICA`: A better replica location is identified and causes the existing replica allocation to be cancelled.\n`REINITIALIZED`: When a shard moves from started back to initializing.\n`REPLICA_ADDED`: Unassigned as a result of explicit addition of a replica.\n`REROUTE_CANCELLED`: Unassigned as a result of explicit cancel reroute command."},"unassigned.at":{"type":"string","description":"The time at which the shard became unassigned in Coordinated Universal Time (UTC)."},"unassigned.for":{"type":"string","description":"The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC)."},"unassigned.details":{"type":"string","description":"Additional details as to why the shard became unassigned.\nIt does not explain why the shard is not assigned; use the cluster allocation explain API for that information."},"recoverysource.type":{"type":"string","description":"The type of recovery source."},"completion.size":{"type":"string","description":"The size of completion."},"fielddata.memory_size":{"type":"string","description":"The used fielddata cache memory."},"fielddata.evictions":{"type":"string","description":"The fielddata cache evictions."},"query_cache.memory_size":{"type":"string","description":"The used query cache memory."},"query_cache.evictions":{"type":"string","description":"The query cache evictions."},"flush.total":{"type":"string","description":"The number of flushes."},"flush.total_time":{"type":"string","description":"The time spent in flush."},"get.current":{"type":"string","description":"The number of current get operations."},"get.time":{"type":"string","description":"The time spent in get operations."},"get.total":{"type":"string","description":"The number of get operations."},"get.exists_time":{"type":"string","description":"The time spent in successful get operations."},"get.exists_total":{"type":"string","description":"The number of successful get operations."},"get.missing_time":{"type":"string","description":"The time spent in failed get operations."},"get.missing_total":{"type":"string","description":"The number of failed get operations."},"indexing.delete_current":{"type":"string","description":"The number of current deletion operations."},"indexing.delete_time":{"type":"string","description":"The time spent in deletion operations."},"indexing.delete_total":{"type":"string","description":"The number of delete operations."},"indexing.index_current":{"type":"string","description":"The number of current indexing operations."},"indexing.index_time":{"type":"string","description":"The time spent in indexing operations."},"indexing.index_total":{"type":"string","description":"The number of indexing operations."},"indexing.index_failed":{"type":"string","description":"The number of failed indexing operations."},"merges.current":{"type":"string","description":"The number of current merge operations."},"merges.current_docs":{"type":"string","description":"The number of current merging documents."},"merges.current_size":{"type":"string","description":"The size of current merge operations."},"merges.total":{"type":"string","description":"The number of completed merge operations."},"merges.total_docs":{"type":"string","description":"The nuber of merged documents."},"merges.total_size":{"type":"string","description":"The size of current merges."},"merges.total_time":{"type":"string","description":"The time spent merging documents."},"refresh.total":{"type":"string","description":"The total number of refreshes."},"refresh.time":{"type":"string","description":"The time spent in refreshes."},"refresh.external_total":{"type":"string","description":"The total nunber of external refreshes."},"refresh.external_time":{"type":"string","description":"The time spent in external refreshes."},"refresh.listeners":{"type":"string","description":"The number of pending refresh listeners."},"search.fetch_current":{"type":"string","description":"The current fetch phase operations."},"search.fetch_time":{"type":"string","description":"The time spent in fetch phase."},"search.fetch_total":{"type":"string","description":"The total number of fetch operations."},"search.open_contexts":{"type":"string","description":"The number of open search contexts."},"search.query_current":{"type":"string","description":"The current query phase operations."},"search.query_time":{"type":"string","description":"The time spent in query phase."},"search.query_total":{"type":"string","description":"The total number of query phase operations."},"search.scroll_current":{"type":"string","description":"The open scroll contexts."},"search.scroll_time":{"type":"string","description":"The time scroll contexts were held open."},"search.scroll_total":{"type":"string","description":"The number of completed scroll contexts."},"segments.count":{"type":"string","description":"The number of segments."},"segments.memory":{"type":"string","description":"The memory used by segments."},"segments.index_writer_memory":{"type":"string","description":"The memory used by the index writer."},"segments.version_map_memory":{"type":"string","description":"The memory used by the version map."},"segments.fixed_bitset_memory":{"type":"string","description":"The memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields."},"seq_no.max":{"type":"string","description":"The maximum sequence number."},"seq_no.local_checkpoint":{"type":"string","description":"The local checkpoint."},"seq_no.global_checkpoint":{"type":"string","description":"The global checkpoint."},"warmer.current":{"type":"string","description":"The number of current warmer operations."},"warmer.total":{"type":"string","description":"The total number of warmer operations."},"warmer.total_time":{"type":"string","description":"The time spent in warmer operations."},"path.data":{"type":"string","description":"The shard data path."},"path.state":{"type":"string","description":"The shard state path."},"bulk.total_operations":{"type":"string","description":"The number of bulk shard operations."},"bulk.total_time":{"type":"string","description":"The time spent in shard bulk operations."},"bulk.total_size_in_bytes":{"type":"string","description":"The total size in bytes of shard bulk operations."},"bulk.avg_time":{"type":"string","description":"The average time spent in shard bulk operations."},"bulk.avg_size_in_bytes":{"type":"string","description":"The average size in bytes of shard bulk operations."}}}}}

package/src/es/json/cat.shards.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.shards","type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A 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"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatShardColumns","description":"List of columns to appear in the response. Supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.","x-found-in":"query"}},"description":"Get shard information.\n\nGet information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.shards","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatShardColumns","description":"List of columns to appear in the response. Supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A 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"}},"description":"Get shard information.\n\nGet information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications."}

package/src/es/json/cat.snapshots.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.snapshots","type":"object","properties":{"repository":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshot repositories used to limit the request.\nAccepts wildcard expressions.\n`_all` returns all repositories.\nIf any repository fails during the request, Elasticsearch returns an error.","x-found-in":"path"},"ignore_unavailable":{"type":"boolean","description":"If `true`, the response does not include information from unavailable snapshots.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatSnapshotsColumns","description":"A comma-separated list of columns names to display.\nIt supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"}},"description":"Get snapshot information.\n\nGet information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.snapshots","type":"object","properties":{"ignore_unavailable":{"type":"boolean","description":"If `true`, the response does not include information from unavailable snapshots.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatSnapshotsColumns","description":"A comma-separated list of columns names to display.\nIt supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"repository":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshot repositories used to limit the request.\nAccepts wildcard expressions.\n`_all` returns all repositories.\nIf any repository fails during the request, Elasticsearch returns an error.","x-found-in":"path"}},"description":"Get snapshot information.\n\nGet information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API."}

package/src/es/json/cat.templates.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat.templates__TemplatesRecord":{"type":"object","properties":{"name":{"type":"string","description":"The template name."},"index_patterns":{"type":"string","description":"The template index patterns."},"order":{"type":"string","description":"The template application order or priority number."},"version":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"The template version."},"composed_of":{"type":"string","description":"The component templates that comprise the index template."}}}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat.templates__TemplatesRecord":{"type":"object","properties":{"name":{"type":"string","description":"The template name."},"index_patterns":{"type":"string","description":"The template index patterns."},"order":{"type":"string","description":"The template application order or priority number."},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The template version."},"composed_of":{"type":"string","description":"The component templates that comprise the index template."}}}}}

package/src/es/json/cat.templates.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.templates","type":"object","properties":{"name":{"type":"string","description":"The name of the template to return.\nAccepts wildcard expressions. If omitted, all templates are returned.","x-found-in":"path"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatTemplatesColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"}},"description":"Get index template information.\n\nGet information about the index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.templates","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatTemplatesColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"name":{"type":"string","description":"The name of the template to return.\nAccepts wildcard expressions. If omitted, all templates are returned.","x-found-in":"path"}},"description":"Get index template information.\n\nGet information about the index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API."}

package/src/es/json/cat.thread_pool.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat.thread_pool__ThreadPoolRecord":{"type":"object","properties":{"node_name":{"type":"string","description":"The node name."},"node_id":{"type":"string","description":"The persistent node identifier."},"ephemeral_node_id":{"type":"string","description":"The ephemeral node identifier."},"pid":{"type":"string","description":"The process identifier."},"host":{"type":"string","description":"The host name for the current node."},"ip":{"type":"string","description":"The IP address for the current node."},"port":{"type":"string","description":"The bound transport port for the current node."},"name":{"type":"string","description":"The thread pool name."},"type":{"type":"string","description":"The thread pool type.\nReturned values include `fixed`, `fixed_auto_queue_size`, `direct`, and `scaling`."},"active":{"type":"string","description":"The number of active threads in the current thread pool."},"pool_size":{"type":"string","description":"The number of threads in the current thread pool."},"queue":{"type":"string","description":"The number of tasks currently in queue."},"queue_size":{"type":"string","description":"The maximum number of tasks permitted in the queue."},"rejected":{"type":"string","description":"The number of rejected tasks."},"largest":{"type":"string","description":"The highest number of active threads in the current thread pool."},"completed":{"type":"string","description":"The number of completed tasks."},"core":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"The core number of active threads allowed in a scaling thread pool."},"max":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"The maximum number of active threads allowed in a scaling thread pool."},"size":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"The number of active threads allowed in a fixed thread pool."},"keep_alive":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"The thread keep alive time."}}}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat.thread_pool__ThreadPoolRecord":{"type":"object","properties":{"node_name":{"type":"string","description":"The node name."},"node_id":{"type":"string","description":"The persistent node identifier."},"ephemeral_node_id":{"type":"string","description":"The ephemeral node identifier."},"pid":{"type":"string","description":"The process identifier."},"host":{"type":"string","description":"The host name for the current node."},"ip":{"type":"string","description":"The IP address for the current node."},"port":{"type":"string","description":"The bound transport port for the current node."},"name":{"type":"string","description":"The thread pool name."},"type":{"type":"string","description":"The thread pool type.\nReturned values include `fixed`, `fixed_auto_queue_size`, `direct`, and `scaling`."},"active":{"type":"string","description":"The number of active threads in the current thread pool."},"pool_size":{"type":"string","description":"The number of threads in the current thread pool."},"queue":{"type":"string","description":"The number of tasks currently in queue."},"queue_size":{"type":"string","description":"The maximum number of tasks permitted in the queue."},"rejected":{"type":"string","description":"The number of rejected tasks."},"largest":{"type":"string","description":"The highest number of active threads in the current thread pool."},"completed":{"type":"string","description":"The number of completed tasks."},"core":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The core number of active threads allowed in a scaling thread pool."},"max":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The maximum number of active threads allowed in a scaling thread pool."},"size":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of active threads allowed in a fixed thread pool."},"keep_alive":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The thread keep alive time."}}}}}

package/src/es/json/cat.thread_pool.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.thread_pool","type":"object","properties":{"thread_pool_patterns":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of thread pool names used to limit the request.\nAccepts wildcard expressions.","x-found-in":"path"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatThreadPoolColumns","description":"List of columns to appear in the response. Supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.","x-found-in":"query"}},"description":"Get thread pool statistics.\n\nGet thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.thread_pool","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatThreadPoolColumns","description":"List of columns to appear in the response. Supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.","x-found-in":"query"},"thread_pool_patterns":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of thread pool names used to limit the request.\nAccepts wildcard expressions.","x-found-in":"path"}},"description":"Get thread pool statistics.\n\nGet thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API."}

package/src/es/json/cat.transforms.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat.transforms__TransformsRecord":{"type":"object","properties":{"id":{"type":"string","description":"The transform identifier."},"state":{"type":"string","description":"The status of the transform.\nReturned values include:\n`aborting`: The transform is aborting.\n`failed: The transform failed. For more information about the failure, check the `reason` field.\n`indexing`: The transform is actively processing data and creating new documents.\n`started`: The transform is running but not actively indexing data.\n`stopped`: The transform is stopped.\n`stopping`: The transform is stopping."},"checkpoint":{"type":"string","description":"The sequence number for the checkpoint."},"documents_processed":{"type":"string","description":"The number of documents that have been processed from the source index of the transform."},"checkpoint_progress":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"The progress of the next checkpoint that is currently in progress."},"last_search_time":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"The timestamp of the last search in the source indices.\nThis field is shown only if the transform is running."},"changes_last_detection_time":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"The timestamp when changes were last detected in the source indices."},"create_time":{"type":"string","description":"The time the transform was created."},"version":{"type":"string","description":"The version of Elasticsearch that existed on the node when the transform was created."},"source_index":{"type":"string","description":"The source indices for the transform."},"dest_index":{"type":"string","description":"The destination index for the transform."},"pipeline":{"type":"string","description":"The unique identifier for the ingest pipeline."},"description":{"type":"string","description":"The description of the transform."},"transform_type":{"type":"string","description":"The type of transform: `batch` or `continuous`."},"frequency":{"type":"string","description":"The interval between checks for changes in the source indices when the transform is running continuously."},"max_page_search_size":{"type":"string","description":"The initial page size that is used for the composite aggregation for each checkpoint."},"docs_per_second":{"type":"string","description":"The number of input documents per second."},"reason":{"type":"string","description":"If a transform has a `failed` state, these details describe the reason for failure."},"search_total":{"type":"string","description":"The total number of search operations on the source index for the transform."},"search_failure":{"type":"string","description":"The total number of search failures."},"search_time":{"type":"string","description":"The total amount of search time, in milliseconds."},"index_total":{"type":"string","description":"The total number of index operations done by the transform."},"index_failure":{"type":"string","description":"The total number of indexing failures."},"index_time":{"type":"string","description":"The total time spent indexing documents, in milliseconds."},"documents_indexed":{"type":"string","description":"The number of documents that have been indexed into the destination index for the transform."},"delete_time":{"type":"string","description":"The total time spent deleting documents, in milliseconds."},"documents_deleted":{"type":"string","description":"The number of documents deleted from the destination index due to the retention policy for the transform."},"trigger_count":{"type":"string","description":"The number of times the transform has been triggered by the scheduler.\nFor example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the `frequency` property."},"pages_processed":{"type":"string","description":"The number of search or bulk index operations processed.\nDocuments are processed in batches instead of individually."},"processing_time":{"type":"string","description":"The total time spent processing results, in milliseconds."},"checkpoint_duration_time_exp_avg":{"type":"string","description":"The exponential moving average of the duration of the checkpoint, in milliseconds."},"indexed_documents_exp_avg":{"type":"string","description":"The exponential moving average of the number of new documents that have been indexed."},"processed_documents_exp_avg":{"type":"string","description":"The exponential moving average of the number of documents that have been processed."}}}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat.transforms__TransformsRecord":{"type":"object","properties":{"id":{"type":"string","description":"The transform identifier."},"state":{"type":"string","description":"The status of the transform.\nReturned values include:\n`aborting`: The transform is aborting.\n`failed: The transform failed. For more information about the failure, check the `reason` field.\n`indexing`: The transform is actively processing data and creating new documents.\n`started`: The transform is running but not actively indexing data.\n`stopped`: The transform is stopped.\n`stopping`: The transform is stopping."},"checkpoint":{"type":"string","description":"The sequence number for the checkpoint."},"documents_processed":{"type":"string","description":"The number of documents that have been processed from the source index of the transform."},"checkpoint_progress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The progress of the next checkpoint that is currently in progress."},"last_search_time":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The timestamp of the last search in the source indices.\nThis field is shown only if the transform is running."},"changes_last_detection_time":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The timestamp when changes were last detected in the source indices."},"create_time":{"type":"string","description":"The time the transform was created."},"version":{"type":"string","description":"The version of Elasticsearch that existed on the node when the transform was created."},"source_index":{"type":"string","description":"The source indices for the transform."},"dest_index":{"type":"string","description":"The destination index for the transform."},"pipeline":{"type":"string","description":"The unique identifier for the ingest pipeline."},"description":{"type":"string","description":"The description of the transform."},"transform_type":{"type":"string","description":"The type of transform: `batch` or `continuous`."},"frequency":{"type":"string","description":"The interval between checks for changes in the source indices when the transform is running continuously."},"max_page_search_size":{"type":"string","description":"The initial page size that is used for the composite aggregation for each checkpoint."},"docs_per_second":{"type":"string","description":"The number of input documents per second."},"reason":{"type":"string","description":"If a transform has a `failed` state, these details describe the reason for failure."},"search_total":{"type":"string","description":"The total number of search operations on the source index for the transform."},"search_failure":{"type":"string","description":"The total number of search failures."},"search_time":{"type":"string","description":"The total amount of search time, in milliseconds."},"index_total":{"type":"string","description":"The total number of index operations done by the transform."},"index_failure":{"type":"string","description":"The total number of indexing failures."},"index_time":{"type":"string","description":"The total time spent indexing documents, in milliseconds."},"documents_indexed":{"type":"string","description":"The number of documents that have been indexed into the destination index for the transform."},"delete_time":{"type":"string","description":"The total time spent deleting documents, in milliseconds."},"documents_deleted":{"type":"string","description":"The number of documents deleted from the destination index due to the retention policy for the transform."},"trigger_count":{"type":"string","description":"The number of times the transform has been triggered by the scheduler.\nFor example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the `frequency` property."},"pages_processed":{"type":"string","description":"The number of search or bulk index operations processed.\nDocuments are processed in batches instead of individually."},"processing_time":{"type":"string","description":"The total time spent processing results, in milliseconds."},"checkpoint_duration_time_exp_avg":{"type":"string","description":"The exponential moving average of the duration of the checkpoint, in milliseconds."},"indexed_documents_exp_avg":{"type":"string","description":"The exponential moving average of the number of new documents that have been indexed."},"processed_documents_exp_avg":{"type":"string","description":"The exponential moving average of the number of documents that have been processed."}}}}}

package/src/es/json/cat.transforms.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.transforms","type":"object","properties":{"transform_id":{"type":"string","description":"A transform identifier or a wildcard expression.\nIf you do not specify one of these options, the API returns information for all transforms.","x-found-in":"path"},"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.\nIf `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the request returns a 404 status code when there are no matches or only partial matches.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of transforms.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatTransformColumns","description":"Comma-separated list of column names to display.","x-found-in":"query"},"s":{"$ref":"./cat._types.json#/$defs/cat._types__CatTransformColumns","description":"Comma-separated list of column names or column aliases used to sort the response.","x-found-in":"query"},"size":{"type":"number","description":"The maximum number of transforms to obtain.","x-found-in":"query"}},"description":"Get transform information.\n\nGet configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.transforms","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.\nIf `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the request returns a 404 status code when there are no matches or only partial matches.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of transforms.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatTransformColumns","description":"Comma-separated list of column names to display.","x-found-in":"query"},"s":{"$ref":"./cat._types.json#/$defs/cat._types__CatTransformColumns","description":"Comma-separated list of column names or column aliases used to sort the response.","x-found-in":"query"},"size":{"type":"number","description":"The maximum number of transforms to obtain.","x-found-in":"query"},"transform_id":{"type":"string","description":"A transform identifier or a wildcard expression.\nIf you do not specify one of these options, the API returns information for all transforms.","x-found-in":"path"}},"description":"Get transform information.\n\nGet configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API."}

package/src/es/json/ccr.delete_auto_follow_pattern.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.delete_auto_follow_pattern","type":"object","properties":{"name":{"type":"string","description":"The auto-follow pattern collection to delete.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf 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"}},"required":["name"],"description":"Delete auto-follow patterns.\n\nDelete a collection of cross-cluster replication auto-follow patterns."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.delete_auto_follow_pattern","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"name":{"type":"string","description":"The auto-follow pattern collection to delete.","x-found-in":"path"}},"required":["name"],"description":"Delete auto-follow patterns.\n\nDelete a collection of cross-cluster replication auto-follow patterns."}

package/src/es/json/ccr.follow.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow","type":"object","properties":{"index":{"type":"string","description":"The name of the follower index.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be\nactive.\nA shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the\nremote Lucene segment files to the follower index.","x-found-in":"query"},"data_stream_name":{"type":"string","description":"If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed.","x-found-in":"body"},"leader_index":{"type":"string","description":"The name of the index in the leader cluster to follow.","x-found-in":"body"},"max_outstanding_read_requests":{"type":"number","description":"The maximum number of outstanding reads requests from the remote cluster.","x-found-in":"body"},"max_outstanding_write_requests":{"type":"number","description":"The maximum number of outstanding write requests on the follower.","x-found-in":"body"},"max_read_request_operation_count":{"type":"number","description":"The maximum number of operations to pull per read from the remote cluster.","x-found-in":"body"},"max_read_request_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.","x-found-in":"body"},"max_retry_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when\nretrying.","x-found-in":"body"},"max_write_buffer_count":{"type":"number","description":"The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be\ndeferred until the number of queued operations goes below the limit.","x-found-in":"body"},"max_write_buffer_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will\nbe deferred until the total bytes of queued operations goes below the limit.","x-found-in":"body"},"max_write_request_operation_count":{"type":"number","description":"The maximum number of operations per bulk write request executed on the follower.","x-found-in":"body"},"max_write_request_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum total bytes of operations per bulk write request executed on the follower.","x-found-in":"body"},"read_poll_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index.\nWhen the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics.\nThen the follower will immediately attempt to read from the leader again.","x-found-in":"body"},"remote_cluster":{"type":"string","description":"The remote cluster containing the leader index.","x-found-in":"body"},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Settings to override from the leader index.","x-found-in":"body"}},"required":["index","leader_index","remote_cluster"],"description":"Create a follower.\n\nCreate a cross-cluster replication follower index that follows a specific leader index.\nWhen the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be\nactive.\nA shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the\nremote Lucene segment files to the follower index.","x-found-in":"query"},"data_stream_name":{"type":"string","description":"If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed.","x-found-in":"body"},"leader_index":{"type":"string","description":"The name of the index in the leader cluster to follow.","x-found-in":"body"},"max_outstanding_read_requests":{"type":"number","description":"The maximum number of outstanding reads requests from the remote cluster.","x-found-in":"body"},"max_outstanding_write_requests":{"type":"number","description":"The maximum number of outstanding write requests on the follower.","x-found-in":"body"},"max_read_request_operation_count":{"type":"number","description":"The maximum number of operations to pull per read from the remote cluster.","x-found-in":"body"},"max_read_request_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.","x-found-in":"body"},"max_retry_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when\nretrying.","x-found-in":"body"},"max_write_buffer_count":{"type":"number","description":"The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be\ndeferred until the number of queued operations goes below the limit.","x-found-in":"body"},"max_write_buffer_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will\nbe deferred until the total bytes of queued operations goes below the limit.","x-found-in":"body"},"max_write_request_operation_count":{"type":"number","description":"The maximum number of operations per bulk write request executed on the follower.","x-found-in":"body"},"max_write_request_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum total bytes of operations per bulk write request executed on the follower.","x-found-in":"body"},"read_poll_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index.\nWhen the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics.\nThen the follower will immediately attempt to read from the leader again.","x-found-in":"body"},"remote_cluster":{"type":"string","description":"The remote cluster containing the leader index.","x-found-in":"body"},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Settings to override from the leader index.","x-found-in":"body"},"index":{"type":"string","description":"The name of the follower index.","x-found-in":"path"}},"required":["index","leader_index","remote_cluster"],"description":"Create a follower.\n\nCreate a cross-cluster replication follower index that follows a specific leader index.\nWhen the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index."}

package/src/es/json/ccr.follow_info.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow_info","type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-delimited list of follower index patterns.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf 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"}},"required":["index"],"description":"Get follower information.\n\nGet information about all cross-cluster replication follower indices.\nFor example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow_info","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-delimited list of follower index patterns.","x-found-in":"path"}},"required":["index"],"description":"Get follower information.\n\nGet information about all cross-cluster replication follower indices.\nFor example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused."}

package/src/es/json/ccr.follow_stats.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow_stats","type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-delimited list of index patterns.","x-found-in":"path"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"}},"required":["index"],"description":"Get follower stats.\n\nGet cross-cluster replication follower stats.\nThe API returns shard-level stats about the \"following tasks\" associated with each shard for the specified indices."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow_stats","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-delimited list of index patterns.","x-found-in":"path"}},"required":["index"],"description":"Get follower stats.\n\nGet cross-cluster replication follower stats.\nThe API returns shard-level stats about the \"following tasks\" associated with each shard for the specified indices."}

package/src/es/json/ccr.forget_follower.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.forget_follower","type":"object","properties":{"index":{"type":"string","description":"Name of the leader index for which specified follower retention leases should be removed","x-found-in":"path"},"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"},"follower_cluster":{"type":"string","x-found-in":"body"},"follower_index":{"type":"string","x-found-in":"body"},"follower_index_uuid":{"type":"string","x-found-in":"body"},"leader_remote_cluster":{"type":"string","x-found-in":"body"}},"required":["index"],"description":"Forget a follower.\n\nRemove the cross-cluster replication follower retention leases from the leader.\n\nA following index takes out retention leases on its leader index.\nThese leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication.\nWhen a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed.\nHowever, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable.\nWhile the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index.\nThis API exists to enable manually removing the leases when the unfollow API is unable to do so.\n\nNOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader.\nThe only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.forget_follower","type":"object","properties":{"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"},"follower_cluster":{"type":"string","x-found-in":"body"},"follower_index":{"type":"string","x-found-in":"body"},"follower_index_uuid":{"type":"string","x-found-in":"body"},"leader_remote_cluster":{"type":"string","x-found-in":"body"},"index":{"type":"string","description":"Name of the leader index for which specified follower retention leases should be removed","x-found-in":"path"}},"required":["index"],"description":"Forget a follower.\n\nRemove the cross-cluster replication follower retention leases from the leader.\n\nA following index takes out retention leases on its leader index.\nThese leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication.\nWhen a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed.\nHowever, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable.\nWhile the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index.\nThis API exists to enable manually removing the leases when the unfollow API is unable to do so.\n\nNOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader.\nThe only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked."}

package/src/es/json/ccr.get_auto_follow_pattern.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.get_auto_follow_pattern","type":"object","properties":{"name":{"type":"string","description":"The auto-follow pattern collection that you want to retrieve.\nIf you do not specify a name, the API returns information for all collections.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf 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"}},"description":"Get auto-follow patterns.\n\nGet cross-cluster replication auto-follow patterns."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.get_auto_follow_pattern","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"name":{"type":"string","description":"The auto-follow pattern collection that you want to retrieve.\nIf you do not specify a name, the API returns information for all collections.","x-found-in":"path"}},"description":"Get auto-follow patterns.\n\nGet cross-cluster replication auto-follow patterns."}

package/src/es/json/ccr.pause_auto_follow_pattern.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.pause_auto_follow_pattern","type":"object","properties":{"name":{"type":"string","description":"The name of the auto-follow pattern to pause.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf 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"}},"required":["name"],"description":"Pause an auto-follow pattern.\n\nPause a cross-cluster replication auto-follow pattern.\nWhen the API returns, the auto-follow pattern is inactive.\nNew indices that are created on the remote cluster and match the auto-follow patterns are ignored.\n\nYou can resume auto-following with the resume auto-follow pattern API.\nWhen it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.\nRemote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.pause_auto_follow_pattern","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"name":{"type":"string","description":"The name of the auto-follow pattern to pause.","x-found-in":"path"}},"required":["name"],"description":"Pause an auto-follow pattern.\n\nPause a cross-cluster replication auto-follow pattern.\nWhen the API returns, the auto-follow pattern is inactive.\nNew indices that are created on the remote cluster and match the auto-follow patterns are ignored.\n\nYou can resume auto-following with the resume auto-follow pattern API.\nWhen it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.\nRemote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim."}

package/src/es/json/ccr.pause_follow.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.pause_follow","type":"object","properties":{"index":{"type":"string","description":"The name of the follower index.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf 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"}},"required":["index"],"description":"Pause a follower.\n\nPause a cross-cluster replication follower index.\nThe follower index will not fetch any additional operations from the leader index.\nYou can resume following with the resume follower API.\nYou can pause and resume a follower index to change the configuration of the following task."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.pause_follow","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"index":{"type":"string","description":"The name of the follower index.","x-found-in":"path"}},"required":["index"],"description":"Pause a follower.\n\nPause a cross-cluster replication follower index.\nThe follower index will not fetch any additional operations from the leader index.\nYou can resume following with the resume follower API.\nYou can pause and resume a follower index to change the configuration of the following task."}

package/src/es/json/ccr.put_auto_follow_pattern.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.put_auto_follow_pattern","type":"object","properties":{"name":{"type":"string","description":"The name of the collection of auto-follow patterns.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"remote_cluster":{"type":"string","description":"The remote cluster containing the leader indices to match against.","x-found-in":"body"},"follow_index_pattern":{"type":"string","description":"The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices.","x-found-in":"body"},"leader_index_patterns":{"$ref":"./_types.json#/$defs/_types__IndexPatterns","description":"An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.","x-found-in":"body"},"leader_index_exclusion_patterns":{"$ref":"./_types.json#/$defs/_types__IndexPatterns","description":"An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed.","x-found-in":"body"},"max_outstanding_read_requests":{"type":"number","description":"The maximum number of outstanding reads requests from the remote cluster.","x-found-in":"body"},"settings":{"type":"object","additionalProperties":{},"description":"Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).","x-found-in":"body"},"max_outstanding_write_requests":{"type":"number","description":"The maximum number of outstanding reads requests from the remote cluster.","x-found-in":"body"},"read_poll_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again.","x-found-in":"body"},"max_read_request_operation_count":{"type":"number","description":"The maximum number of operations to pull per read from the remote cluster.","x-found-in":"body"},"max_read_request_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.","x-found-in":"body"},"max_retry_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.","x-found-in":"body"},"max_write_buffer_count":{"type":"number","description":"The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit.","x-found-in":"body"},"max_write_buffer_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit.","x-found-in":"body"},"max_write_request_operation_count":{"type":"number","description":"The maximum number of operations per bulk write request executed on the follower.","x-found-in":"body"},"max_write_request_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum total bytes of operations per bulk write request executed on the follower.","x-found-in":"body"}},"required":["name","remote_cluster"],"description":"Create or update auto-follow patterns.\n\nCreate a collection of cross-cluster replication auto-follow patterns for a remote cluster.\nNewly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.\nIndices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.\n\nThis API can also be used to update auto-follow patterns.\nNOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.put_auto_follow_pattern","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"remote_cluster":{"type":"string","description":"The remote cluster containing the leader indices to match against.","x-found-in":"body"},"follow_index_pattern":{"type":"string","description":"The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices.","x-found-in":"body"},"leader_index_patterns":{"$ref":"./_types.json#/$defs/_types__IndexPatterns","description":"An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.","x-found-in":"body"},"leader_index_exclusion_patterns":{"$ref":"./_types.json#/$defs/_types__IndexPatterns","description":"An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed.","x-found-in":"body"},"max_outstanding_read_requests":{"type":"number","description":"The maximum number of outstanding reads requests from the remote cluster.","x-found-in":"body"},"settings":{"type":"object","additionalProperties":{},"description":"Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).","x-found-in":"body"},"max_outstanding_write_requests":{"type":"number","description":"The maximum number of outstanding reads requests from the remote cluster.","x-found-in":"body"},"read_poll_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again.","x-found-in":"body"},"max_read_request_operation_count":{"type":"number","description":"The maximum number of operations to pull per read from the remote cluster.","x-found-in":"body"},"max_read_request_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.","x-found-in":"body"},"max_retry_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.","x-found-in":"body"},"max_write_buffer_count":{"type":"number","description":"The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit.","x-found-in":"body"},"max_write_buffer_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit.","x-found-in":"body"},"max_write_request_operation_count":{"type":"number","description":"The maximum number of operations per bulk write request executed on the follower.","x-found-in":"body"},"max_write_request_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum total bytes of operations per bulk write request executed on the follower.","x-found-in":"body"},"name":{"type":"string","description":"The name of the collection of auto-follow patterns.","x-found-in":"path"}},"required":["name","remote_cluster"],"description":"Create or update auto-follow patterns.\n\nCreate a collection of cross-cluster replication auto-follow patterns for a remote cluster.\nNewly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.\nIndices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.\n\nThis API can also be used to update auto-follow patterns.\nNOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns."}

package/src/es/json/ccr.resume_auto_follow_pattern.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.resume_auto_follow_pattern","type":"object","properties":{"name":{"type":"string","description":"The name of the auto-follow pattern to resume.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf 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"}},"required":["name"],"description":"Resume an auto-follow pattern.\n\nResume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.resume_auto_follow_pattern","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"name":{"type":"string","description":"The name of the auto-follow pattern to resume.","x-found-in":"path"}},"required":["name"],"description":"Resume an auto-follow pattern.\n\nResume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim."}

package/src/es/json/ccr.resume_follow.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.resume_follow","type":"object","properties":{"index":{"type":"string","description":"Name of the follow index to resume following","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"max_outstanding_read_requests":{"type":"number","x-found-in":"body"},"max_outstanding_write_requests":{"type":"number","x-found-in":"body"},"max_read_request_operation_count":{"type":"number","x-found-in":"body"},"max_read_request_size":{"type":"string","x-found-in":"body"},"max_retry_delay":{"$ref":"./_types.json#/$defs/_types__Duration","x-found-in":"body"},"max_write_buffer_count":{"type":"number","x-found-in":"body"},"max_write_buffer_size":{"type":"string","x-found-in":"body"},"max_write_request_operation_count":{"type":"number","x-found-in":"body"},"max_write_request_size":{"type":"string","x-found-in":"body"},"read_poll_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","x-found-in":"body"}},"required":["index"],"description":"Resume a follower.\n\nResume a cross-cluster replication follower index that was paused.\nThe follower index could have been paused with the pause follower API.\nAlternatively it could be paused due to replication that cannot be retried due to failures during following tasks.\nWhen this API returns, the follower index will resume fetching operations from the leader index."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.resume_follow","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"max_outstanding_read_requests":{"type":"number","x-found-in":"body"},"max_outstanding_write_requests":{"type":"number","x-found-in":"body"},"max_read_request_operation_count":{"type":"number","x-found-in":"body"},"max_read_request_size":{"type":"string","x-found-in":"body"},"max_retry_delay":{"$ref":"./_types.json#/$defs/_types__Duration","x-found-in":"body"},"max_write_buffer_count":{"type":"number","x-found-in":"body"},"max_write_buffer_size":{"type":"string","x-found-in":"body"},"max_write_request_operation_count":{"type":"number","x-found-in":"body"},"max_write_request_size":{"type":"string","x-found-in":"body"},"read_poll_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","x-found-in":"body"},"index":{"type":"string","description":"Name of the follow index to resume following","x-found-in":"path"}},"required":["index"],"description":"Resume a follower.\n\nResume a cross-cluster replication follower index that was paused.\nThe follower index could have been paused with the pause follower API.\nAlternatively it could be paused due to replication that cannot be retried due to failures during following tasks.\nWhen this API returns, the follower index will resume fetching operations from the leader index."}

package/src/es/json/ccr.unfollow.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.unfollow","type":"object","properties":{"index":{"type":"string","description":"The name of the follower index.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf 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"}},"required":["index"],"description":"Unfollow an index.\n\nConvert a cross-cluster replication follower index to a regular index.\nThe API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.\nThe follower index must be paused and closed before you call the unfollow API.\n\n> info\n> Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.unfollow","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"index":{"type":"string","description":"The name of the follower index.","x-found-in":"path"}},"required":["index"],"description":"Unfollow an index.\n\nConvert a cross-cluster replication follower index to a regular index.\nThe API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.\nThe follower index must be paused and closed before you call the unfollow API.\n\n> info\n> Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation."}

package/src/es/json/clear_scroll.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"clear_scroll","type":"object","properties":{"scroll_id":{"$ref":"./_types.json#/$defs/_types__ScrollIds","description":"The scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.","x-found-in":"body"}},"description":"Clear a scrolling search.\n\nClear the search context and results for a scrolling search."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"clear_scroll","type":"object","properties":{"scroll_id":{"$ref":"./_types.json#/$defs/_types__ScrollIds","description":"A comma-separated list of scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.\nIMPORTANT: Scroll IDs can be long. It is recommended to specify scroll IDs in the request body parameter.","x-found-in":"body"}},"description":"Clear a scrolling search.\n\nClear the search context and results for a scrolling search."}

package/src/es/json/cluster.delete_component_template.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cluster.delete_component_template","type":"object","properties":{"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"Comma-separated list or wildcard expression of component template names used to limit the request.","x-found-in":"path"},"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"}},"required":["name"],"description":"Delete component templates.\n\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cluster.delete_component_template","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"},"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"Comma-separated list or wildcard expression of component template names used to limit the request.","x-found-in":"path"}},"required":["name"],"description":"Delete component templates.\n\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases."}

package/src/es/json/cluster.exists_component_template.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cluster.exists_component_template","type":"object","properties":{"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"Comma-separated list of component template names used to limit the request.\nWildcard (*) expressions are supported.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.","x-found-in":"query"},"local":{"type":"boolean","description":"If true, the request retrieves information from the local node only.\nDefaults to false, which means information is retrieved from the master node.","x-found-in":"query"}},"required":["name"],"description":"Check component templates.\n\nReturns information about whether a particular component template exists."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cluster.exists_component_template","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\nreceived before the timeout expires, the request fails and returns an\nerror.","x-found-in":"query"},"local":{"type":"boolean","description":"If true, the request retrieves information from the local node only.\nDefaults to false, which means information is retrieved from the master node.","x-found-in":"query"},"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"Comma-separated list of component template names used to limit the request.\nWildcard (*) expressions are supported.","x-found-in":"path"}},"required":["name"],"description":"Check component templates.\n\nReturns information about whether a particular component template exists."}

package/src/es/json/cluster.get_component_template.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cluster.get_component_template","type":"object","properties":{"name":{"type":"string","description":"Name of component template to retrieve. Wildcard (`*`) expressions are supported.","x-found-in":"path"},"flat_settings":{"type":"boolean","description":"If `true`, returns settings in flat format.","x-found-in":"query"},"settings_filter":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys","x-found-in":"query"},"include_defaults":{"type":"boolean","description":"Return all default configurations for the component template","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request retrieves information from the local node only.\nIf `false`, information is retrieved from the master node.","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"}},"description":"Get component templates.\n\nGet information about component templates."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cluster.get_component_template","type":"object","properties":{"flat_settings":{"type":"boolean","description":"If `true`, returns settings in flat format.","x-found-in":"query"},"settings_filter":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys","x-found-in":"query"},"include_defaults":{"type":"boolean","description":"Return all default configurations for the component template","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request retrieves information from the local node only.\nIf `false`, information is retrieved from the master node.","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"},"name":{"type":"string","description":"Name of component template to retrieve. Wildcard (`*`) expressions are supported.","x-found-in":"path"}},"description":"Get component templates.\n\nGet information about component templates."}

package/src/es/json/cluster.health.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cluster.health__WaitForNodes":{"oneOf":[{"type":"string"},{"type":"number"}]},"cluster.health__HealthResponseBody":{"type":"object","properties":{"active_primary_shards":{"type":"number","description":"The number of active primary shards."},"active_shards":{"type":"number","description":"The total number of active primary and replica shards."},"active_shards_percent":{"type":"string","description":"The ratio of active shards in the cluster expressed as a string formatted percentage."},"active_shards_percent_as_number":{"type":"number","description":"The ratio of active shards in the cluster expressed as a percentage."},"cluster_name":{"type":"string","description":"The name of the cluster."},"delayed_unassigned_shards":{"type":"number","description":"The number of shards whose allocation has been delayed by the timeout settings."},"indices":{"type":"object","additionalProperties":{"$ref":"./cluster.health.json#/$defs/cluster.health__IndexHealthStats"}},"initializing_shards":{"type":"number","description":"The number of shards that are under initialization."},"number_of_data_nodes":{"type":"number","description":"The number of nodes that are dedicated data nodes."},"number_of_in_flight_fetch":{"type":"number","description":"The number of unfinished fetches."},"number_of_nodes":{"type":"number","description":"The number of nodes within the cluster."},"number_of_pending_tasks":{"type":"number","description":"The number of cluster-level changes that have not yet been executed."},"relocating_shards":{"type":"number","description":"The number of shards that are under relocation."},"status":{"$ref":"./_types.json#/$defs/_types__HealthStatus"},"task_max_waiting_in_queue":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time since the earliest initiated task is waiting for being performed."},"task_max_waiting_in_queue_millis":{"description":"The time expressed in milliseconds since the earliest initiated task is waiting for being performed."},"timed_out":{"type":"boolean","description":"If false the response returned within the period of time that is specified by the timeout parameter (30s by default)"},"unassigned_primary_shards":{"type":"number","description":"The number of primary shards that are not allocated."},"unassigned_shards":{"type":"number","description":"The number of shards that are not allocated."}},"required":["active_primary_shards","active_shards","active_shards_percent_as_number","cluster_name","delayed_unassigned_shards","initializing_shards","number_of_data_nodes","number_of_in_flight_fetch","number_of_nodes","number_of_pending_tasks","relocating_shards","status","task_max_waiting_in_queue_millis","timed_out","unassigned_primary_shards","unassigned_shards"]},"cluster.health__IndexHealthStats":{"type":"object","properties":{"active_primary_shards":{"type":"number"},"active_shards":{"type":"number"},"initializing_shards":{"type":"number"},"number_of_replicas":{"type":"number"},"number_of_shards":{"type":"number"},"relocating_shards":{"type":"number"},"shards":{"type":"object","additionalProperties":{"$ref":"./cluster.health.json#/$defs/cluster.health__ShardHealthStats"}},"status":{"$ref":"./_types.json#/$defs/_types__HealthStatus"},"unassigned_shards":{"type":"number"},"unassigned_primary_shards":{"type":"number"}},"required":["active_primary_shards","active_shards","initializing_shards","number_of_replicas","number_of_shards","relocating_shards","status","unassigned_shards","unassigned_primary_shards"]},"cluster.health__ShardHealthStats":{"type":"object","properties":{"active_shards":{"type":"number"},"initializing_shards":{"type":"number"},"primary_active":{"type":"boolean"},"relocating_shards":{"type":"number"},"status":{"$ref":"./_types.json#/$defs/_types__HealthStatus"},"unassigned_shards":{"type":"number"},"unassigned_primary_shards":{"type":"number"}},"required":["active_shards","initializing_shards","primary_active","relocating_shards","status","unassigned_shards","unassigned_primary_shards"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cluster.health__WaitForNodes":{"anyOf":[{"type":"string"},{"type":"number"}]},"cluster.health__HealthResponseBody":{"type":"object","properties":{"active_primary_shards":{"type":"number","description":"The number of active primary shards."},"active_shards":{"type":"number","description":"The total number of active primary and replica shards."},"active_shards_percent":{"type":"string","description":"The ratio of active shards in the cluster expressed as a string formatted percentage."},"active_shards_percent_as_number":{"type":"number","description":"The ratio of active shards in the cluster expressed as a percentage."},"cluster_name":{"type":"string","description":"The name of the cluster."},"delayed_unassigned_shards":{"type":"number","description":"The number of shards whose allocation has been delayed by the timeout settings."},"indices":{"type":"object","additionalProperties":{"$ref":"./cluster.health.json#/$defs/cluster.health__IndexHealthStats"}},"initializing_shards":{"type":"number","description":"The number of shards that are under initialization."},"number_of_data_nodes":{"type":"number","description":"The number of nodes that are dedicated data nodes."},"number_of_in_flight_fetch":{"type":"number","description":"The number of unfinished fetches."},"number_of_nodes":{"type":"number","description":"The number of nodes within the cluster."},"number_of_pending_tasks":{"type":"number","description":"The number of cluster-level changes that have not yet been executed."},"relocating_shards":{"type":"number","description":"The number of shards that are under relocation."},"status":{"$ref":"./_types.json#/$defs/_types__HealthStatus"},"task_max_waiting_in_queue":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time since the earliest initiated task is waiting for being performed."},"task_max_waiting_in_queue_millis":{"description":"The time expressed in milliseconds since the earliest initiated task is waiting for being performed."},"timed_out":{"type":"boolean","description":"If false the response returned within the period of time that is specified by the timeout parameter (30s by default)"},"unassigned_primary_shards":{"type":"number","description":"The number of primary shards that are not allocated."},"unassigned_shards":{"type":"number","description":"The number of shards that are not allocated."}},"required":["active_primary_shards","active_shards","active_shards_percent_as_number","cluster_name","delayed_unassigned_shards","initializing_shards","number_of_data_nodes","number_of_in_flight_fetch","number_of_nodes","number_of_pending_tasks","relocating_shards","status","task_max_waiting_in_queue_millis","timed_out","unassigned_primary_shards","unassigned_shards"]},"cluster.health__IndexHealthStats":{"type":"object","properties":{"active_primary_shards":{"type":"number"},"active_shards":{"type":"number"},"initializing_shards":{"type":"number"},"number_of_replicas":{"type":"number"},"number_of_shards":{"type":"number"},"relocating_shards":{"type":"number"},"shards":{"type":"object","additionalProperties":{"$ref":"./cluster.health.json#/$defs/cluster.health__ShardHealthStats"}},"status":{"$ref":"./_types.json#/$defs/_types__HealthStatus"},"unassigned_shards":{"type":"number"},"unassigned_primary_shards":{"type":"number"}},"required":["active_primary_shards","active_shards","initializing_shards","number_of_replicas","number_of_shards","relocating_shards","status","unassigned_shards","unassigned_primary_shards"]},"cluster.health__ShardHealthStats":{"type":"object","properties":{"active_shards":{"type":"number"},"initializing_shards":{"type":"number"},"primary_active":{"type":"boolean"},"relocating_shards":{"type":"number"},"status":{"$ref":"./_types.json#/$defs/_types__HealthStatus"},"unassigned_shards":{"type":"number"},"unassigned_primary_shards":{"type":"number"}},"required":["active_shards","initializing_shards","primary_active","relocating_shards","status","unassigned_shards","unassigned_primary_shards"]}}}

package/src/es/json/cluster.health.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cluster.health","type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and index aliases that limit the request.\nWildcard expressions (`*`) are supported.\nTo target all data streams and indices in a cluster, omit this parameter or use _all or `*`.","x-found-in":"path"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Expand wildcard expression to concrete indices that are open, closed or both.","x-found-in":"query"},"level":{"$ref":"./_types.json#/$defs/_types__Level","description":"Return health information at a specific level of detail.","x-found-in":"query"},"local":{"type":"boolean","description":"If true, retrieve information from the local node only.\nIf false, retrieve information from the master node.","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.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"Wait for the specified number of active shards.\nUse `all` to wait for all shards in the cluster to be active.\nUse `0` to not wait.","x-found-in":"query"},"wait_for_events":{"$ref":"./_types.json#/$defs/_types__WaitForEvents","description":"Wait until all currently queued events with the given priority are processed.","x-found-in":"query"},"wait_for_nodes":{"$ref":"./cluster.health.json#/$defs/cluster.health__WaitForNodes","description":"Wait until the specified number (N) of nodes is available.\nIt also accepts `>=N`, `<=N`, `>N` and `<N`.\nAlternatively, use the notations `ge(N)`, `le(N)`, `gt(N)`, and `lt(N)`.","x-found-in":"query"},"wait_for_no_initializing_shards":{"type":"boolean","description":"Wait (until the timeout expires) for the cluster to have no shard initializations.\nIf false, the request does not wait for initializing shards.","x-found-in":"query"},"wait_for_no_relocating_shards":{"type":"boolean","description":"Wait (until the timeout expires) for the cluster to have no shard relocations.\nIf false, the request not wait for relocating shards.","x-found-in":"query"},"wait_for_status":{"$ref":"./_types.json#/$defs/_types__HealthStatus","description":"Wait (until the timeout expires) for the cluster to reach a specific health status (or a better status).\nA green status is better than yellow and yellow is better than red.\nBy default, the request does not wait for a particular status.","x-found-in":"query"}},"description":"Get the cluster health status.\n\nYou can also use the API to get the health status of only specified data streams and indices.\nFor data streams, the API retrieves the health status of the stream’s backing indices.\n\nThe cluster health status is: green, yellow or red.\nOn the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.\nThe index level status is controlled by the worst shard status.\n\nOne of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.\nThe cluster status is controlled by the worst index status."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cluster.health","type":"object","properties":{"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Expand wildcard expression to concrete indices that are open, closed or both.","x-found-in":"query"},"level":{"$ref":"./_types.json#/$defs/_types__Level","description":"Return health information at a specific level of detail.","x-found-in":"query"},"local":{"type":"boolean","description":"If true, retrieve information from the local node only.\nIf false, retrieve information from the master node.","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.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"Wait for the specified number of active shards.\nUse `all` to wait for all shards in the cluster to be active.\nUse `0` to not wait.","x-found-in":"query"},"wait_for_events":{"$ref":"./_types.json#/$defs/_types__WaitForEvents","description":"Wait until all currently queued events with the given priority are processed.","x-found-in":"query"},"wait_for_nodes":{"$ref":"./cluster.health.json#/$defs/cluster.health__WaitForNodes","description":"Wait until the specified number (N) of nodes is available.\nIt also accepts `>=N`, `<=N`, `>N` and `<N`.\nAlternatively, use the notations `ge(N)`, `le(N)`, `gt(N)`, and `lt(N)`.","x-found-in":"query"},"wait_for_no_initializing_shards":{"type":"boolean","description":"Wait (until the timeout expires) for the cluster to have no shard initializations.\nIf false, the request does not wait for initializing shards.","x-found-in":"query"},"wait_for_no_relocating_shards":{"type":"boolean","description":"Wait (until the timeout expires) for the cluster to have no shard relocations.\nIf false, the request not wait for relocating shards.","x-found-in":"query"},"wait_for_status":{"$ref":"./_types.json#/$defs/_types__HealthStatus","description":"Wait (until the timeout expires) for the cluster to reach a specific health status (or a better status).\nA green status is better than yellow and yellow is better than red.\nBy default, the request does not wait for a particular status.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and index aliases that limit the request.\nWildcard expressions (`*`) are supported.\nTo target all data streams and indices in a cluster, omit this parameter or use _all or `*`.","x-found-in":"path"}},"description":"Get the cluster health status.\n\nYou can also use the API to get the health status of only specified data streams and indices.\nFor data streams, the API retrieves the health status of the stream’s backing indices.\n\nThe cluster health status is: green, yellow or red.\nOn the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.\nThe index level status is controlled by the worst shard status.\n\nOne of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.\nThe cluster status is controlled by the worst index status."}

package/src/es/json/cluster.put_component_template.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cluster.put_component_template","type":"object","properties":{"name":{"type":"string","description":"Name of the component template to create.\nElasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`.\nElastic Agent uses these templates to configure backing indices for its data streams.\nIf you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.\nIf you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API.","x-found-in":"path"},"create":{"type":"boolean","description":"If `true`, this request cannot replace or update existing component templates.","x-found-in":"query"},"cause":{"type":"string","description":"User defined reason for create the component template.","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"},"template":{"$ref":"./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping","description":"The template to be applied which includes mappings, settings, or aliases configuration.","x-found-in":"body"},"version":{"type":"number","description":"Version number used to manage component templates externally.\nThis number isn't automatically generated or incremented by Elasticsearch.\nTo unset a version, replace the template without specifying a version.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional user metadata about the component template.\nIt may have any contents. This map is not automatically generated by Elasticsearch.\nThis information is stored in the cluster state, so keeping it short is preferable.\nTo unset `_meta`, replace the template without specifying this information.","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"}},"required":["name","template"],"description":"Create or update a component template.\n\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.\n\n**Applying component templates**\n\nYou cannot directly apply a component template to a data stream or index.\nTo be applied, a component template must be included in an index template's `composed_of` list."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cluster.put_component_template","type":"object","properties":{"create":{"type":"boolean","description":"If `true`, this request cannot replace or update existing component templates.","x-found-in":"query"},"cause":{"type":"string","description":"User defined reason for create the component template.","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"},"template":{"$ref":"./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping","description":"The template to be applied which includes mappings, settings, or aliases configuration.","x-found-in":"body"},"version":{"type":"number","description":"Version number used to manage component templates externally.\nThis number isn't automatically generated or incremented by Elasticsearch.\nTo unset a version, replace the template without specifying a version.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional user metadata about the component template.\nIt may have any contents. This map is not automatically generated by Elasticsearch.\nThis information is stored in the cluster state, so keeping it short is preferable.\nTo unset `_meta`, replace the template without specifying this information.","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 component template to create.\nElasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`.\nElastic Agent uses these templates to configure backing indices for its data streams.\nIf you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.\nIf you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API.","x-found-in":"path"}},"required":["name","template"],"description":"Create or update a component template.\n\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.\n\n**Applying component templates**\n\nYou cannot directly apply a component template to a data stream or index.\nTo be applied, a component template must be included in an index template's `composed_of` list."}

package/src/es/json/cluster.remote_info.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cluster.remote_info__ClusterRemoteInfo":{"oneOf":[{"$ref":"./cluster.remote_info.json#/$defs/cluster.remote_info__ClusterRemoteSniffInfo"},{"$ref":"./cluster.remote_info.json#/$defs/cluster.remote_info__ClusterRemoteProxyInfo"}]},"cluster.remote_info__ClusterRemoteSniffInfo":{"type":"object","properties":{"mode":{"const":"sniff","description":"The connection mode for the remote cluster."},"connected":{"type":"boolean","description":"If it is `true`, there is at least one open connection to the remote cluster.\nIf it is `false`, it means that the cluster no longer has an open connection to the remote cluster.\nIt does not necessarily mean that the remote cluster is down or unavailable, just that at some point a connection was lost."},"max_connections_per_cluster":{"type":"number","description":"The maximum number of connections maintained for the remote cluster when sniff mode is configured."},"num_nodes_connected":{"type":"number","description":"The number of connected nodes in the remote cluster when sniff mode is configured."},"initial_connect_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The initial connect timeout for remote cluster connections."},"skip_unavailable":{"type":"boolean","description":"If `true`, cross-cluster search skips the remote cluster when its nodes are unavailable during the search and ignores errors returned by the remote cluster."},"seeds":{"type":"array","items":{"type":"string"},"description":"The initial seed transport addresses of the remote cluster when sniff mode is configured."}},"required":["mode","connected","max_connections_per_cluster","num_nodes_connected","initial_connect_timeout","skip_unavailable","seeds"]},"cluster.remote_info__ClusterRemoteProxyInfo":{"type":"object","properties":{"mode":{"const":"proxy","description":"The connection mode for the remote cluster."},"connected":{"type":"boolean","description":"If it is `true`, there is at least one open connection to the remote cluster.\nIf it is `false`, it means that the cluster no longer has an open connection to the remote cluster.\nIt does not necessarily mean that the remote cluster is down or unavailable, just that at some point a connection was lost."},"initial_connect_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The initial connect timeout for remote cluster connections."},"skip_unavailable":{"type":"boolean","description":"If `true`, cross-cluster search skips the remote cluster when its nodes are unavailable during the search and ignores errors returned by the remote cluster."},"proxy_address":{"type":"string","description":"The address for remote connections when proxy mode is configured."},"server_name":{"type":"string"},"num_proxy_sockets_connected":{"type":"number","description":"The number of open socket connections to the remote cluster when proxy mode is configured."},"max_proxy_socket_connections":{"type":"number","description":"The maximum number of socket connections to the remote cluster when proxy mode is configured."},"cluster_credentials":{"type":"string","description":"This field is present and has a value of `::es_redacted::` only when the remote cluster is configured with the API key based model. Otherwise, the field is not present."}},"required":["mode","connected","initial_connect_timeout","skip_unavailable","proxy_address","server_name","num_proxy_sockets_connected","max_proxy_socket_connections"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cluster.remote_info__ClusterRemoteInfo":{"anyOf":[{"$ref":"./cluster.remote_info.json#/$defs/cluster.remote_info__ClusterRemoteSniffInfo"},{"$ref":"./cluster.remote_info.json#/$defs/cluster.remote_info__ClusterRemoteProxyInfo"}]},"cluster.remote_info__ClusterRemoteSniffInfo":{"type":"object","properties":{"mode":{"const":"sniff","description":"The connection mode for the remote cluster."},"connected":{"type":"boolean","description":"If it is `true`, there is at least one open connection to the remote cluster.\nIf it is `false`, it means that the cluster no longer has an open connection to the remote cluster.\nIt does not necessarily mean that the remote cluster is down or unavailable, just that at some point a connection was lost."},"max_connections_per_cluster":{"type":"number","description":"The maximum number of connections maintained for the remote cluster when sniff mode is configured."},"num_nodes_connected":{"type":"number","description":"The number of connected nodes in the remote cluster when sniff mode is configured."},"initial_connect_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The initial connect timeout for remote cluster connections."},"skip_unavailable":{"type":"boolean","description":"If `true`, cross-cluster search skips the remote cluster when its nodes are unavailable during the search and ignores errors returned by the remote cluster."},"seeds":{"type":"array","items":{"type":"string"},"description":"The initial seed transport addresses of the remote cluster when sniff mode is configured."}},"required":["mode","connected","max_connections_per_cluster","num_nodes_connected","initial_connect_timeout","skip_unavailable","seeds"]},"cluster.remote_info__ClusterRemoteProxyInfo":{"type":"object","properties":{"mode":{"const":"proxy","description":"The connection mode for the remote cluster."},"connected":{"type":"boolean","description":"If it is `true`, there is at least one open connection to the remote cluster.\nIf it is `false`, it means that the cluster no longer has an open connection to the remote cluster.\nIt does not necessarily mean that the remote cluster is down or unavailable, just that at some point a connection was lost."},"initial_connect_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The initial connect timeout for remote cluster connections."},"skip_unavailable":{"type":"boolean","description":"If `true`, cross-cluster search skips the remote cluster when its nodes are unavailable during the search and ignores errors returned by the remote cluster."},"proxy_address":{"type":"string","description":"The address for remote connections when proxy mode is configured."},"server_name":{"type":"string"},"num_proxy_sockets_connected":{"type":"number","description":"The number of open socket connections to the remote cluster when proxy mode is configured."},"max_proxy_socket_connections":{"type":"number","description":"The maximum number of socket connections to the remote cluster when proxy mode is configured."},"cluster_credentials":{"type":"string","description":"This field is present and has a value of `::es_redacted::` only when the remote cluster is configured with the API key based model. Otherwise, the field is not present."}},"required":["mode","connected","initial_connect_timeout","skip_unavailable","proxy_address","server_name","num_proxy_sockets_connected","max_proxy_socket_connections"]}}}