diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index cb98f10a60..cbd586d2a5 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -915,6 +915,12 @@ "description": "Get the cluster's index aliases, including filter and routing information.\nThis API does not return data stream aliases.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.", "operationId": "cat-aliases", "parameters": [ + { + "$ref": "#/components/parameters/cat.aliases#h" + }, + { + "$ref": "#/components/parameters/cat.aliases#s" + }, { "$ref": "#/components/parameters/cat.aliases#expand_wildcards" }, @@ -941,6 +947,12 @@ { "$ref": "#/components/parameters/cat.aliases#name" }, + { + "$ref": "#/components/parameters/cat.aliases#h" + }, + { + "$ref": "#/components/parameters/cat.aliases#s" + }, { "$ref": "#/components/parameters/cat.aliases#expand_wildcards" }, @@ -967,6 +979,12 @@ { "$ref": "#/components/parameters/cat.allocation#bytes" }, + { + "$ref": "#/components/parameters/cat.allocation#h" + }, + { + "$ref": "#/components/parameters/cat.allocation#s" + }, { "$ref": "#/components/parameters/cat.allocation#local" }, @@ -996,6 +1014,12 @@ { "$ref": "#/components/parameters/cat.allocation#bytes" }, + { + "$ref": "#/components/parameters/cat.allocation#h" + }, + { + "$ref": "#/components/parameters/cat.allocation#s" + }, { "$ref": "#/components/parameters/cat.allocation#local" }, @@ -1019,6 +1043,12 @@ "description": "Get information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nIMPORTANT: CAT 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 the get component template API.", "operationId": "cat-component-templates", "parameters": [ + { + "$ref": "#/components/parameters/cat.component_templates#h" + }, + { + "$ref": "#/components/parameters/cat.component_templates#s" + }, { "$ref": "#/components/parameters/cat.component_templates#local" }, @@ -1046,6 +1076,12 @@ { "$ref": "#/components/parameters/cat.component_templates#name" }, + { + "$ref": "#/components/parameters/cat.component_templates#h" + }, + { + "$ref": "#/components/parameters/cat.component_templates#s" + }, { "$ref": "#/components/parameters/cat.component_templates#local" }, @@ -1069,6 +1105,14 @@ "summary": "Get a document count", "description": "Get quick access to a document count for a data stream, an index, or an entire cluster.\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n\nIMPORTANT: CAT 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 the count API.", "operationId": "cat-count", + "parameters": [ + { + "$ref": "#/components/parameters/cat.count#h" + }, + { + "$ref": "#/components/parameters/cat.count#s" + } + ], "responses": { "200": { "$ref": "#/components/responses/cat.count#200" @@ -1087,6 +1131,12 @@ "parameters": [ { "$ref": "#/components/parameters/cat.count#index" + }, + { + "$ref": "#/components/parameters/cat.count#h" + }, + { + "$ref": "#/components/parameters/cat.count#s" } ], "responses": { @@ -1110,6 +1160,12 @@ }, { "$ref": "#/components/parameters/cat.fielddata#fields_" + }, + { + "$ref": "#/components/parameters/cat.fielddata#h" + }, + { + "$ref": "#/components/parameters/cat.fielddata#s" } ], "responses": { @@ -1136,6 +1192,12 @@ }, { "$ref": "#/components/parameters/cat.fielddata#fields_" + }, + { + "$ref": "#/components/parameters/cat.fielddata#h" + }, + { + "$ref": "#/components/parameters/cat.fielddata#s" } ], "responses": { @@ -1173,6 +1235,26 @@ "type": "boolean" }, "style": "form" + }, + { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" } ], "responses": { @@ -1243,6 +1325,12 @@ }, { "$ref": "#/components/parameters/cat.indices#master_timeout" + }, + { + "$ref": "#/components/parameters/cat.indices#h" + }, + { + "$ref": "#/components/parameters/cat.indices#s" } ], "responses": { @@ -1284,6 +1372,12 @@ }, { "$ref": "#/components/parameters/cat.indices#master_timeout" + }, + { + "$ref": "#/components/parameters/cat.indices#h" + }, + { + "$ref": "#/components/parameters/cat.indices#s" } ], "responses": { @@ -1302,6 +1396,26 @@ "description": "Get 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.", "operationId": "cat-master", "parameters": [ + { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, { "in": "query", "name": "local", @@ -1631,6 +1745,26 @@ "description": "Get 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.", "operationId": "cat-nodeattrs", "parameters": [ + { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, { "in": "query", "name": "local", @@ -1715,6 +1849,26 @@ }, "style": "form" }, + { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, { "in": "query", "name": "master_timeout", @@ -1762,6 +1916,26 @@ "description": "Get 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.", "operationId": "cat-pending-tasks", "parameters": [ + { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, { "in": "query", "name": "local", @@ -1819,6 +1993,26 @@ "description": "Get 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.", "operationId": "cat-plugins", "parameters": [ + { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, { "in": "query", "name": "include_bootstrap", @@ -1885,6 +2079,12 @@ { "$ref": "#/components/parameters/cat.recovery#detailed" }, + { + "$ref": "#/components/parameters/cat.recovery#h" + }, + { + "$ref": "#/components/parameters/cat.recovery#s" + }, { "$ref": "#/components/parameters/cat.recovery#time" } @@ -1917,6 +2117,12 @@ { "$ref": "#/components/parameters/cat.recovery#detailed" }, + { + "$ref": "#/components/parameters/cat.recovery#h" + }, + { + "$ref": "#/components/parameters/cat.recovery#s" + }, { "$ref": "#/components/parameters/cat.recovery#time" } @@ -1937,6 +2143,26 @@ "description": "Get 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.", "operationId": "cat-repositories", "parameters": [ + { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, { "in": "query", "name": "local", @@ -1988,6 +2214,12 @@ { "$ref": "#/components/parameters/cat.segments#bytes" }, + { + "$ref": "#/components/parameters/cat.segments#h" + }, + { + "$ref": "#/components/parameters/cat.segments#s" + }, { "$ref": "#/components/parameters/cat.segments#local" }, @@ -2017,6 +2249,12 @@ { "$ref": "#/components/parameters/cat.segments#bytes" }, + { + "$ref": "#/components/parameters/cat.segments#h" + }, + { + "$ref": "#/components/parameters/cat.segments#s" + }, { "$ref": "#/components/parameters/cat.segments#local" }, @@ -2043,6 +2281,12 @@ { "$ref": "#/components/parameters/cat.shards#bytes" }, + { + "$ref": "#/components/parameters/cat.shards#h" + }, + { + "$ref": "#/components/parameters/cat.shards#s" + }, { "$ref": "#/components/parameters/cat.shards#master_timeout" }, @@ -2072,6 +2316,12 @@ { "$ref": "#/components/parameters/cat.shards#bytes" }, + { + "$ref": "#/components/parameters/cat.shards#h" + }, + { + "$ref": "#/components/parameters/cat.shards#s" + }, { "$ref": "#/components/parameters/cat.shards#master_timeout" }, @@ -2098,6 +2348,12 @@ { "$ref": "#/components/parameters/cat.snapshots#ignore_unavailable" }, + { + "$ref": "#/components/parameters/cat.snapshots#h" + }, + { + "$ref": "#/components/parameters/cat.snapshots#s" + }, { "$ref": "#/components/parameters/cat.snapshots#master_timeout" }, @@ -2128,6 +2384,12 @@ { "$ref": "#/components/parameters/cat.snapshots#ignore_unavailable" }, + { + "$ref": "#/components/parameters/cat.snapshots#h" + }, + { + "$ref": "#/components/parameters/cat.snapshots#s" + }, { "$ref": "#/components/parameters/cat.snapshots#master_timeout" }, @@ -2198,6 +2460,26 @@ }, "style": "form" }, + { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, { "in": "query", "name": "time", @@ -2256,6 +2538,12 @@ "description": "Get 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.", "operationId": "cat-templates", "parameters": [ + { + "$ref": "#/components/parameters/cat.templates#h" + }, + { + "$ref": "#/components/parameters/cat.templates#s" + }, { "$ref": "#/components/parameters/cat.templates#local" }, @@ -2283,6 +2571,12 @@ { "$ref": "#/components/parameters/cat.templates#name" }, + { + "$ref": "#/components/parameters/cat.templates#h" + }, + { + "$ref": "#/components/parameters/cat.templates#s" + }, { "$ref": "#/components/parameters/cat.templates#local" }, @@ -2307,6 +2601,12 @@ "description": "Get 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.", "operationId": "cat-thread-pool", "parameters": [ + { + "$ref": "#/components/parameters/cat.thread_pool#h" + }, + { + "$ref": "#/components/parameters/cat.thread_pool#s" + }, { "$ref": "#/components/parameters/cat.thread_pool#time" }, @@ -2336,6 +2636,12 @@ { "$ref": "#/components/parameters/cat.thread_pool#thread_pool_patterns" }, + { + "$ref": "#/components/parameters/cat.thread_pool#h" + }, + { + "$ref": "#/components/parameters/cat.thread_pool#s" + }, { "$ref": "#/components/parameters/cat.thread_pool#time" }, @@ -98897,6 +99203,26 @@ }, "style": "simple" }, + "cat.aliases#h": { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + "cat.aliases#s": { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, "cat.aliases#expand_wildcards": { "in": "query", "name": "expand_wildcards", @@ -98938,6 +99264,26 @@ }, "style": "form" }, + "cat.allocation#h": { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + "cat.allocation#s": { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, "cat.allocation#local": { "in": "query", "name": "local", @@ -98969,6 +99315,26 @@ }, "style": "simple" }, + "cat.component_templates#h": { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + "cat.component_templates#s": { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, "cat.component_templates#local": { "in": "query", "name": "local", @@ -99000,6 +99366,26 @@ }, "style": "simple" }, + "cat.count#h": { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + "cat.count#s": { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, "cat.fielddata#fields": { "in": "path", "name": "fields", @@ -99031,6 +99417,26 @@ }, "style": "form" }, + "cat.fielddata#h": { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + "cat.fielddata#s": { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, "cat.indices#index": { "in": "path", "name": "index", @@ -99112,6 +99518,26 @@ }, "style": "form" }, + "cat.indices#h": { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + "cat.indices#s": { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, "cat.ml_data_frame_analytics#id": { "in": "path", "name": "id", @@ -99407,6 +99833,26 @@ }, "style": "form" }, + "cat.recovery#h": { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + "cat.recovery#s": { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, "cat.recovery#time": { "in": "query", "name": "time", @@ -99438,6 +99884,26 @@ }, "style": "form" }, + "cat.segments#h": { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + "cat.segments#s": { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, "cat.segments#local": { "in": "query", "name": "local", @@ -99479,6 +99945,26 @@ }, "style": "form" }, + "cat.shards#h": { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + "cat.shards#s": { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, "cat.shards#master_timeout": { "in": "query", "name": "master_timeout", @@ -99520,6 +100006,26 @@ }, "style": "form" }, + "cat.snapshots#h": { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + "cat.snapshots#s": { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, "cat.snapshots#master_timeout": { "in": "query", "name": "master_timeout", @@ -99551,6 +100057,26 @@ }, "style": "simple" }, + "cat.templates#h": { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + "cat.templates#s": { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, "cat.templates#local": { "in": "query", "name": "local", @@ -99582,6 +100108,26 @@ }, "style": "simple" }, + "cat.thread_pool#h": { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + "cat.thread_pool#s": { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, "cat.thread_pool#time": { "in": "query", "name": "time", diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 3ad1d08a6f..fb602e518e 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -693,6 +693,12 @@ "description": "Get the cluster's index aliases, including filter and routing information.\nThis API does not return data stream aliases.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.", "operationId": "cat-aliases", "parameters": [ + { + "$ref": "#/components/parameters/cat.aliases#h" + }, + { + "$ref": "#/components/parameters/cat.aliases#s" + }, { "$ref": "#/components/parameters/cat.aliases#expand_wildcards" }, @@ -719,6 +725,12 @@ { "$ref": "#/components/parameters/cat.aliases#name" }, + { + "$ref": "#/components/parameters/cat.aliases#h" + }, + { + "$ref": "#/components/parameters/cat.aliases#s" + }, { "$ref": "#/components/parameters/cat.aliases#expand_wildcards" }, @@ -742,6 +754,12 @@ "description": "Get information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nIMPORTANT: CAT 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 the get component template API.", "operationId": "cat-component-templates", "parameters": [ + { + "$ref": "#/components/parameters/cat.component_templates#h" + }, + { + "$ref": "#/components/parameters/cat.component_templates#s" + }, { "$ref": "#/components/parameters/cat.component_templates#local" }, @@ -769,6 +787,12 @@ { "$ref": "#/components/parameters/cat.component_templates#name" }, + { + "$ref": "#/components/parameters/cat.component_templates#h" + }, + { + "$ref": "#/components/parameters/cat.component_templates#s" + }, { "$ref": "#/components/parameters/cat.component_templates#local" }, @@ -792,6 +816,14 @@ "summary": "Get a document count", "description": "Get quick access to a document count for a data stream, an index, or an entire cluster.\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n\nIMPORTANT: CAT 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 the count API.", "operationId": "cat-count", + "parameters": [ + { + "$ref": "#/components/parameters/cat.count#h" + }, + { + "$ref": "#/components/parameters/cat.count#s" + } + ], "responses": { "200": { "$ref": "#/components/responses/cat.count#200" @@ -810,6 +842,12 @@ "parameters": [ { "$ref": "#/components/parameters/cat.count#index" + }, + { + "$ref": "#/components/parameters/cat.count#h" + }, + { + "$ref": "#/components/parameters/cat.count#s" } ], "responses": { @@ -870,6 +908,12 @@ }, { "$ref": "#/components/parameters/cat.indices#master_timeout" + }, + { + "$ref": "#/components/parameters/cat.indices#h" + }, + { + "$ref": "#/components/parameters/cat.indices#s" } ], "responses": { @@ -911,6 +955,12 @@ }, { "$ref": "#/components/parameters/cat.indices#master_timeout" + }, + { + "$ref": "#/components/parameters/cat.indices#h" + }, + { + "$ref": "#/components/parameters/cat.indices#s" } ], "responses": { @@ -58735,6 +58785,26 @@ }, "style": "simple" }, + "cat.aliases#h": { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + "cat.aliases#s": { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, "cat.aliases#expand_wildcards": { "in": "query", "name": "expand_wildcards", @@ -58766,6 +58836,26 @@ }, "style": "simple" }, + "cat.component_templates#h": { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + "cat.component_templates#s": { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, "cat.component_templates#local": { "in": "query", "name": "local", @@ -58797,6 +58887,26 @@ }, "style": "simple" }, + "cat.count#h": { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + "cat.count#s": { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, "cat.indices#index": { "in": "path", "name": "index", @@ -58878,6 +58988,26 @@ }, "style": "form" }, + "cat.indices#h": { + "in": "query", + "name": "h", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + "cat.indices#s": { + "in": "query", + "name": "s", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, "cat.ml_data_frame_analytics#id": { "in": "path", "name": "id", diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 2d278bfa30..e7a74a720c 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -12226,6 +12226,30 @@ } ], "query": [ + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "description": "The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.", "name": "expand_wildcards", @@ -12252,7 +12276,7 @@ } } ], - "specLocation": "cat/aliases/CatAliasesRequest.ts#L24-L67" + "specLocation": "cat/aliases/CatAliasesRequest.ts#L24-L77" }, { "body": { @@ -12310,6 +12334,30 @@ } ], "query": [ + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "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.", "name": "local", @@ -12337,7 +12385,7 @@ } } ], - "specLocation": "cat/component_templates/CatComponentTemplatesRequest.ts#L23-L70" + "specLocation": "cat/component_templates/CatComponentTemplatesRequest.ts#L24-L81" }, { "body": { @@ -12394,8 +12442,33 @@ } } ], - "query": [], - "specLocation": "cat/count/CatCountRequest.ts#L23-L56" + "query": [ + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + } + ], + "specLocation": "cat/count/CatCountRequest.ts#L23-L68" }, { "body": { @@ -12565,9 +12638,33 @@ "namespace": "_types" } } + }, + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } } ], - "specLocation": "cat/indices/CatIndicesRequest.ts#L24-L93" + "specLocation": "cat/indices/CatIndicesRequest.ts#L30-L109" }, { "body": { @@ -110282,18 +110379,6 @@ } } }, - { - "description": "List of columns to appear in the response. Supports simple wildcards.", - "name": "h", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Names", - "namespace": "_types" - } - } - }, { "description": "When set to `true` will output available columns. This option\ncan't be combined with any other query string option.", "name": "help", @@ -110307,18 +110392,6 @@ } } }, - { - "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.", - "name": "s", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Names", - "namespace": "_types" - } - } - }, { "description": "When set to `true` will enable verbose output.", "name": "v", @@ -110333,7 +110406,7 @@ } } ], - "specLocation": "_spec_utils/behaviors.ts#L85-L118" + "specLocation": "_spec_utils/behaviors.ts#L85-L108" }, { "kind": "interface", @@ -140178,7 +140251,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L120-L126" + "specLocation": "_spec_utils/behaviors.ts#L110-L116" }, { "attachedBehaviors": [ diff --git a/output/schema/schema.json b/output/schema/schema.json index 859f6cd5c3..6b8b45a9fc 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -93433,6 +93433,30 @@ } ], "query": [ + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "description": "The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.", "name": "expand_wildcards", @@ -93459,7 +93483,7 @@ } } ], - "specLocation": "cat/aliases/CatAliasesRequest.ts#L24-L67" + "specLocation": "cat/aliases/CatAliasesRequest.ts#L24-L77" }, { "kind": "response", @@ -93878,6 +93902,30 @@ } } }, + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "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.", "name": "local", @@ -93905,7 +93953,7 @@ } } ], - "specLocation": "cat/allocation/CatAllocationRequest.ts#L24-L68" + "specLocation": "cat/allocation/CatAllocationRequest.ts#L24-L78" }, { "kind": "response", @@ -94062,6 +94110,30 @@ } ], "query": [ + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "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.", "name": "local", @@ -94089,7 +94161,7 @@ } } ], - "specLocation": "cat/component_templates/CatComponentTemplatesRequest.ts#L23-L70" + "specLocation": "cat/component_templates/CatComponentTemplatesRequest.ts#L24-L81" }, { "kind": "response", @@ -94224,8 +94296,33 @@ } } ], - "query": [], - "specLocation": "cat/count/CatCountRequest.ts#L23-L56" + "query": [ + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + } + ], + "specLocation": "cat/count/CatCountRequest.ts#L23-L68" }, { "kind": "response", @@ -94397,9 +94494,33 @@ "namespace": "_types" } } + }, + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } } ], - "specLocation": "cat/fielddata/CatFielddataRequest.ts#L23-L60" + "specLocation": "cat/fielddata/CatFielddataRequest.ts#L23-L70" }, { "kind": "response", @@ -94741,9 +94862,33 @@ "namespace": "_builtins" } } + }, + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } } ], - "specLocation": "cat/health/CatHealthRequest.ts#L23-L59" + "specLocation": "cat/health/CatHealthRequest.ts#L24-L70" }, { "kind": "response", @@ -96995,9 +97140,33 @@ "namespace": "_types" } } + }, + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } } ], - "specLocation": "cat/indices/CatIndicesRequest.ts#L24-L93" + "specLocation": "cat/indices/CatIndicesRequest.ts#L30-L109" }, { "kind": "response", @@ -97106,6 +97275,30 @@ }, "path": [], "query": [ + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "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.", "name": "local", @@ -97133,7 +97326,7 @@ } } ], - "specLocation": "cat/master/CatMasterRequest.ts#L23-L57" + "specLocation": "cat/master/CatMasterRequest.ts#L24-L68" }, { "kind": "response", @@ -99490,6 +99683,30 @@ }, "path": [], "query": [ + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "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.", "name": "local", @@ -99517,7 +99734,7 @@ } } ], - "specLocation": "cat/nodeattrs/CatNodeAttributesRequest.ts#L23-L56" + "specLocation": "cat/nodeattrs/CatNodeAttributesRequest.ts#L24-L67" }, { "kind": "response", @@ -101127,6 +101344,30 @@ } } }, + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "description": "Period to wait for a connection to the master node.", "name": "master_timeout", @@ -101153,7 +101394,7 @@ } } ], - "specLocation": "cat/nodes/CatNodesRequest.ts#L24-L67" + "specLocation": "cat/nodes/CatNodesRequest.ts#L24-L77" }, { "kind": "response", @@ -101268,6 +101509,30 @@ }, "path": [], "query": [ + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "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.", "name": "local", @@ -101307,7 +101572,7 @@ } } ], - "specLocation": "cat/pending_tasks/CatPendingTasksRequest.ts#L23-L60" + "specLocation": "cat/pending_tasks/CatPendingTasksRequest.ts#L24-L71" }, { "kind": "response", @@ -101449,6 +101714,30 @@ }, "path": [], "query": [ + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "description": "Include bootstrap plugins in the response", "name": "include_bootstrap", @@ -101489,7 +101778,7 @@ } } ], - "specLocation": "cat/plugins/CatPluginsRequest.ts#L23-L61" + "specLocation": "cat/plugins/CatPluginsRequest.ts#L24-L72" }, { "kind": "response", @@ -102006,6 +102295,30 @@ } } }, + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "description": "Unit used to display time values.", "name": "time", @@ -102019,7 +102332,7 @@ } } ], - "specLocation": "cat/recovery/CatRecoveryRequest.ts#L24-L76" + "specLocation": "cat/recovery/CatRecoveryRequest.ts#L24-L86" }, { "kind": "response", @@ -102104,6 +102417,30 @@ }, "path": [], "query": [ + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "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.", "name": "local", @@ -102131,7 +102468,7 @@ } } ], - "specLocation": "cat/repositories/CatRepositoriesRequest.ts#L23-L56" + "specLocation": "cat/repositories/CatRepositoriesRequest.ts#L24-L67" }, { "kind": "response", @@ -102201,6 +102538,30 @@ } } }, + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "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.", "name": "local", @@ -102228,7 +102589,7 @@ } } ], - "specLocation": "cat/segments/CatSegmentsRequest.ts#L24-L75" + "specLocation": "cat/segments/CatSegmentsRequest.ts#L24-L85" }, { "kind": "response", @@ -102538,6 +102899,30 @@ } } }, + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "description": "Period to wait for a connection to the master node.", "name": "master_timeout", @@ -102564,7 +102949,7 @@ } } ], - "specLocation": "cat/shards/CatShardsRequest.ts#L24-L71" + "specLocation": "cat/shards/CatShardsRequest.ts#L24-L81" }, { "kind": "response", @@ -103916,6 +104301,30 @@ } } }, + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "description": "Period to wait for a connection to the master node.", "name": "master_timeout", @@ -103942,7 +104351,7 @@ } } ], - "specLocation": "cat/snapshots/CatSnapshotsRequest.ts#L24-L72" + "specLocation": "cat/snapshots/CatSnapshotsRequest.ts#L24-L82" }, { "kind": "response", @@ -104288,6 +104697,30 @@ } } }, + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "description": "Unit used to display time values.", "name": "time", @@ -104327,7 +104760,7 @@ } } ], - "specLocation": "cat/tasks/CatTasksRequest.ts#L23-L71" + "specLocation": "cat/tasks/CatTasksRequest.ts#L24-L82" }, { "kind": "response", @@ -104631,6 +105064,30 @@ } ], "query": [ + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "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.", "name": "local", @@ -104658,7 +105115,7 @@ } } ], - "specLocation": "cat/templates/CatTemplatesRequest.ts#L24-L69" + "specLocation": "cat/templates/CatTemplatesRequest.ts#L24-L79" }, { "kind": "response", @@ -104814,6 +105271,30 @@ } ], "query": [ + { + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, { "description": "The unit used to display time values.", "name": "time", @@ -104853,7 +105334,7 @@ } } ], - "specLocation": "cat/thread_pool/CatThreadPoolRequest.ts#L24-L73" + "specLocation": "cat/thread_pool/CatThreadPoolRequest.ts#L24-L83" }, { "kind": "response", @@ -233080,18 +233561,6 @@ } } }, - { - "description": "List of columns to appear in the response. Supports simple wildcards.", - "name": "h", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Names", - "namespace": "_types" - } - } - }, { "description": "When set to `true` will output available columns. This option\ncan't be combined with any other query string option.", "name": "help", @@ -233105,18 +233574,6 @@ } } }, - { - "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.", - "name": "s", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Names", - "namespace": "_types" - } - } - }, { "description": "When set to `true` will enable verbose output.", "name": "v", @@ -233131,7 +233588,7 @@ } } ], - "specLocation": "_spec_utils/behaviors.ts#L85-L118" + "specLocation": "_spec_utils/behaviors.ts#L85-L108" }, { "kind": "interface", @@ -233147,7 +233604,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L120-L126" + "specLocation": "_spec_utils/behaviors.ts#L110-L116" } ] } \ No newline at end of file diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index e0026ad873..cbed211e03 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -55,34 +55,6 @@ ], "response": [] }, - "cat.ml_data_frame_analytics": { - "request": [ - "request definition cat.ml_data_frame_analytics:Request / query - Property 'h' is already defined in an ancestor class", - "request definition cat.ml_data_frame_analytics:Request / query - Property 's' is already defined in an ancestor class" - ], - "response": [] - }, - "cat.ml_datafeeds": { - "request": [ - "request definition cat.ml_datafeeds:Request / query - Property 'h' is already defined in an ancestor class", - "request definition cat.ml_datafeeds:Request / query - Property 's' is already defined in an ancestor class" - ], - "response": [] - }, - "cat.ml_jobs": { - "request": [ - "request definition cat.ml_jobs:Request / query - Property 'h' is already defined in an ancestor class", - "request definition cat.ml_jobs:Request / query - Property 's' is already defined in an ancestor class" - ], - "response": [] - }, - "cat.ml_trained_models": { - "request": [ - "request definition cat.ml_trained_models:Request / query - Property 'h' is already defined in an ancestor class", - "request definition cat.ml_trained_models:Request / query - Property 's' is already defined in an ancestor class" - ], - "response": [] - }, "cat.recovery": { "request": [ "Request: missing json spec query parameter 'index'" @@ -103,13 +75,6 @@ ], "response": [] }, - "cat.transforms": { - "request": [ - "request definition cat.transforms:Request / query - Property 'h' is already defined in an ancestor class", - "request definition cat.transforms:Request / query - Property 's' is already defined in an ancestor class" - ], - "response": [] - }, "cluster.get_component_template": { "request": [ "Request: query parameter 'flat_settings' does not exist in the json spec" diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 0e900b7f67..95e41f3b8e 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -6990,6 +6990,8 @@ export interface CatAliasesAliasesRecord { export interface CatAliasesRequest extends CatCatRequestBase { name?: Names + h?: Names + s?: Names expand_wildcards?: ExpandWildcards master_timeout?: Duration } @@ -7035,6 +7037,8 @@ export interface CatAllocationAllocationRecord { export interface CatAllocationRequest extends CatCatRequestBase { node_id?: NodeIds bytes?: Bytes + h?: Names + s?: Names local?: boolean master_timeout?: Duration } @@ -7053,6 +7057,8 @@ export interface CatComponentTemplatesComponentTemplate { export interface CatComponentTemplatesRequest extends CatCatRequestBase { name?: string + h?: Names + s?: Names local?: boolean master_timeout?: Duration } @@ -7075,6 +7081,8 @@ export interface CatCountCountRecord { export interface CatCountRequest extends CatCatRequestBase { index?: Indices + h?: Names + s?: Names } export type CatCountResponse = CatCountCountRecord[] @@ -7094,6 +7102,8 @@ export interface CatFielddataFielddataRecord { export interface CatFielddataRequest extends CatCatRequestBase { fields?: Fields bytes?: Bytes + h?: Names + s?: Names } export type CatFielddataResponse = CatFielddataFielddataRecord[] @@ -7154,6 +7164,8 @@ export interface CatHealthHealthRecord { export interface CatHealthRequest extends CatCatRequestBase { time?: TimeUnit ts?: boolean + h?: Names + s?: Names } export type CatHealthResponse = CatHealthHealthRecord[] @@ -7464,6 +7476,8 @@ export interface CatIndicesRequest extends CatCatRequestBase { pri?: boolean time?: TimeUnit master_timeout?: Duration + h?: Names + s?: Names } export type CatIndicesResponse = CatIndicesIndicesRecord[] @@ -7478,6 +7492,8 @@ export interface CatMasterMasterRecord { } export interface CatMasterRequest extends CatCatRequestBase { + h?: Names + s?: Names local?: boolean master_timeout?: Duration } @@ -7848,6 +7864,8 @@ export interface CatNodeattrsNodeAttributesRecord { } export interface CatNodeattrsRequest extends CatCatRequestBase { + h?: Names + s?: Names local?: boolean master_timeout?: Duration } @@ -8128,6 +8146,8 @@ export interface CatNodesRequest extends CatCatRequestBase { bytes?: Bytes full_id?: boolean | string include_unloaded_segments?: boolean + h?: Names + s?: Names master_timeout?: Duration time?: TimeUnit } @@ -8146,6 +8166,8 @@ export interface CatPendingTasksPendingTasksRecord { } export interface CatPendingTasksRequest extends CatCatRequestBase { + h?: Names + s?: Names local?: boolean master_timeout?: Duration time?: TimeUnit @@ -8168,6 +8190,8 @@ export interface CatPluginsPluginsRecord { } export interface CatPluginsRequest extends CatCatRequestBase { + h?: Names + s?: Names include_bootstrap?: boolean local?: boolean master_timeout?: Duration @@ -8238,6 +8262,8 @@ export interface CatRecoveryRequest extends CatCatRequestBase { active_only?: boolean bytes?: Bytes detailed?: boolean + h?: Names + s?: Names time?: TimeUnit } @@ -8251,6 +8277,8 @@ export interface CatRepositoriesRepositoriesRecord { } export interface CatRepositoriesRequest extends CatCatRequestBase { + h?: Names + s?: Names local?: boolean master_timeout?: Duration } @@ -8260,6 +8288,8 @@ export type CatRepositoriesResponse = CatRepositoriesRepositoriesRecord[] export interface CatSegmentsRequest extends CatCatRequestBase { index?: Indices bytes?: Bytes + h?: Names + s?: Names local?: boolean master_timeout?: Duration } @@ -8311,6 +8341,8 @@ export interface CatSegmentsSegmentsRecord { export interface CatShardsRequest extends CatCatRequestBase { index?: Indices bytes?: Bytes + h?: Names + s?: Names master_timeout?: Duration time?: TimeUnit } @@ -8535,6 +8567,8 @@ export interface CatShardsShardsRecord { export interface CatSnapshotsRequest extends CatCatRequestBase { repository?: Names ignore_unavailable?: boolean + h?: Names + s?: Names master_timeout?: Duration time?: TimeUnit } @@ -8580,6 +8614,8 @@ export interface CatTasksRequest extends CatCatRequestBase { detailed?: boolean nodes?: string[] parent_task_id?: string + h?: Names + s?: Names time?: TimeUnit timeout?: Duration wait_for_completion?: boolean @@ -8624,6 +8660,8 @@ export interface CatTasksTasksRecord { export interface CatTemplatesRequest extends CatCatRequestBase { name?: Name + h?: Names + s?: Names local?: boolean master_timeout?: Duration } @@ -8646,6 +8684,8 @@ export interface CatTemplatesTemplatesRecord { export interface CatThreadPoolRequest extends CatCatRequestBase { thread_pool_patterns?: Names + h?: Names + s?: Names time?: TimeUnit local?: boolean master_timeout?: Duration @@ -22140,9 +22180,7 @@ export interface SpecUtilsCommonQueryParameters { export interface SpecUtilsCommonCatQueryParameters { format?: string - h?: Names help?: boolean - s?: Names v?: boolean } diff --git a/specification/_spec_utils/behaviors.ts b/specification/_spec_utils/behaviors.ts index b0f8b4002a..e3fd8f07b3 100644 --- a/specification/_spec_utils/behaviors.ts +++ b/specification/_spec_utils/behaviors.ts @@ -16,14 +16,6 @@ * specific language governing permissions and limitations * under the License. */ -/* - * This file hosts `behaviors`. We use this interfaces that are marked with a `@behavior` JS Doc annotation - * to signal complicated mappings to the compiler -> canonical json -> client generators. - * - * These are problem sets that need a custom client solution. - */ - -import { Names } from '@_types/common' /** * In some places in the specification an object consists of the union of a set of known properties @@ -94,22 +86,12 @@ export interface CommonCatQueryParameters { * @server_default text */ format?: string - /** - * List of columns to appear in the response. Supports simple wildcards. - */ - h?: Names /** * When set to `true` will output available columns. This option * can't be combined with any other query string option. * @server_default false */ help?: boolean - /** - * List of columns that determine how the table should be sorted. - * Sorting defaults to ascending and can be changed by setting `:asc` - * or `:desc` as a suffix to the column name. - */ - s?: Names /** * When set to `true` will enable verbose output. * @server_default false diff --git a/specification/cat/aliases/CatAliasesRequest.ts b/specification/cat/aliases/CatAliasesRequest.ts index c03867dab4..fdf5d6ed1a 100644 --- a/specification/cat/aliases/CatAliasesRequest.ts +++ b/specification/cat/aliases/CatAliasesRequest.ts @@ -50,6 +50,16 @@ export interface Request extends CatRequestBase { name?: Names } query_parameters: { + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names /** * The type of index that wildcard patterns can match. * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. diff --git a/specification/cat/allocation/CatAllocationRequest.ts b/specification/cat/allocation/CatAllocationRequest.ts index 0f0cf114b9..fdb909865e 100644 --- a/specification/cat/allocation/CatAllocationRequest.ts +++ b/specification/cat/allocation/CatAllocationRequest.ts @@ -18,7 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' -import { Bytes, NodeIds } from '@_types/common' +import { Bytes, Names, NodeIds } from '@_types/common' import { Duration } from '@_types/Time' /** @@ -51,6 +51,16 @@ export interface Request extends CatRequestBase { query_parameters: { /** The unit used to display byte values. */ bytes?: Bytes + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names /** * If `true`, the request computes the list of selected nodes from the * local cluster state. If `false` the list of selected nodes are computed diff --git a/specification/cat/component_templates/CatComponentTemplatesRequest.ts b/specification/cat/component_templates/CatComponentTemplatesRequest.ts index 824db3bf32..b92a92fd37 100644 --- a/specification/cat/component_templates/CatComponentTemplatesRequest.ts +++ b/specification/cat/component_templates/CatComponentTemplatesRequest.ts @@ -18,6 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' +import { Names } from '@_types/common' import { Duration } from '@_types/Time' /** @@ -53,6 +54,16 @@ export interface Request extends CatRequestBase { name?: string } query_parameters: { + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names /** * If `true`, the request computes the list of selected nodes from the * local cluster state. If `false` the list of selected nodes are computed diff --git a/specification/cat/count/CatCountRequest.ts b/specification/cat/count/CatCountRequest.ts index 69f72cbe92..3cd75d313f 100644 --- a/specification/cat/count/CatCountRequest.ts +++ b/specification/cat/count/CatCountRequest.ts @@ -18,7 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' -import { Indices } from '@_types/common' +import { Indices, Names } from '@_types/common' /** * Get a document count. @@ -53,4 +53,16 @@ export interface Request extends CatRequestBase { */ index?: Indices } + query_parameters: { + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names + } } diff --git a/specification/cat/fielddata/CatFielddataRequest.ts b/specification/cat/fielddata/CatFielddataRequest.ts index b495da9c08..cd6cd7cf0b 100644 --- a/specification/cat/fielddata/CatFielddataRequest.ts +++ b/specification/cat/fielddata/CatFielddataRequest.ts @@ -18,7 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' -import { Bytes, Fields } from '@_types/common' +import { Bytes, Fields, Names } from '@_types/common' /** * Get field data cache information. @@ -56,5 +56,15 @@ export interface Request extends CatRequestBase { bytes?: Bytes /** Comma-separated list of fields used to limit returned information. */ fields?: Fields + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names } } diff --git a/specification/cat/health/CatHealthRequest.ts b/specification/cat/health/CatHealthRequest.ts index 232d2a8a1a..456b2a4f5b 100644 --- a/specification/cat/health/CatHealthRequest.ts +++ b/specification/cat/health/CatHealthRequest.ts @@ -18,6 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' +import { Names } from '@_types/common' import { TimeUnit } from '@_types/Time' /** @@ -55,5 +56,15 @@ export interface Request extends CatRequestBase { * @server_default true */ ts?: boolean + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names } } diff --git a/specification/cat/indices/CatIndicesRequest.ts b/specification/cat/indices/CatIndicesRequest.ts index 86b825c4c8..bc178d6cae 100644 --- a/specification/cat/indices/CatIndicesRequest.ts +++ b/specification/cat/indices/CatIndicesRequest.ts @@ -18,7 +18,13 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' -import { Bytes, ExpandWildcards, HealthStatus, Indices } from '@_types/common' +import { + Bytes, + ExpandWildcards, + HealthStatus, + Indices, + Names +} from '@_types/common' import { Duration, TimeUnit } from '@_types/Time' /** @@ -89,5 +95,15 @@ export interface Request extends CatRequestBase { * @server_default 30s */ master_timeout?: Duration + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names } } diff --git a/specification/cat/master/CatMasterRequest.ts b/specification/cat/master/CatMasterRequest.ts index 9fd21124d4..d779952e4d 100644 --- a/specification/cat/master/CatMasterRequest.ts +++ b/specification/cat/master/CatMasterRequest.ts @@ -18,6 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' +import { Names } from '@_types/common' import { Duration } from '@_types/Time' /** @@ -40,6 +41,16 @@ export interface Request extends CatRequestBase { } ] query_parameters: { + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names /** * If `true`, the request computes the list of selected nodes from the * local cluster state. If `false` the list of selected nodes are computed diff --git a/specification/cat/nodeattrs/CatNodeAttributesRequest.ts b/specification/cat/nodeattrs/CatNodeAttributesRequest.ts index db54476226..9431d1566a 100644 --- a/specification/cat/nodeattrs/CatNodeAttributesRequest.ts +++ b/specification/cat/nodeattrs/CatNodeAttributesRequest.ts @@ -18,6 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' +import { Names } from '@_types/common' import { Duration } from '@_types/Time' /** @@ -39,6 +40,16 @@ export interface Request extends CatRequestBase { } ] query_parameters: { + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names /** * If `true`, the request computes the list of selected nodes from the * local cluster state. If `false` the list of selected nodes are computed diff --git a/specification/cat/nodes/CatNodesRequest.ts b/specification/cat/nodes/CatNodesRequest.ts index 181ca3670b..00520a2566 100644 --- a/specification/cat/nodes/CatNodesRequest.ts +++ b/specification/cat/nodes/CatNodesRequest.ts @@ -18,7 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' -import { Bytes } from '@_types/common' +import { Bytes, Names } from '@_types/common' import { Duration, TimeUnit } from '@_types/Time' /** @@ -54,6 +54,16 @@ export interface Request extends CatRequestBase { * @server_default false */ include_unloaded_segments?: boolean + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names /** * Period to wait for a connection to the master node. * @server_default 30s diff --git a/specification/cat/pending_tasks/CatPendingTasksRequest.ts b/specification/cat/pending_tasks/CatPendingTasksRequest.ts index 2519eca58d..c77cfb6570 100644 --- a/specification/cat/pending_tasks/CatPendingTasksRequest.ts +++ b/specification/cat/pending_tasks/CatPendingTasksRequest.ts @@ -18,6 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' +import { Names } from '@_types/common' import { Duration, TimeUnit } from '@_types/Time' /** @@ -39,6 +40,16 @@ export interface Request extends CatRequestBase { } ] query_parameters: { + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names /** * If `true`, the request computes the list of selected nodes from the * local cluster state. If `false` the list of selected nodes are computed diff --git a/specification/cat/plugins/CatPluginsRequest.ts b/specification/cat/plugins/CatPluginsRequest.ts index 75ff70edbb..e1aa84f118 100644 --- a/specification/cat/plugins/CatPluginsRequest.ts +++ b/specification/cat/plugins/CatPluginsRequest.ts @@ -18,6 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' +import { Names } from '@_types/common' import { Duration } from '@_types/Time' /** @@ -39,6 +40,16 @@ export interface Request extends CatRequestBase { } ] query_parameters: { + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names /** * Include bootstrap plugins in the response * @server_default false diff --git a/specification/cat/recovery/CatRecoveryRequest.ts b/specification/cat/recovery/CatRecoveryRequest.ts index 8edd033847..68659bb2a3 100644 --- a/specification/cat/recovery/CatRecoveryRequest.ts +++ b/specification/cat/recovery/CatRecoveryRequest.ts @@ -18,7 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' -import { Bytes, Indices } from '@_types/common' +import { Bytes, Indices, Names } from '@_types/common' import { TimeUnit } from '@_types/Time' /** @@ -68,6 +68,16 @@ export interface Request extends CatRequestBase { * @server_default false */ detailed?: boolean + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names /** * Unit used to display time values. */ diff --git a/specification/cat/repositories/CatRepositoriesRequest.ts b/specification/cat/repositories/CatRepositoriesRequest.ts index 68f4e5b667..7f92f0b372 100644 --- a/specification/cat/repositories/CatRepositoriesRequest.ts +++ b/specification/cat/repositories/CatRepositoriesRequest.ts @@ -18,6 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' +import { Names } from '@_types/common' import { Duration } from '@_types/Time' /** @@ -39,6 +40,16 @@ export interface Request extends CatRequestBase { } ] query_parameters: { + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names /** * If `true`, the request computes the list of selected nodes from the * local cluster state. If `false` the list of selected nodes are computed diff --git a/specification/cat/segments/CatSegmentsRequest.ts b/specification/cat/segments/CatSegmentsRequest.ts index 9eed2599c9..e8d5a66397 100644 --- a/specification/cat/segments/CatSegmentsRequest.ts +++ b/specification/cat/segments/CatSegmentsRequest.ts @@ -18,7 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' -import { Bytes, Indices } from '@_types/common' +import { Bytes, Indices, Names } from '@_types/common' import { Duration } from '@_types/Time' /** @@ -58,6 +58,16 @@ export interface Request extends CatRequestBase { * The unit used to display byte values. */ bytes?: Bytes + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names /** * If `true`, the request computes the list of selected nodes from the * local cluster state. If `false` the list of selected nodes are computed diff --git a/specification/cat/shards/CatShardsRequest.ts b/specification/cat/shards/CatShardsRequest.ts index e83d8d6ff4..0c88b9086a 100644 --- a/specification/cat/shards/CatShardsRequest.ts +++ b/specification/cat/shards/CatShardsRequest.ts @@ -18,7 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' -import { Bytes, Indices } from '@_types/common' +import { Bytes, Indices, Names } from '@_types/common' import { Duration, TimeUnit } from '@_types/Time' /** @@ -58,6 +58,16 @@ export interface Request extends CatRequestBase { * The unit used to display byte values. */ bytes?: Bytes + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names /** * Period to wait for a connection to the master node. * @server_default 30s diff --git a/specification/cat/snapshots/CatSnapshotsRequest.ts b/specification/cat/snapshots/CatSnapshotsRequest.ts index 01d6f7ed5e..4adcc88acd 100644 --- a/specification/cat/snapshots/CatSnapshotsRequest.ts +++ b/specification/cat/snapshots/CatSnapshotsRequest.ts @@ -59,6 +59,16 @@ export interface Request extends CatRequestBase { * @server_default false */ ignore_unavailable?: boolean + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names /** * Period to wait for a connection to the master node. * @server_default 30s diff --git a/specification/cat/tasks/CatTasksRequest.ts b/specification/cat/tasks/CatTasksRequest.ts index dace6a6951..4c2bfd014d 100644 --- a/specification/cat/tasks/CatTasksRequest.ts +++ b/specification/cat/tasks/CatTasksRequest.ts @@ -18,6 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' +import { Names } from '@_types/common' import { Duration, TimeUnit } from '@_types/Time' /** @@ -52,6 +53,16 @@ export interface Request extends CatRequestBase { nodes?: string[] /** The parent task identifier, which is used to limit the response. */ parent_task_id?: string + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names /** * Unit used to display time values. */ diff --git a/specification/cat/templates/CatTemplatesRequest.ts b/specification/cat/templates/CatTemplatesRequest.ts index 9f14fb3e10..c3e275b797 100644 --- a/specification/cat/templates/CatTemplatesRequest.ts +++ b/specification/cat/templates/CatTemplatesRequest.ts @@ -18,7 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' -import { Name } from '@_types/common' +import { Name, Names } from '@_types/common' import { Duration } from '@_types/Time' /** @@ -52,6 +52,16 @@ export interface Request extends CatRequestBase { name?: Name } query_parameters: { + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names /** * If `true`, the request computes the list of selected nodes from the * local cluster state. If `false` the list of selected nodes are computed diff --git a/specification/cat/thread_pool/CatThreadPoolRequest.ts b/specification/cat/thread_pool/CatThreadPoolRequest.ts index d0ee06dfc6..adee41c058 100644 --- a/specification/cat/thread_pool/CatThreadPoolRequest.ts +++ b/specification/cat/thread_pool/CatThreadPoolRequest.ts @@ -52,6 +52,16 @@ export interface Request extends CatRequestBase { thread_pool_patterns?: Names } query_parameters: { + /** + * List of columns to appear in the response. Supports simple wildcards. + */ + h?: Names + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ + s?: Names /** * The unit used to display time values. */