@elastic/schemas 0.5.1 → 0.6.0

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.indices", "description": "Get index information.\n\nGet high-level information about indices in a cluster, including backing indices for data streams.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.\n\nNOTE: Storage metrics reported by this API reflect the post-compression size of the indices on disk. Because these values are calculated after Elasticsearch compresses the data and processes deletions, they are typically significantly smaller than the raw, uncompressed data volume ingested.\n\nIMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw, uncompressed data volume, not the post-compression metrics reported here. To learn more, refer to [Elasticsearch billing dimensions](https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions).\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.", "x-api": { "id": "cat.indices", "name": "indices", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/indices/{index}", "x-urls": [{ "path": "/_cat/indices", "methods": ["GET"] }, { "path": "/_cat/indices/{index}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "x-response-type": "text", "type": "object", "properties": { "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "The type of index that wildcard patterns can match.", "x-found-in": "query" }, "health": { "$ref": "./_types.json#/$defs/_types__HealthStatus", "description": "The health status used to limit returned indices. By default, the response includes indices of any health status.", "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" }, "pri": { "type": "boolean", "description": "If true, the response only includes information from primary shards.", "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" }, "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatIndicesColumns", "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" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "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" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.indices", "description": "Get index information.\n\nGet high-level information about indices in a cluster, including backing indices for data streams.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.\n\nNOTE: Storage metrics reported by this API reflect the post-compression size of the indices on disk. Because these values are calculated after Elasticsearch compresses the data and processes deletions, they are typically significantly smaller than the raw, uncompressed data volume ingested.\n\nIMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw, uncompressed data volume, not the post-compression metrics reported here. To learn more, refer to [Elasticsearch billing dimensions](https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions).\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.", "x-api": { "id": "cat.indices", "name": "indices", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/indices/{index}", "x-urls": [{ "path": "/_cat/indices", "methods": ["GET"] }, { "path": "/_cat/indices/{index}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "x-response-type": ["text", "json"], "type": "object", "properties": { "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "The type of index that wildcard patterns can match.", "x-found-in": "query" }, "health": { "$ref": "./_types.json#/$defs/_types__HealthStatus", "description": "The health status used to limit returned indices. By default, the response includes indices of any health status.", "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" }, "pri": { "type": "boolean", "description": "If true, the response only includes information from primary shards.", "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" }, "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatIndicesColumns", "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" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "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" }, "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/lib/es/json/cat.master.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.master", "description": "Get master node information.\n\nGet information about the master node, including the ID, bound IP address, and name.\n\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.master", "name": "master", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/master", "x-urls": [{ "path": "/_cat/master", "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__CatMasterColumns", "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.master", "description": "Get master node information.\n\nGet information about the master node, including the ID, bound IP address, and name.\n\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.master", "name": "master", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/master", "x-urls": [{ "path": "/_cat/master", "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__CatMasterColumns", "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/lib/es/json/cat.ml_data_frame_analytics.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.ml_data_frame_analytics", "description": "Get data frame analytics jobs.\n\nGet configuration and usage information about data frame analytics jobs.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", "x-api": { "id": "cat.ml_data_frame_analytics", "name": "ml-data-frame-analytics", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/ml/data_frame/analytics/{id}", "x-urls": [{ "path": "/_cat/ml/data_frame/analytics", "methods": ["GET"] }, { "path": "/_cat/ml/data_frame/analytics/{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": "Whether to ignore if a wildcard expression matches no configs.\n(This includes `_all` string or when no configs have been specified.)", "x-found-in": "query" }, "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatDfaColumns", "description": "Comma-separated list of column names to display.", "x-found-in": "query" }, "s": { "$ref": "./cat._types.json#/$defs/cat._types__CatDfaColumns", "description": "Comma-separated list of column names or column aliases used to sort the\nresponse.", "x-found-in": "query" }, "id": { "type": "string", "description": "The ID of the data frame analytics to fetch", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.ml_data_frame_analytics", "description": "Get data frame analytics jobs.\n\nGet configuration and usage information about data frame analytics jobs.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", "x-api": { "id": "cat.ml_data_frame_analytics", "name": "ml-data-frame-analytics", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/ml/data_frame/analytics/{id}", "x-urls": [{ "path": "/_cat/ml/data_frame/analytics", "methods": ["GET"] }, { "path": "/_cat/ml/data_frame/analytics/{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": "Whether to ignore if a wildcard expression matches no configs.\n(This includes `_all` string or when no configs have been specified.)", "x-found-in": "query" }, "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatDfaColumns", "description": "Comma-separated list of column names to display.", "x-found-in": "query" }, "s": { "$ref": "./cat._types.json#/$defs/cat._types__CatDfaColumns", "description": "Comma-separated list of column names or column aliases used to sort the\nresponse.", "x-found-in": "query" }, "id": { "type": "string", "description": "The ID of the data frame analytics to fetch", "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/lib/es/json/cat.ml_datafeeds.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.ml_datafeeds", "description": "Get datafeeds.\n\nGet configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", "x-api": { "id": "cat.ml_datafeeds", "name": "ml-datafeeds", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/ml/datafeeds/{datafeed_id}", "x-urls": [{ "path": "/_cat/ml/datafeeds", "methods": ["GET"] }, { "path": "/_cat/ml/datafeeds/{datafeed_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:\n\n* Contains wildcard expressions and there are no datafeeds that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when\nthere are partial matches. If `false`, the API returns a 404 status code when there are no matches or only\npartial matches.", "x-found-in": "query" }, "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatDatafeedColumns", "description": "Comma-separated list of column names to display.", "x-found-in": "query" }, "s": { "$ref": "./cat._types.json#/$defs/cat._types__CatDatafeedColumns", "description": "Comma-separated list of column names or column aliases used to sort the response.", "x-found-in": "query" }, "datafeed_id": { "type": "string", "description": "A numerical character string that uniquely identifies the datafeed.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.ml_datafeeds", "description": "Get datafeeds.\n\nGet configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", "x-api": { "id": "cat.ml_datafeeds", "name": "ml-datafeeds", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/ml/datafeeds/{datafeed_id}", "x-urls": [{ "path": "/_cat/ml/datafeeds", "methods": ["GET"] }, { "path": "/_cat/ml/datafeeds/{datafeed_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:\n\n* Contains wildcard expressions and there are no datafeeds that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when\nthere are partial matches. If `false`, the API returns a 404 status code when there are no matches or only\npartial matches.", "x-found-in": "query" }, "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatDatafeedColumns", "description": "Comma-separated list of column names to display.", "x-found-in": "query" }, "s": { "$ref": "./cat._types.json#/$defs/cat._types__CatDatafeedColumns", "description": "Comma-separated list of column names or column aliases used to sort the response.", "x-found-in": "query" }, "datafeed_id": { "type": "string", "description": "A numerical character string that uniquely identifies the datafeed.", "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/lib/es/json/cat.ml_jobs.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.ml_jobs", "description": "Get anomaly detection jobs.\n\nGet configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", "x-api": { "id": "cat.ml_jobs", "name": "ml-jobs", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/ml/anomaly_detectors/{job_id}", "x-urls": [{ "path": "/_cat/ml/anomaly_detectors", "methods": ["GET"] }, { "path": "/_cat/ml/anomaly_detectors/{job_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:\n\n* Contains wildcard expressions and there are no jobs that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty jobs array when there are no matches and the subset of results when there\nare partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial\nmatches.", "x-found-in": "query" }, "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatAnomalyDetectorColumns", "description": "Comma-separated list of column names to display.", "x-found-in": "query" }, "s": { "$ref": "./cat._types.json#/$defs/cat._types__CatAnomalyDetectorColumns", "description": "Comma-separated list of column names or column aliases used to sort the response.", "x-found-in": "query" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.ml_jobs", "description": "Get anomaly detection jobs.\n\nGet configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", "x-api": { "id": "cat.ml_jobs", "name": "ml-jobs", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/ml/anomaly_detectors/{job_id}", "x-urls": [{ "path": "/_cat/ml/anomaly_detectors", "methods": ["GET"] }, { "path": "/_cat/ml/anomaly_detectors/{job_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:\n\n* Contains wildcard expressions and there are no jobs that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty jobs array when there are no matches and the subset of results when there\nare partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial\nmatches.", "x-found-in": "query" }, "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatAnomalyDetectorColumns", "description": "Comma-separated list of column names to display.", "x-found-in": "query" }, "s": { "$ref": "./cat._types.json#/$defs/cat._types__CatAnomalyDetectorColumns", "description": "Comma-separated list of column names or column aliases used to sort the response.", "x-found-in": "query" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "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/lib/es/json/cat.ml_trained_models.request.json

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