@elastic/schemas 0.5.1 → 0.6.0

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.nodeattrs","description":"Get node attribute information.\n\nGet information about custom node attributes.\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.","x-api":{"id":"cat.nodeattrs","name":"nodeattrs","namespace":"cat"},"x-method":"GET","x-path":"/_cat/nodeattrs","x-urls":[{"path":"/_cat/nodeattrs","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatNodeattrsColumns","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"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.nodeattrs","description":"Get node attribute information.\n\nGet information about custom node attributes.\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.","x-api":{"id":"cat.nodeattrs","name":"nodeattrs","namespace":"cat"},"x-method":"GET","x-path":"/_cat/nodeattrs","x-urls":[{"path":"/_cat/nodeattrs","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":["text","json"],"type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatNodeattrsColumns","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"},"format":{"type":"string","description":"Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"help":{"type":"boolean","description":"When set to `true` will output available columns. This option\ncan't be combined with any other query string option.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"v":{"type":"boolean","description":"When set to `true` will enable verbose output.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"bytes":{"$ref":"./_types.json#/$defs/_types__Bytes","description":"Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"time":{"$ref":"./_types.json#/$defs/_types__TimeUnit","description":"Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.nodes","description":"Get node information.\n\nGet information about the nodes in a 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 nodes info API.","x-api":{"id":"cat.nodes","name":"nodes","namespace":"cat"},"x-method":"GET","x-path":"/_cat/nodes","x-urls":[{"path":"/_cat/nodes","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"full_id":{"type":"boolean","description":"If `true`, return the full node ID. If `false`, return the shortened node ID.","x-found-in":"query"},"include_unloaded_segments":{"type":"boolean","description":"If true, the response includes information from segments that are not loaded into memory.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatNodeColumns","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"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.","x-found-in":"query"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.nodes","description":"Get node information.\n\nGet information about the nodes in a 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 nodes info API.","x-api":{"id":"cat.nodes","name":"nodes","namespace":"cat"},"x-method":"GET","x-path":"/_cat/nodes","x-urls":[{"path":"/_cat/nodes","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":["text","json"],"type":"object","properties":{"full_id":{"type":"boolean","description":"If `true`, return the full node ID. If `false`, return the shortened node ID.","x-found-in":"query"},"include_unloaded_segments":{"type":"boolean","description":"If true, the response includes information from segments that are not loaded into memory.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatNodeColumns","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"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.","x-found-in":"query"},"format":{"type":"string","description":"Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"help":{"type":"boolean","description":"When set to `true` will output available columns. This option\ncan't be combined with any other query string option.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"v":{"type":"boolean","description":"When set to `true` will enable verbose output.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"bytes":{"$ref":"./_types.json#/$defs/_types__Bytes","description":"Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"time":{"$ref":"./_types.json#/$defs/_types__TimeUnit","description":"Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.pending_tasks","description":"Get pending task information.\n\nGet information about cluster-level changes that have not yet taken effect.\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 pending cluster tasks API.","x-api":{"id":"cat.pending_tasks","name":"pending-tasks","namespace":"cat"},"x-method":"GET","x-path":"/_cat/pending_tasks","x-urls":[{"path":"/_cat/pending_tasks","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatPendingTasksColumns","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"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.pending_tasks","description":"Get pending task information.\n\nGet information about cluster-level changes that have not yet taken effect.\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 pending cluster tasks API.","x-api":{"id":"cat.pending_tasks","name":"pending-tasks","namespace":"cat"},"x-method":"GET","x-path":"/_cat/pending_tasks","x-urls":[{"path":"/_cat/pending_tasks","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":["text","json"],"type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatPendingTasksColumns","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"},"format":{"type":"string","description":"Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"help":{"type":"boolean","description":"When set to `true` will output available columns. This option\ncan't be combined with any other query string option.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"v":{"type":"boolean","description":"When set to `true` will enable verbose output.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"bytes":{"$ref":"./_types.json#/$defs/_types__Bytes","description":"Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"time":{"$ref":"./_types.json#/$defs/_types__TimeUnit","description":"Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.plugins","description":"Get plugin information.\n\nGet a list of plugins running on each node of a 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 nodes info API.","x-api":{"id":"cat.plugins","name":"plugins","namespace":"cat"},"x-method":"GET","x-path":"/_cat/plugins","x-urls":[{"path":"/_cat/plugins","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatPluginsColumns","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"},"include_bootstrap":{"type":"boolean","description":"Include bootstrap plugins in the response","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"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.plugins","description":"Get plugin information.\n\nGet a list of plugins running on each node of a 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 nodes info API.","x-api":{"id":"cat.plugins","name":"plugins","namespace":"cat"},"x-method":"GET","x-path":"/_cat/plugins","x-urls":[{"path":"/_cat/plugins","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":["text","json"],"type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatPluginsColumns","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"},"include_bootstrap":{"type":"boolean","description":"Include bootstrap plugins in the response","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"},"format":{"type":"string","description":"Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"help":{"type":"boolean","description":"When set to `true` will output available columns. This option\ncan't be combined with any other query string option.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"v":{"type":"boolean","description":"When set to `true` will enable verbose output.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"bytes":{"$ref":"./_types.json#/$defs/_types__Bytes","description":"Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"time":{"$ref":"./_types.json#/$defs/_types__TimeUnit","description":"Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.recovery","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.","x-api":{"id":"cat.recovery","name":"recovery","namespace":"cat"},"x-method":"GET","x-path":"/_cat/recovery/{index}","x-urls":[{"path":"/_cat/recovery","methods":["GET"]},{"path":"/_cat/recovery/{index}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","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"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.recovery","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.","x-api":{"id":"cat.recovery","name":"recovery","namespace":"cat"},"x-method":"GET","x-path":"/_cat/recovery/{index}","x-urls":[{"path":"/_cat/recovery","methods":["GET"]},{"path":"/_cat/recovery/{index}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":["text","json"],"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"},"format":{"type":"string","description":"Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"help":{"type":"boolean","description":"When set to `true` will output available columns. This option\ncan't be combined with any other query string option.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"v":{"type":"boolean","description":"When set to `true` will enable verbose output.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"bytes":{"$ref":"./_types.json#/$defs/_types__Bytes","description":"Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"time":{"$ref":"./_types.json#/$defs/_types__TimeUnit","description":"Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.repositories","description":"Get snapshot repository information.\n\nGet a list of snapshot repositories for a 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 repository API.","x-api":{"id":"cat.repositories","name":"repositories","namespace":"cat"},"x-method":"GET","x-path":"/_cat/repositories","x-urls":[{"path":"/_cat/repositories","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"2.1.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"h":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns to appear in the response. 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"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.repositories","description":"Get snapshot repository information.\n\nGet a list of snapshot repositories for a 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 repository API.","x-api":{"id":"cat.repositories","name":"repositories","namespace":"cat"},"x-method":"GET","x-path":"/_cat/repositories","x-urls":[{"path":"/_cat/repositories","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"2.1.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":["text","json"],"type":"object","properties":{"h":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns to appear in the response. 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"},"format":{"type":"string","description":"Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"help":{"type":"boolean","description":"When set to `true` will output available columns. This option\ncan't be combined with any other query string option.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"v":{"type":"boolean","description":"When set to `true` will enable verbose output.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"bytes":{"$ref":"./_types.json#/$defs/_types__Bytes","description":"Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"time":{"$ref":"./_types.json#/$defs/_types__TimeUnit","description":"Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.segments","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.","x-api":{"id":"cat.segments","name":"segments","namespace":"cat"},"x-method":"GET","x-path":"/_cat/segments/{index}","x-urls":[{"path":"/_cat/segments","methods":["GET"]},{"path":"/_cat/segments/{index}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","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"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.segments","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.","x-api":{"id":"cat.segments","name":"segments","namespace":"cat"},"x-method":"GET","x-path":"/_cat/segments/{index}","x-urls":[{"path":"/_cat/segments","methods":["GET"]},{"path":"/_cat/segments/{index}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":["text","json"],"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"},"format":{"type":"string","description":"Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"help":{"type":"boolean","description":"When set to `true` will output available columns. This option\ncan't be combined with any other query string option.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"v":{"type":"boolean","description":"When set to `true` will enable verbose output.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"bytes":{"$ref":"./_types.json#/$defs/_types__Bytes","description":"Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"time":{"$ref":"./_types.json#/$defs/_types__TimeUnit","description":"Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.shards","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.","x-api":{"id":"cat.shards","name":"shards","namespace":"cat"},"x-method":"GET","x-path":"/_cat/shards/{index}","x-urls":[{"path":"/_cat/shards","methods":["GET"]},{"path":"/_cat/shards/{index}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","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"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.shards","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.","x-api":{"id":"cat.shards","name":"shards","namespace":"cat"},"x-method":"GET","x-path":"/_cat/shards/{index}","x-urls":[{"path":"/_cat/shards","methods":["GET"]},{"path":"/_cat/shards/{index}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":["text","json"],"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"},"format":{"type":"string","description":"Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"help":{"type":"boolean","description":"When set to `true` will output available columns. This option\ncan't be combined with any other query string option.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"v":{"type":"boolean","description":"When set to `true` will enable verbose output.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"bytes":{"$ref":"./_types.json#/$defs/_types__Bytes","description":"Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"time":{"$ref":"./_types.json#/$defs/_types__TimeUnit","description":"Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.snapshots","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.","x-api":{"id":"cat.snapshots","name":"snapshots","namespace":"cat"},"x-method":"GET","x-path":"/_cat/snapshots/{repository}","x-urls":[{"path":"/_cat/snapshots","methods":["GET"]},{"path":"/_cat/snapshots/{repository}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"2.1.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","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"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.snapshots","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.","x-api":{"id":"cat.snapshots","name":"snapshots","namespace":"cat"},"x-method":"GET","x-path":"/_cat/snapshots/{repository}","x-urls":[{"path":"/_cat/snapshots","methods":["GET"]},{"path":"/_cat/snapshots/{repository}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"2.1.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":["text","json"],"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"},"format":{"type":"string","description":"Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"help":{"type":"boolean","description":"When set to `true` will output available columns. This option\ncan't be combined with any other query string option.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"v":{"type":"boolean","description":"When set to `true` will enable verbose output.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"bytes":{"$ref":"./_types.json#/$defs/_types__Bytes","description":"Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"time":{"$ref":"./_types.json#/$defs/_types__TimeUnit","description":"Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.tasks","description":"Get task information.\n\nGet information about tasks currently running in the 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 task management API.","x-api":{"id":"cat.tasks","name":"tasks","namespace":"cat"},"x-method":"GET","x-path":"/_cat/tasks","x-urls":[{"path":"/_cat/tasks","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"5.0.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"actions":{"type":"array","items":{"type":"string"},"description":"The task action names, which are used to limit the response.","x-found-in":"query"},"detailed":{"type":"boolean","description":"If `true`, the response includes detailed information about shard recoveries.","x-found-in":"query"},"nodes":{"type":"array","items":{"type":"string"},"description":"Unique node identifiers, which are used to limit the response.","x-found-in":"query"},"parent_task_id":{"type":"string","description":"The parent task identifier, which is used to limit the response.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatTasksColumns","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"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the task has completed.","x-found-in":"query"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.tasks","description":"Get task information.\n\nGet information about tasks currently running in the 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 task management API.","x-api":{"id":"cat.tasks","name":"tasks","namespace":"cat"},"x-method":"GET","x-path":"/_cat/tasks","x-urls":[{"path":"/_cat/tasks","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"5.0.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"private"}},"x-response-type":["text","json"],"type":"object","properties":{"actions":{"type":"array","items":{"type":"string"},"description":"The task action names, which are used to limit the response.","x-found-in":"query"},"detailed":{"type":"boolean","description":"If `true`, the response includes detailed information about shard recoveries.","x-found-in":"query"},"nodes":{"type":"array","items":{"type":"string"},"description":"Unique node identifiers, which are used to limit the response.","x-found-in":"query"},"parent_task_id":{"type":"string","description":"The parent task identifier, which is used to limit the response.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatTasksColumns","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"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the task has completed.","x-found-in":"query"},"format":{"type":"string","description":"Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"help":{"type":"boolean","description":"When set to `true` will output available columns. This option\ncan't be combined with any other query string option.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"v":{"type":"boolean","description":"When set to `true` will enable verbose output.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"bytes":{"$ref":"./_types.json#/$defs/_types__Bytes","description":"Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"time":{"$ref":"./_types.json#/$defs/_types__TimeUnit","description":"Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.templates","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.","x-api":{"id":"cat.templates","name":"templates","namespace":"cat"},"x-method":"GET","x-path":"/_cat/templates/{name}","x-urls":[{"path":"/_cat/templates","methods":["GET"]},{"path":"/_cat/templates/{name}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"5.2.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","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"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.templates","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.","x-api":{"id":"cat.templates","name":"templates","namespace":"cat"},"x-method":"GET","x-path":"/_cat/templates/{name}","x-urls":[{"path":"/_cat/templates","methods":["GET"]},{"path":"/_cat/templates/{name}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"5.2.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":["text","json"],"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"},"format":{"type":"string","description":"Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"help":{"type":"boolean","description":"When set to `true` will output available columns. This option\ncan't be combined with any other query string option.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"v":{"type":"boolean","description":"When set to `true` will enable verbose output.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"bytes":{"$ref":"./_types.json#/$defs/_types__Bytes","description":"Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"time":{"$ref":"./_types.json#/$defs/_types__TimeUnit","description":"Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.thread_pool","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.","x-api":{"id":"cat.thread_pool","name":"thread-pool","namespace":"cat"},"x-method":"GET","x-path":"/_cat/thread_pool/{thread_pool_patterns}","x-urls":[{"path":"/_cat/thread_pool","methods":["GET"]},{"path":"/_cat/thread_pool/{thread_pool_patterns}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","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"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.thread_pool","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.","x-api":{"id":"cat.thread_pool","name":"thread-pool","namespace":"cat"},"x-method":"GET","x-path":"/_cat/thread_pool/{thread_pool_patterns}","x-urls":[{"path":"/_cat/thread_pool","methods":["GET"]},{"path":"/_cat/thread_pool/{thread_pool_patterns}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":["text","json"],"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"},"format":{"type":"string","description":"Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"help":{"type":"boolean","description":"When set to `true` will output available columns. This option\ncan't be combined with any other query string option.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"v":{"type":"boolean","description":"When set to `true` will enable verbose output.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"bytes":{"$ref":"./_types.json#/$defs/_types__Bytes","description":"Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"time":{"$ref":"./_types.json#/$defs/_types__TimeUnit","description":"Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.transforms","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.","x-api":{"id":"cat.transforms","name":"transforms","namespace":"cat"},"x-method":"GET","x-path":"/_cat/transforms/{transform_id}","x-urls":[{"path":"/_cat/transforms","methods":["GET"]},{"path":"/_cat/transforms/{transform_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.7.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-response-type":"text","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"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.transforms","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.","x-api":{"id":"cat.transforms","name":"transforms","namespace":"cat"},"x-method":"GET","x-path":"/_cat/transforms/{transform_id}","x-urls":[{"path":"/_cat/transforms","methods":["GET"]},{"path":"/_cat/transforms/{transform_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.7.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-response-type":["text","json"],"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"},"format":{"type":"string","description":"Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"help":{"type":"boolean","description":"When set to `true` will output available columns. This option\ncan't be combined with any other query string option.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"v":{"type":"boolean","description":"When set to `true` will enable verbose output.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"bytes":{"$ref":"./_types.json#/$defs/_types__Bytes","description":"Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"time":{"$ref":"./_types.json#/$defs/_types__TimeUnit","description":"Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.","x-found-in":"query","x-behavior":"CommonCatQueryParameters"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

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

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

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

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

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

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

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

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

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

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

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

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

package/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","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.","x-api":{"id":"ccr.put_auto_follow_pattern","name":"put-auto-follow-pattern","namespace":"ccr"},"x-method":"PUT","x-path":"/_ccr/auto_follow/{name}","x-urls":[{"path":"/_ccr/auto_follow/{name}","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.5.0","stability":"stable"}},"type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","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"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.put_auto_follow_pattern","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.","x-api":{"id":"ccr.put_auto_follow_pattern","name":"put-auto-follow-pattern","namespace":"ccr"},"x-method":"PUT","x-path":"/_ccr/auto_follow/{name}","x-urls":[{"path":"/_ccr/auto_follow/{name}","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.5.0","stability":"stable"}},"type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","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"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["name","remote_cluster"]}

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

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

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

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.stats","description":"Get cross-cluster replication stats.\n\nThis API returns stats about auto-following and the same shard-level stats as the get follower stats API.","x-api":{"id":"ccr.stats","name":"stats","namespace":"ccr"},"x-method":"GET","x-path":"/_ccr/stats","x-urls":[{"path":"/_ccr/stats","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"6.5.0","stability":"stable"}},"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"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The 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"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.stats","description":"Get cross-cluster replication stats.\n\nThis API returns stats about auto-following and the same shard-level stats as the get follower stats API.","x-api":{"id":"ccr.stats","name":"stats","namespace":"ccr"},"x-method":"GET","x-path":"/_ccr/stats","x-urls":[{"path":"/_ccr/stats","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"6.5.0","stability":"stable"}},"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"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The 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"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}