diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index c3ede242cf..cad1fd2f4a 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -899,6 +899,9 @@ "parameters": [ { "$ref": "#/components/parameters/cat.aliases#expand_wildcards" + }, + { + "$ref": "#/components/parameters/cat.aliases#master_timeout" } ], "responses": { @@ -922,6 +925,9 @@ }, { "$ref": "#/components/parameters/cat.aliases#expand_wildcards" + }, + { + "$ref": "#/components/parameters/cat.aliases#master_timeout" } ], "responses": { @@ -945,6 +951,9 @@ }, { "$ref": "#/components/parameters/cat.allocation#local" + }, + { + "$ref": "#/components/parameters/cat.allocation#master_timeout" } ], "responses": { @@ -971,6 +980,9 @@ }, { "$ref": "#/components/parameters/cat.allocation#local" + }, + { + "$ref": "#/components/parameters/cat.allocation#master_timeout" } ], "responses": { @@ -991,6 +1003,9 @@ "parameters": [ { "$ref": "#/components/parameters/cat.component_templates#local" + }, + { + "$ref": "#/components/parameters/cat.component_templates#master_timeout" } ], "responses": { @@ -1015,6 +1030,9 @@ }, { "$ref": "#/components/parameters/cat.component_templates#local" + }, + { + "$ref": "#/components/parameters/cat.component_templates#master_timeout" } ], "responses": { @@ -1170,10 +1188,7 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/cat.help:HelpRecord" - } + "type": "object" } } } @@ -1207,6 +1222,9 @@ }, { "$ref": "#/components/parameters/cat.indices#time" + }, + { + "$ref": "#/components/parameters/cat.indices#master_timeout" } ], "responses": { @@ -1245,6 +1263,9 @@ }, { "$ref": "#/components/parameters/cat.indices#time" + }, + { + "$ref": "#/components/parameters/cat.indices#master_timeout" } ], "responses": { @@ -1272,6 +1293,16 @@ "type": "boolean" }, "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" } ], "responses": { @@ -1518,6 +1549,9 @@ }, { "$ref": "#/components/parameters/cat.ml_trained_models#size" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#time" } ], "responses": { @@ -1557,6 +1591,9 @@ }, { "$ref": "#/components/parameters/cat.ml_trained_models#size" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#time" } ], "responses": { @@ -1585,6 +1622,16 @@ "type": "boolean" }, "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" } ], "responses": { @@ -1649,6 +1696,26 @@ "type": "boolean" }, "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "time", + "description": "Unit used to display time values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:TimeUnit" + }, + "style": "form" } ], "responses": { @@ -1686,6 +1753,26 @@ "type": "boolean" }, "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "time", + "description": "Unit used to display time values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:TimeUnit" + }, + "style": "form" } ], "responses": { @@ -1714,6 +1801,16 @@ "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": "include_bootstrap", + "description": "Include bootstrap plugins in the response", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, { "in": "query", "name": "local", @@ -1723,6 +1820,16 @@ "type": "boolean" }, "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" } ], "responses": { @@ -1759,6 +1866,9 @@ }, { "$ref": "#/components/parameters/cat.recovery#detailed" + }, + { + "$ref": "#/components/parameters/cat.recovery#time" } ], "responses": { @@ -1788,6 +1898,9 @@ }, { "$ref": "#/components/parameters/cat.recovery#detailed" + }, + { + "$ref": "#/components/parameters/cat.recovery#time" } ], "responses": { @@ -1805,6 +1918,28 @@ "summary": "Get snapshot repository information", "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": "local", + "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.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], "responses": { "200": { "description": "", @@ -1837,6 +1972,9 @@ }, { "$ref": "#/components/parameters/cat.segments#local" + }, + { + "$ref": "#/components/parameters/cat.segments#master_timeout" } ], "responses": { @@ -1863,6 +2001,9 @@ }, { "$ref": "#/components/parameters/cat.segments#local" + }, + { + "$ref": "#/components/parameters/cat.segments#master_timeout" } ], "responses": { @@ -1883,6 +2024,12 @@ "parameters": [ { "$ref": "#/components/parameters/cat.shards#bytes" + }, + { + "$ref": "#/components/parameters/cat.shards#master_timeout" + }, + { + "$ref": "#/components/parameters/cat.shards#time" } ], "responses": { @@ -1906,6 +2053,12 @@ }, { "$ref": "#/components/parameters/cat.shards#bytes" + }, + { + "$ref": "#/components/parameters/cat.shards#master_timeout" + }, + { + "$ref": "#/components/parameters/cat.shards#time" } ], "responses": { @@ -1926,6 +2079,12 @@ "parameters": [ { "$ref": "#/components/parameters/cat.snapshots#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/cat.snapshots#master_timeout" + }, + { + "$ref": "#/components/parameters/cat.snapshots#time" } ], "responses": { @@ -1950,6 +2109,12 @@ }, { "$ref": "#/components/parameters/cat.snapshots#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/cat.snapshots#master_timeout" + }, + { + "$ref": "#/components/parameters/cat.snapshots#time" } ], "responses": { @@ -1994,7 +2159,7 @@ }, { "in": "query", - "name": "node_id", + "name": "nodes", "description": "Unique node identifiers, which are used to limit the response.", "deprecated": false, "schema": { @@ -2014,6 +2179,36 @@ "type": "string" }, "style": "form" + }, + { + "in": "query", + "name": "time", + "description": "Unit used to display time values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:TimeUnit" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_completion", + "description": "If `true`, the request blocks until the task has completed.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" } ], "responses": { @@ -2045,6 +2240,9 @@ "parameters": [ { "$ref": "#/components/parameters/cat.templates#local" + }, + { + "$ref": "#/components/parameters/cat.templates#master_timeout" } ], "responses": { @@ -2069,6 +2267,9 @@ }, { "$ref": "#/components/parameters/cat.templates#local" + }, + { + "$ref": "#/components/parameters/cat.templates#master_timeout" } ], "responses": { @@ -2093,6 +2294,9 @@ }, { "$ref": "#/components/parameters/cat.thread_pool#local" + }, + { + "$ref": "#/components/parameters/cat.thread_pool#master_timeout" } ], "responses": { @@ -2119,6 +2323,9 @@ }, { "$ref": "#/components/parameters/cat.thread_pool#local" + }, + { + "$ref": "#/components/parameters/cat.thread_pool#master_timeout" } ], "responses": { @@ -50275,17 +50482,6 @@ } } }, - "cat.help:HelpRecord": { - "type": "object", - "properties": { - "endpoint": { - "type": "string" - } - }, - "required": [ - "endpoint" - ] - }, "_types:HealthStatus": { "type": "string", "enum": [ @@ -94201,6 +94397,16 @@ }, "style": "form" }, + "cat.aliases#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, "cat.allocation#node_id": { "in": "path", "name": "node_id", @@ -94232,6 +94438,16 @@ }, "style": "form" }, + "cat.allocation#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, "cat.component_templates#name": { "in": "path", "name": "name", @@ -94253,6 +94469,16 @@ }, "style": "form" }, + "cat.component_templates#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, "cat.count#index": { "in": "path", "name": "index", @@ -94366,6 +94592,16 @@ }, "style": "form" }, + "cat.indices#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, "cat.ml_data_frame_analytics#id": { "in": "path", "name": "id", @@ -94423,7 +94659,7 @@ "description": "Unit used to display time values.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "$ref": "#/components/schemas/_types:TimeUnit" }, "style": "form" }, @@ -94610,6 +94846,16 @@ }, "style": "form" }, + "cat.ml_trained_models#time": { + "in": "query", + "name": "time", + "description": "Unit used to display time values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:TimeUnit" + }, + "style": "form" + }, "cat.recovery#index": { "in": "path", "name": "index", @@ -94651,6 +94897,16 @@ }, "style": "form" }, + "cat.recovery#time": { + "in": "query", + "name": "time", + "description": "Unit used to display time values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:TimeUnit" + }, + "style": "form" + }, "cat.segments#index": { "in": "path", "name": "index", @@ -94682,6 +94938,16 @@ }, "style": "form" }, + "cat.segments#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, "cat.shards#index": { "in": "path", "name": "index", @@ -94703,6 +94969,26 @@ }, "style": "form" }, + "cat.shards#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "cat.shards#time": { + "in": "query", + "name": "time", + "description": "Unit used to display time values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:TimeUnit" + }, + "style": "form" + }, "cat.snapshots#repository": { "in": "path", "name": "repository", @@ -94724,6 +95010,26 @@ }, "style": "form" }, + "cat.snapshots#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "cat.snapshots#time": { + "in": "query", + "name": "time", + "description": "Unit used to display time values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:TimeUnit" + }, + "style": "form" + }, "cat.templates#name": { "in": "path", "name": "name", @@ -94745,6 +95051,16 @@ }, "style": "form" }, + "cat.templates#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, "cat.thread_pool#thread_pool_patterns": { "in": "path", "name": "thread_pool_patterns", @@ -94776,6 +95092,16 @@ }, "style": "form" }, + "cat.thread_pool#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, "cat.transforms#transform_id": { "in": "path", "name": "transform_id", diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 66d4915e48..e3dcf2faf8 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -677,6 +677,9 @@ "parameters": [ { "$ref": "#/components/parameters/cat.aliases#expand_wildcards" + }, + { + "$ref": "#/components/parameters/cat.aliases#master_timeout" } ], "responses": { @@ -700,6 +703,9 @@ }, { "$ref": "#/components/parameters/cat.aliases#expand_wildcards" + }, + { + "$ref": "#/components/parameters/cat.aliases#master_timeout" } ], "responses": { @@ -720,6 +726,9 @@ "parameters": [ { "$ref": "#/components/parameters/cat.component_templates#local" + }, + { + "$ref": "#/components/parameters/cat.component_templates#master_timeout" } ], "responses": { @@ -744,6 +753,9 @@ }, { "$ref": "#/components/parameters/cat.component_templates#local" + }, + { + "$ref": "#/components/parameters/cat.component_templates#master_timeout" } ], "responses": { @@ -803,10 +815,7 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/cat.help:HelpRecord" - } + "type": "object" } } } @@ -840,6 +849,9 @@ }, { "$ref": "#/components/parameters/cat.indices#time" + }, + { + "$ref": "#/components/parameters/cat.indices#master_timeout" } ], "responses": { @@ -878,6 +890,9 @@ }, { "$ref": "#/components/parameters/cat.indices#time" + }, + { + "$ref": "#/components/parameters/cat.indices#master_timeout" } ], "responses": { @@ -1114,6 +1129,9 @@ }, { "$ref": "#/components/parameters/cat.ml_trained_models#size" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#time" } ], "responses": { @@ -1153,6 +1171,9 @@ }, { "$ref": "#/components/parameters/cat.ml_trained_models#size" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#time" } ], "responses": { @@ -33199,17 +33220,6 @@ "description": "Time of day, expressed as HH:MM:SS", "type": "string" }, - "cat.help:HelpRecord": { - "type": "object", - "properties": { - "endpoint": { - "type": "string" - } - }, - "required": [ - "endpoint" - ] - }, "_types:Bytes": { "type": "string", "enum": [ @@ -57761,6 +57771,16 @@ }, "style": "form" }, + "cat.aliases#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, "cat.component_templates#name": { "in": "path", "name": "name", @@ -57782,6 +57802,16 @@ }, "style": "form" }, + "cat.component_templates#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, "cat.count#index": { "in": "path", "name": "index", @@ -57864,6 +57894,16 @@ }, "style": "form" }, + "cat.indices#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, "cat.ml_data_frame_analytics#id": { "in": "path", "name": "id", @@ -57921,7 +57961,7 @@ "description": "Unit used to display time values.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "$ref": "#/components/schemas/_types:TimeUnit" }, "style": "form" }, @@ -58108,6 +58148,16 @@ }, "style": "form" }, + "cat.ml_trained_models#time": { + "in": "query", + "name": "time", + "description": "Unit used to display time values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:TimeUnit" + }, + "style": "form" + }, "cat.transforms#transform_id": { "in": "path", "name": "transform_id", diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index d87f5a0978..9f5cacb1e7 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -11612,9 +11612,22 @@ "namespace": "_types" } } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } } ], - "specLocation": "cat/aliases/CatAliasesRequest.ts#L23-L43" + "specLocation": "cat/aliases/CatAliasesRequest.ts#L24-L49" }, { "body": { @@ -11684,9 +11697,22 @@ "namespace": "_builtins" } } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } } ], - "specLocation": "cat/component_templates/CatComponentTemplatesRequest.ts#L22-L49" + "specLocation": "cat/component_templates/CatComponentTemplatesRequest.ts#L23-L55" }, { "body": { @@ -11768,20 +11794,10 @@ "specLocation": "cat/count/CatCountResponse.ts#L22-L24" }, { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], "body": { "kind": "no_body" }, "description": "Get CAT help.\nReturns help for the CAT APIs.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, "kind": "request", "name": { "name": "Request", @@ -11789,28 +11805,19 @@ }, "path": [], "query": [], - "specLocation": "cat/help/CatHelpRequest.ts#L22-L30" + "specLocation": "cat/help/CatHelpRequest.ts#L20-L28" }, { "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "HelpRecord", - "namespace": "cat.help" - } - } - } + "kind": "properties", + "properties": [] }, "kind": "response", "name": { "name": "Response", "namespace": "cat.help" }, - "specLocation": "cat/help/CatHelpResponse.ts#L22-L24" + "specLocation": "cat/help/CatHelpResponse.ts#L20-L25" }, { "attachedBehaviors": [ @@ -11920,9 +11927,22 @@ "namespace": "_types" } } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } } ], - "specLocation": "cat/indices/CatIndicesRequest.ts#L24-L77" + "specLocation": "cat/indices/CatIndicesRequest.ts#L24-L82" }, { "body": { @@ -12036,7 +12056,7 @@ "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "TimeUnit", "namespace": "_types" } } @@ -12402,9 +12422,21 @@ "namespace": "_types" } } + }, + { + "description": "Unit used to display time values.", + "name": "time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TimeUnit", + "namespace": "_types" + } + } } ], - "specLocation": "cat/ml_trained_models/CatTrainedModelsRequest.ts#L24-L64" + "specLocation": "cat/ml_trained_models/CatTrainedModelsRequest.ts#L25-L69" }, { "body": { @@ -45389,7 +45421,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L29-L37" + "specLocation": "_spec_utils/behaviors.ts#L28-L36" }, { "codegenNames": [ @@ -49746,7 +49778,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L39-L48" + "specLocation": "_spec_utils/behaviors.ts#L38-L47" }, { "generics": [ @@ -105990,7 +106022,7 @@ } } ], - "specLocation": "_spec_utils/behaviors.ts#L50-L84" + "specLocation": "_spec_utils/behaviors.ts#L49-L83" }, { "kind": "interface", @@ -107279,19 +107311,6 @@ } } }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "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", @@ -107318,7 +107337,7 @@ } } ], - "specLocation": "_spec_utils/behaviors.ts#L86-L124" + "specLocation": "_spec_utils/behaviors.ts#L85-L118" }, { "kind": "interface", @@ -107590,27 +107609,6 @@ ], "specLocation": "cat/count/types.ts#L23-L39" }, - { - "kind": "interface", - "name": { - "name": "HelpRecord", - "namespace": "cat.help" - }, - "properties": [ - { - "name": "endpoint", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "cat/help/types.ts#L20-L22" - }, { "kind": "interface", "name": { @@ -136713,7 +136711,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L126-L132" + "specLocation": "_spec_utils/behaviors.ts#L120-L126" }, { "attachedBehaviors": [ diff --git a/output/schema/schema.json b/output/schema/schema.json index d2977b1d09..5eb393f563 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -91181,9 +91181,22 @@ "namespace": "_types" } } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } } ], - "specLocation": "cat/aliases/CatAliasesRequest.ts#L23-L43" + "specLocation": "cat/aliases/CatAliasesRequest.ts#L24-L49" }, { "kind": "response", @@ -91614,9 +91627,22 @@ "namespace": "_builtins" } } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } } ], - "specLocation": "cat/allocation/CatAllocationRequest.ts#L23-L50" + "specLocation": "cat/allocation/CatAllocationRequest.ts#L24-L56" }, { "kind": "response", @@ -91773,9 +91799,22 @@ "namespace": "_builtins" } } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } } ], - "specLocation": "cat/component_templates/CatComponentTemplatesRequest.ts#L22-L49" + "specLocation": "cat/component_templates/CatComponentTemplatesRequest.ts#L23-L55" }, { "kind": "response", @@ -92452,71 +92491,31 @@ }, "specLocation": "cat/health/CatHealthResponse.ts#L22-L24" }, - { - "kind": "interface", - "name": { - "name": "HelpRecord", - "namespace": "cat.help" - }, - "properties": [ - { - "name": "endpoint", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "cat/help/types.ts#L20-L22" - }, { "kind": "request", - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], "body": { "kind": "no_body" }, "description": "Get CAT help.\nReturns help for the CAT APIs.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, "name": { "name": "Request", "namespace": "cat.help" }, "path": [], "query": [], - "specLocation": "cat/help/CatHelpRequest.ts#L22-L30" + "specLocation": "cat/help/CatHelpRequest.ts#L20-L28" }, { "kind": "response", "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "HelpRecord", - "namespace": "cat.help" - } - } - } + "kind": "properties", + "properties": [] }, "name": { "name": "Response", "namespace": "cat.help" }, - "specLocation": "cat/help/CatHelpResponse.ts#L22-L24" + "specLocation": "cat/help/CatHelpResponse.ts#L20-L25" }, { "kind": "interface", @@ -94708,9 +94707,22 @@ "namespace": "_types" } } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } } ], - "specLocation": "cat/indices/CatIndicesRequest.ts#L24-L77" + "specLocation": "cat/indices/CatIndicesRequest.ts#L24-L82" }, { "kind": "response", @@ -94831,9 +94843,22 @@ "namespace": "_builtins" } } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } } ], - "specLocation": "cat/master/CatMasterRequest.ts#L22-L43" + "specLocation": "cat/master/CatMasterRequest.ts#L23-L49" }, { "kind": "response", @@ -95204,7 +95229,7 @@ "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "TimeUnit", "namespace": "_types" } } @@ -96728,9 +96753,21 @@ "namespace": "_types" } } + }, + { + "description": "Unit used to display time values.", + "name": "time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TimeUnit", + "namespace": "_types" + } + } } ], - "specLocation": "cat/ml_trained_models/CatTrainedModelsRequest.ts#L24-L64" + "specLocation": "cat/ml_trained_models/CatTrainedModelsRequest.ts#L25-L69" }, { "kind": "response", @@ -97190,9 +97227,22 @@ "namespace": "_builtins" } } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } } ], - "specLocation": "cat/nodeattrs/CatNodeAttributesRequest.ts#L22-L43" + "specLocation": "cat/nodeattrs/CatNodeAttributesRequest.ts#L23-L49" }, { "kind": "response", @@ -98801,9 +98851,34 @@ "namespace": "_builtins" } } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Unit used to display time values.", + "name": "time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TimeUnit", + "namespace": "_types" + } + } } ], - "specLocation": "cat/nodes/CatNodesRequest.ts#L23-L50" + "specLocation": "cat/nodes/CatNodesRequest.ts#L24-L60" }, { "kind": "response", @@ -98930,9 +99005,34 @@ "namespace": "_builtins" } } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Unit used to display time values.", + "name": "time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TimeUnit", + "namespace": "_types" + } + } } ], - "specLocation": "cat/pending_tasks/CatPendingTasksRequest.ts#L22-L43" + "specLocation": "cat/pending_tasks/CatPendingTasksRequest.ts#L23-L53" }, { "kind": "response", @@ -99074,6 +99174,19 @@ }, "path": [], "query": [ + { + "description": "Include bootstrap plugins in the response", + "name": "include_bootstrap", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, { "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", @@ -99086,9 +99199,22 @@ "namespace": "_builtins" } } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } } ], - "specLocation": "cat/plugins/CatPluginsRequest.ts#L22-L43" + "specLocation": "cat/plugins/CatPluginsRequest.ts#L23-L54" }, { "kind": "response", @@ -99604,9 +99730,21 @@ "namespace": "_builtins" } } + }, + { + "description": "Unit used to display time values.", + "name": "time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TimeUnit", + "namespace": "_types" + } + } } ], - "specLocation": "cat/recovery/CatRecoveryRequest.ts#L23-L60" + "specLocation": "cat/recovery/CatRecoveryRequest.ts#L24-L65" }, { "kind": "response", @@ -99690,8 +99828,35 @@ "namespace": "cat.repositories" }, "path": [], - "query": [], - "specLocation": "cat/repositories/CatRepositoriesRequest.ts#L22-L32" + "query": [ + { + "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", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "cat/repositories/CatRepositoriesRequest.ts#L23-L49" }, { "kind": "response", @@ -99773,9 +99938,22 @@ "namespace": "_builtins" } } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } } ], - "specLocation": "cat/segments/CatSegmentsRequest.ts#L23-L58" + "specLocation": "cat/segments/CatSegmentsRequest.ts#L24-L64" }, { "kind": "response", @@ -100084,9 +100262,34 @@ "namespace": "_types" } } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Unit used to display time values.", + "name": "time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TimeUnit", + "namespace": "_types" + } + } } ], - "specLocation": "cat/shards/CatShardsRequest.ts#L23-L50" + "specLocation": "cat/shards/CatShardsRequest.ts#L24-L60" }, { "kind": "response", @@ -101437,9 +101640,34 @@ "namespace": "_builtins" } } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Unit used to display time values.", + "name": "time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TimeUnit", + "namespace": "_types" + } + } } ], - "specLocation": "cat/snapshots/CatSnapshotsRequest.ts#L23-L51" + "specLocation": "cat/snapshots/CatSnapshotsRequest.ts#L24-L61" }, { "kind": "response", @@ -101760,7 +101988,7 @@ }, { "description": "Unique node identifiers, which are used to limit the response.", - "name": "node_id", + "name": "nodes", "required": false, "type": { "kind": "array_of", @@ -101784,9 +102012,47 @@ "namespace": "_builtins" } } + }, + { + "description": "Unit used to display time values.", + "name": "time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TimeUnit", + "namespace": "_types" + } + } + }, + { + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "If `true`, the request blocks until the task has completed.", + "name": "wait_for_completion", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "cat/tasks/CatTasksRequest.ts#L22-L48" + "specLocation": "cat/tasks/CatTasksRequest.ts#L24-L65" }, { "kind": "response", @@ -102102,9 +102368,22 @@ "namespace": "_builtins" } } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } } ], - "specLocation": "cat/templates/CatTemplatesRequest.ts#L23-L52" + "specLocation": "cat/templates/CatTemplatesRequest.ts#L24-L58" }, { "kind": "response", @@ -102284,9 +102563,22 @@ "namespace": "_builtins" } } + }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } } ], - "specLocation": "cat/thread_pool/CatThreadPoolRequest.ts#L24-L57" + "specLocation": "cat/thread_pool/CatThreadPoolRequest.ts#L24-L62" }, { "kind": "response", @@ -222629,7 +222921,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L29-L37" + "specLocation": "_spec_utils/behaviors.ts#L28-L36" }, { "kind": "interface", @@ -222649,7 +222941,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L39-L48" + "specLocation": "_spec_utils/behaviors.ts#L38-L47" }, { "kind": "interface", @@ -222726,7 +223018,7 @@ } } ], - "specLocation": "_spec_utils/behaviors.ts#L50-L84" + "specLocation": "_spec_utils/behaviors.ts#L49-L83" }, { "kind": "interface", @@ -222774,19 +223066,6 @@ } } }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "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", @@ -222813,7 +223092,7 @@ } } ], - "specLocation": "_spec_utils/behaviors.ts#L86-L124" + "specLocation": "_spec_utils/behaviors.ts#L85-L118" }, { "kind": "interface", @@ -222829,7 +223108,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L126-L132" + "specLocation": "_spec_utils/behaviors.ts#L120-L126" } ] } \ No newline at end of file diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index dec4e947a9..21da34b4b8 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -48,36 +48,15 @@ ], "response": [] }, - "cat.count": { - "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec" - ], - "response": [] - }, - "cat.fielddata": { - "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec" - ], - "response": [] - }, - "cat.health": { - "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec" - ], - "response": [] - }, "cat.help": { "request": [ - "Request: query parameter 'format' does not exist in the json spec", - "Request: query parameter 'h' does not exist in the json spec", - "Request: query parameter 'master_timeout' does not exist in the json spec", - "Request: query parameter 'v' does not exist in the json spec" + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'" ], "response": [] }, "cat.ml_data_frame_analytics": { "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec", "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" ], @@ -85,7 +64,6 @@ }, "cat.ml_datafeeds": { "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec", "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" ], @@ -93,7 +71,6 @@ }, "cat.ml_jobs": { "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec", "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" ], @@ -101,42 +78,14 @@ }, "cat.ml_trained_models": { "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec", - "Request: missing json spec query parameter 'time'", "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.nodes": { - "request": [ - "Request: missing json spec query parameter 'time'" - ], - "response": [] - }, - "cat.pending_tasks": { - "request": [ - "Request: missing json spec query parameter 'time'" - ], - "response": [] - }, - "cat.plugins": { - "request": [ - "Request: missing json spec query parameter 'include_bootstrap'" - ], - "response": [] - }, "cat.recovery": { "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec", - "Request: missing json spec query parameter 'index'", - "Request: missing json spec query parameter 'time'" - ], - "response": [] - }, - "cat.repositories": { - "request": [ - "Request: missing json spec query parameter 'local'" + "Request: missing json spec query parameter 'index'" ], "response": [] }, @@ -147,30 +96,15 @@ ], "response": [] }, - "cat.shards": { - "request": [ - "Request: missing json spec query parameter 'time'" - ], - "response": [] - }, - "cat.snapshots": { - "request": [ - "Request: missing json spec query parameter 'time'" - ], - "response": [] - }, "cat.tasks": { "request": [ - "Request: query parameter 'node_id' does not exist in the json spec", - "Request: query parameter 'master_timeout' does not exist in the json spec", - "Request: missing json spec query parameter 'nodes'", - "Request: missing json spec query parameter 'time'" + "Request: query parameter 'timeout' does not exist in the json spec", + "Request: query parameter 'wait_for_completion' does not exist in the json spec" ], "response": [] }, "cat.transforms": { "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec", "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" ], diff --git a/output/typescript/types.ts b/output/typescript/types.ts index a01d40e52f..ec5cff4249 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -6953,6 +6953,7 @@ export interface CatAliasesAliasesRecord { export interface CatAliasesRequest extends CatCatRequestBase { name?: Names expand_wildcards?: ExpandWildcards + master_timeout?: Duration } export type CatAliasesResponse = CatAliasesAliasesRecord[] @@ -6997,6 +6998,7 @@ export interface CatAllocationRequest extends CatCatRequestBase { node_id?: NodeIds bytes?: Bytes local?: boolean + master_timeout?: Duration } export type CatAllocationResponse = CatAllocationAllocationRecord[] @@ -7014,6 +7016,7 @@ export interface CatComponentTemplatesComponentTemplate { export interface CatComponentTemplatesRequest extends CatCatRequestBase { name?: string local?: boolean + master_timeout?: Duration } export type CatComponentTemplatesResponse = CatComponentTemplatesComponentTemplate[] @@ -7117,15 +7120,12 @@ export interface CatHealthRequest extends CatCatRequestBase { export type CatHealthResponse = CatHealthHealthRecord[] -export interface CatHelpHelpRecord { - endpoint: string +export interface CatHelpRequest { } -export interface CatHelpRequest extends CatCatRequestBase { +export interface CatHelpResponse { } -export type CatHelpResponse = CatHelpHelpRecord[] - export interface CatIndicesIndicesRecord { health?: string h?: string @@ -7425,6 +7425,7 @@ export interface CatIndicesRequest extends CatCatRequestBase { include_unloaded_segments?: boolean pri?: boolean time?: TimeUnit + master_timeout?: Duration } export type CatIndicesResponse = CatIndicesIndicesRecord[] @@ -7440,6 +7441,7 @@ export interface CatMasterMasterRecord { export interface CatMasterRequest extends CatCatRequestBase { local?: boolean + master_timeout?: Duration } export type CatMasterResponse = CatMasterMasterRecord[] @@ -7494,7 +7496,7 @@ export interface CatMlDataFrameAnalyticsRequest extends CatCatRequestBase { bytes?: Bytes h?: CatCatDfaColumns s?: CatCatDfaColumns - time?: Duration + time?: TimeUnit } export type CatMlDataFrameAnalyticsResponse = CatMlDataFrameAnalyticsDataFrameAnalyticsRecord[] @@ -7740,6 +7742,7 @@ export interface CatMlTrainedModelsRequest extends CatCatRequestBase { s?: CatCatTrainedModelsColumns from?: integer size?: integer + time?: TimeUnit } export type CatMlTrainedModelsResponse = CatMlTrainedModelsTrainedModelsRecord[] @@ -7808,6 +7811,7 @@ export interface CatNodeattrsNodeAttributesRecord { export interface CatNodeattrsRequest extends CatCatRequestBase { local?: boolean + master_timeout?: Duration } export type CatNodeattrsResponse = CatNodeattrsNodeAttributesRecord[] @@ -8086,6 +8090,8 @@ export interface CatNodesRequest extends CatCatRequestBase { bytes?: Bytes full_id?: boolean | string include_unloaded_segments?: boolean + master_timeout?: Duration + time?: TimeUnit } export type CatNodesResponse = CatNodesNodesRecord[] @@ -8103,6 +8109,8 @@ export interface CatPendingTasksPendingTasksRecord { export interface CatPendingTasksRequest extends CatCatRequestBase { local?: boolean + master_timeout?: Duration + time?: TimeUnit } export type CatPendingTasksResponse = CatPendingTasksPendingTasksRecord[] @@ -8122,7 +8130,9 @@ export interface CatPluginsPluginsRecord { } export interface CatPluginsRequest extends CatCatRequestBase { + include_bootstrap?: boolean local?: boolean + master_timeout?: Duration } export type CatPluginsResponse = CatPluginsPluginsRecord[] @@ -8190,6 +8200,7 @@ export interface CatRecoveryRequest extends CatCatRequestBase { active_only?: boolean bytes?: Bytes detailed?: boolean + time?: TimeUnit } export type CatRecoveryResponse = CatRecoveryRecoveryRecord[] @@ -8202,6 +8213,8 @@ export interface CatRepositoriesRepositoriesRecord { } export interface CatRepositoriesRequest extends CatCatRequestBase { + local?: boolean + master_timeout?: Duration } export type CatRepositoriesResponse = CatRepositoriesRepositoriesRecord[] @@ -8210,6 +8223,7 @@ export interface CatSegmentsRequest extends CatCatRequestBase { index?: Indices bytes?: Bytes local?: boolean + master_timeout?: Duration } export type CatSegmentsResponse = CatSegmentsSegmentsRecord[] @@ -8259,6 +8273,8 @@ export interface CatSegmentsSegmentsRecord { export interface CatShardsRequest extends CatCatRequestBase { index?: Indices bytes?: Bytes + master_timeout?: Duration + time?: TimeUnit } export type CatShardsResponse = CatShardsShardsRecord[] @@ -8481,6 +8497,8 @@ export interface CatShardsShardsRecord { export interface CatSnapshotsRequest extends CatCatRequestBase { repository?: Names ignore_unavailable?: boolean + master_timeout?: Duration + time?: TimeUnit } export type CatSnapshotsResponse = CatSnapshotsSnapshotsRecord[] @@ -8522,8 +8540,11 @@ export interface CatSnapshotsSnapshotsRecord { export interface CatTasksRequest extends CatCatRequestBase { actions?: string[] detailed?: boolean - node_id?: string[] + nodes?: string[] parent_task_id?: string + time?: TimeUnit + timeout?: Duration + wait_for_completion?: boolean } export type CatTasksResponse = CatTasksTasksRecord[] @@ -8566,6 +8587,7 @@ export interface CatTasksTasksRecord { export interface CatTemplatesRequest extends CatCatRequestBase { name?: Name local?: boolean + master_timeout?: Duration } export type CatTemplatesResponse = CatTemplatesTemplatesRecord[] @@ -8588,6 +8610,7 @@ export interface CatThreadPoolRequest extends CatCatRequestBase { thread_pool_patterns?: Names time?: TimeUnit local?: boolean + master_timeout?: Duration } export type CatThreadPoolResponse = CatThreadPoolThreadPoolRecord[] @@ -21347,7 +21370,6 @@ export interface SpecUtilsCommonCatQueryParameters { format?: string h?: Names help?: boolean - master_timeout?: Duration s?: Names v?: boolean } diff --git a/specification/_spec_utils/behaviors.ts b/specification/_spec_utils/behaviors.ts index 09cb376349..b0f8b4002a 100644 --- a/specification/_spec_utils/behaviors.ts +++ b/specification/_spec_utils/behaviors.ts @@ -24,7 +24,6 @@ */ import { Names } from '@_types/common' -import { Duration } from '@_types/Time' /** * In some places in the specification an object consists of the union of a set of known properties @@ -105,11 +104,6 @@ export interface CommonCatQueryParameters { * @server_default false */ help?: boolean - /** - * Period to wait for a connection to the master node. - * @server_default 30s - */ - master_timeout?: Duration /** * List of columns that determine how the table should be sorted. * Sorting defaults to ascending and can be changed by setting `:asc` diff --git a/specification/cat/aliases/CatAliasesRequest.ts b/specification/cat/aliases/CatAliasesRequest.ts index 91c8ccd773..60bf98a8df 100644 --- a/specification/cat/aliases/CatAliasesRequest.ts +++ b/specification/cat/aliases/CatAliasesRequest.ts @@ -19,6 +19,7 @@ import { CatRequestBase } from '@cat/_types/CatBase' import { ExpandWildcards, Names } from '@_types/common' +import { Duration } from '@_types/Time' /** * Get aliases. @@ -39,5 +40,10 @@ export interface Request extends CatRequestBase { } query_parameters: { expand_wildcards?: ExpandWildcards + /** + * Period to wait for a connection to the master node. + * @server_default 30s + */ + master_timeout?: Duration } } diff --git a/specification/cat/allocation/CatAllocationRequest.ts b/specification/cat/allocation/CatAllocationRequest.ts index 2e2beac2d5..2679e93a8f 100644 --- a/specification/cat/allocation/CatAllocationRequest.ts +++ b/specification/cat/allocation/CatAllocationRequest.ts @@ -19,6 +19,7 @@ import { CatRequestBase } from '@cat/_types/CatBase' import { Bytes, NodeIds } from '@_types/common' +import { Duration } from '@_types/Time' /** * Get shard allocation information. @@ -46,5 +47,10 @@ export interface Request extends CatRequestBase { * @server_default false */ local?: boolean + /** + * Period to wait for a connection to the master node. + * @server_default 30s + */ + master_timeout?: Duration } } diff --git a/specification/cat/component_templates/CatComponentTemplatesRequest.ts b/specification/cat/component_templates/CatComponentTemplatesRequest.ts index a5a4e0a2eb..a831e40ace 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 { Duration } from '@_types/Time' /** * Get component templates. @@ -45,5 +46,10 @@ export interface Request extends CatRequestBase { * @server_default false */ local?: boolean + /** + * Period to wait for a connection to the master node. + * @server_default 30s + */ + master_timeout?: Duration } } diff --git a/specification/cat/help/CatHelpRequest.ts b/specification/cat/help/CatHelpRequest.ts index 3493c6ca2d..7ed4b9686d 100644 --- a/specification/cat/help/CatHelpRequest.ts +++ b/specification/cat/help/CatHelpRequest.ts @@ -17,8 +17,6 @@ * under the License. */ -import { CatRequestBase } from '@cat/_types/CatBase' - /** * Get CAT help. * Returns help for the CAT APIs. @@ -27,4 +25,4 @@ import { CatRequestBase } from '@cat/_types/CatBase' * @availability serverless stability=stable visibility=public * @doc_id cat */ -export interface Request extends CatRequestBase {} +export interface Request {} diff --git a/specification/cat/help/CatHelpResponse.ts b/specification/cat/help/CatHelpResponse.ts index 9282c311d0..e12124d1b8 100644 --- a/specification/cat/help/CatHelpResponse.ts +++ b/specification/cat/help/CatHelpResponse.ts @@ -17,8 +17,9 @@ * under the License. */ -import { HelpRecord } from './types' - +/** + * The response is a string with line-separated list of all the `_cat` endpoints, starting with a `=^.^=` emoticon. + */ export class Response { - body: Array + body: string } diff --git a/specification/cat/help/types.ts b/specification/cat/help/types.ts deleted file mode 100644 index e1fb534f5e..0000000000 --- a/specification/cat/help/types.ts +++ /dev/null @@ -1,22 +0,0 @@ -/* - * Licensed to Elasticsearch B.V. under one or more contributor - * license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright - * ownership. Elasticsearch B.V. licenses this file to you under - * the Apache License, Version 2.0 (the "License"); you may - * not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -export class HelpRecord { - endpoint: string -} diff --git a/specification/cat/indices/CatIndicesRequest.ts b/specification/cat/indices/CatIndicesRequest.ts index 5c95f1bbb2..7d0eddefff 100644 --- a/specification/cat/indices/CatIndicesRequest.ts +++ b/specification/cat/indices/CatIndicesRequest.ts @@ -19,7 +19,7 @@ import { CatRequestBase } from '@cat/_types/CatBase' import { Bytes, ExpandWildcards, HealthStatus, Indices } from '@_types/common' -import { TimeUnit } from '@_types/Time' +import { Duration, TimeUnit } from '@_types/Time' /** * Get index information. @@ -73,5 +73,10 @@ export interface Request extends CatRequestBase { pri?: boolean /** The unit used to display time values. */ time?: TimeUnit + /** + * Period to wait for a connection to the master node. + * @server_default 30s + */ + master_timeout?: Duration } } diff --git a/specification/cat/master/CatMasterRequest.ts b/specification/cat/master/CatMasterRequest.ts index 488a62ba13..83d5d1de15 100644 --- a/specification/cat/master/CatMasterRequest.ts +++ b/specification/cat/master/CatMasterRequest.ts @@ -18,6 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' +import { Duration } from '@_types/Time' /** * Get master node information. @@ -39,5 +40,10 @@ export interface Request extends CatRequestBase { * @server_default false */ local?: boolean + /** + * Period to wait for a connection to the master node. + * @server_default 30s + */ + master_timeout?: Duration } } diff --git a/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts b/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts index a9a3de63e4..b6f487bc22 100644 --- a/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts +++ b/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts @@ -19,7 +19,7 @@ import { CatDfaColumns, CatRequestBase } from '@cat/_types/CatBase' import { Bytes, Id } from '@_types/common' -import { Duration } from '@_types/Time' +import { TimeUnit } from '@_types/Time' /** * Get data frame analytics jobs. @@ -54,6 +54,6 @@ export interface Request extends CatRequestBase { /** * Unit used to display time values. */ - time?: Duration + time?: TimeUnit } } diff --git a/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts b/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts index b0f4d40151..a1733b116e 100644 --- a/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts +++ b/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts @@ -20,6 +20,7 @@ import { CatRequestBase, CatTrainedModelsColumns } from '@cat/_types/CatBase' import { Bytes, Id } from '@_types/common' import { integer } from '@_types/Numeric' +import { TimeUnit } from '@_types/Time' /** * Get trained models. @@ -60,5 +61,9 @@ export interface Request extends CatRequestBase { from?: integer /** The maximum number of transforms to display. */ size?: integer + /** + * Unit used to display time values. + */ + time?: TimeUnit } } diff --git a/specification/cat/nodeattrs/CatNodeAttributesRequest.ts b/specification/cat/nodeattrs/CatNodeAttributesRequest.ts index 5a80ee5950..d5b00a679b 100644 --- a/specification/cat/nodeattrs/CatNodeAttributesRequest.ts +++ b/specification/cat/nodeattrs/CatNodeAttributesRequest.ts @@ -18,6 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' +import { Duration } from '@_types/Time' /** * Get node attribute information. @@ -39,5 +40,10 @@ export interface Request extends CatRequestBase { * @server_default false */ local?: boolean + /** + * Period to wait for a connection to the master node. + * @server_default 30s + */ + master_timeout?: Duration } } diff --git a/specification/cat/nodes/CatNodesRequest.ts b/specification/cat/nodes/CatNodesRequest.ts index b3b1e0760f..f390bf9a36 100644 --- a/specification/cat/nodes/CatNodesRequest.ts +++ b/specification/cat/nodes/CatNodesRequest.ts @@ -19,6 +19,7 @@ import { CatRequestBase } from '@cat/_types/CatBase' import { Bytes } from '@_types/common' +import { Duration, TimeUnit } from '@_types/Time' /** * Get node information. @@ -46,5 +47,14 @@ export interface Request extends CatRequestBase { * @server_default false */ include_unloaded_segments?: boolean + /** + * Period to wait for a connection to the master node. + * @server_default 30s + */ + master_timeout?: Duration + /** + * Unit used to display time values. + */ + time?: TimeUnit } } diff --git a/specification/cat/pending_tasks/CatPendingTasksRequest.ts b/specification/cat/pending_tasks/CatPendingTasksRequest.ts index 087fa59dd5..ce3271faab 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 { Duration, TimeUnit } from '@_types/Time' /** * Get pending task information. @@ -39,5 +40,14 @@ export interface Request extends CatRequestBase { * @server_default false */ local?: boolean + /** + * Period to wait for a connection to the master node. + * @server_default 30s + */ + master_timeout?: Duration + /** + * Unit used to display time values. + */ + time?: TimeUnit } } diff --git a/specification/cat/plugins/CatPluginsRequest.ts b/specification/cat/plugins/CatPluginsRequest.ts index 2a074ef589..bf8b4e99fc 100644 --- a/specification/cat/plugins/CatPluginsRequest.ts +++ b/specification/cat/plugins/CatPluginsRequest.ts @@ -18,6 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' +import { Duration } from '@_types/Time' /** * Get plugin information. @@ -31,6 +32,11 @@ import { CatRequestBase } from '@cat/_types/CatBase' */ export interface Request extends CatRequestBase { query_parameters: { + /** + * Include bootstrap plugins in the response + * @server_default false + */ + include_bootstrap?: boolean /** * If `true`, the request computes the list of selected nodes from the * local cluster state. If `false` the list of selected nodes are computed @@ -39,5 +45,10 @@ export interface Request extends CatRequestBase { * @server_default false */ local?: boolean + /** + * Period to wait for a connection to the master node. + * @server_default 30s + */ + master_timeout?: Duration } } diff --git a/specification/cat/recovery/CatRecoveryRequest.ts b/specification/cat/recovery/CatRecoveryRequest.ts index 2779e2efa1..7c4c608b62 100644 --- a/specification/cat/recovery/CatRecoveryRequest.ts +++ b/specification/cat/recovery/CatRecoveryRequest.ts @@ -19,6 +19,7 @@ import { CatRequestBase } from '@cat/_types/CatBase' import { Bytes, Indices } from '@_types/common' +import { TimeUnit } from '@_types/Time' /** * Get shard recovery information. @@ -56,5 +57,9 @@ export interface Request extends CatRequestBase { * @server_default false */ detailed?: boolean + /** + * Unit used to display time values. + */ + time?: TimeUnit } } diff --git a/specification/cat/repositories/CatRepositoriesRequest.ts b/specification/cat/repositories/CatRepositoriesRequest.ts index 9b00a116ad..ed7827e3f4 100644 --- a/specification/cat/repositories/CatRepositoriesRequest.ts +++ b/specification/cat/repositories/CatRepositoriesRequest.ts @@ -18,6 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' +import { Duration } from '@_types/Time' /** * Get snapshot repository information. @@ -29,4 +30,20 @@ import { CatRequestBase } from '@cat/_types/CatBase' * @doc_id cat-repositories * @cluster_privileges monitor_snapshot */ -export interface Request extends CatRequestBase {} +export interface Request extends CatRequestBase { + query_parameters: { + /** + * If `true`, the request computes the list of selected nodes from the + * local cluster state. If `false` the list of selected nodes are computed + * from the cluster state of the master node. In both cases the coordinating + * node will send requests for further information to each selected node. + * @server_default false + */ + local?: boolean + /** + * Period to wait for a connection to the master node. + * @server_default 30s + */ + master_timeout?: Duration + } +} diff --git a/specification/cat/segments/CatSegmentsRequest.ts b/specification/cat/segments/CatSegmentsRequest.ts index b234c1cf6b..3aada4f955 100644 --- a/specification/cat/segments/CatSegmentsRequest.ts +++ b/specification/cat/segments/CatSegmentsRequest.ts @@ -19,6 +19,7 @@ import { CatRequestBase } from '@cat/_types/CatBase' import { Bytes, Indices } from '@_types/common' +import { Duration } from '@_types/Time' /** * Get segment information. @@ -54,5 +55,10 @@ export interface Request extends CatRequestBase { * @server_default false */ local?: boolean + /** + * Period to wait for a connection to the master node. + * @server_default 30s + */ + master_timeout?: Duration } } diff --git a/specification/cat/shards/CatShardsRequest.ts b/specification/cat/shards/CatShardsRequest.ts index 62409ca99e..e63fd50d6d 100644 --- a/specification/cat/shards/CatShardsRequest.ts +++ b/specification/cat/shards/CatShardsRequest.ts @@ -19,6 +19,7 @@ import { CatRequestBase } from '@cat/_types/CatBase' import { Bytes, Indices } from '@_types/common' +import { Duration, TimeUnit } from '@_types/Time' /** * Get shard information. @@ -46,5 +47,14 @@ export interface Request extends CatRequestBase { * The unit used to display byte values. */ bytes?: Bytes + /** + * Period to wait for a connection to the master node. + * @server_default 30s + */ + master_timeout?: Duration + /** + * Unit used to display time values. + */ + time?: TimeUnit } } diff --git a/specification/cat/snapshots/CatSnapshotsRequest.ts b/specification/cat/snapshots/CatSnapshotsRequest.ts index 7373228890..5fc943c11b 100644 --- a/specification/cat/snapshots/CatSnapshotsRequest.ts +++ b/specification/cat/snapshots/CatSnapshotsRequest.ts @@ -19,6 +19,7 @@ import { CatRequestBase } from '@cat/_types/CatBase' import { Names } from '@_types/common' +import { Duration, TimeUnit } from '@_types/Time' /** * Get snapshot information @@ -47,5 +48,14 @@ export interface Request extends CatRequestBase { * @server_default false */ ignore_unavailable?: boolean + /** + * Period to wait for a connection to the master node. + * @server_default 30s + */ + master_timeout?: Duration + /** + * Unit used to display time values. + */ + time?: TimeUnit } } diff --git a/specification/cat/tasks/CatTasksRequest.ts b/specification/cat/tasks/CatTasksRequest.ts index 94c3d93ca4..6743d62e09 100644 --- a/specification/cat/tasks/CatTasksRequest.ts +++ b/specification/cat/tasks/CatTasksRequest.ts @@ -18,6 +18,7 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' +import { Duration, TimeUnit } from '@_types/Time' /** * Get task information. @@ -41,8 +42,23 @@ export interface Request extends CatRequestBase { */ detailed?: boolean /** Unique node identifiers, which are used to limit the response. */ - node_id?: string[] + nodes?: string[] /** The parent task identifier, which is used to limit the response. */ parent_task_id?: string + /** + * Unit used to display time values. + */ + time?: TimeUnit + /** + * Period to wait for a response. + * If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + timeout?: Duration + /** + * If `true`, the request blocks until the task has completed. + * @server_default false + */ + wait_for_completion?: boolean } } diff --git a/specification/cat/templates/CatTemplatesRequest.ts b/specification/cat/templates/CatTemplatesRequest.ts index ffb820f319..d5ed200d57 100644 --- a/specification/cat/templates/CatTemplatesRequest.ts +++ b/specification/cat/templates/CatTemplatesRequest.ts @@ -19,6 +19,7 @@ import { CatRequestBase } from '@cat/_types/CatBase' import { Name } from '@_types/common' +import { Duration } from '@_types/Time' /** * Get index template information. @@ -48,5 +49,10 @@ export interface Request extends CatRequestBase { * @server_default false */ local?: boolean + /** + * Period to wait for a connection to the master node. + * @server_default 30s + */ + master_timeout?: Duration } } diff --git a/specification/cat/thread_pool/CatThreadPoolRequest.ts b/specification/cat/thread_pool/CatThreadPoolRequest.ts index a1b42b5bd6..65db7fd1ee 100644 --- a/specification/cat/thread_pool/CatThreadPoolRequest.ts +++ b/specification/cat/thread_pool/CatThreadPoolRequest.ts @@ -19,7 +19,7 @@ import { CatRequestBase } from '@cat/_types/CatBase' import { Names } from '@_types/common' -import { TimeUnit } from '@_types/Time' +import { Duration, TimeUnit } from '@_types/Time' /** * Get thread pool statistics. @@ -53,5 +53,10 @@ export interface Request extends CatRequestBase { * @server_default false */ local?: boolean + /** + * Period to wait for a connection to the master node. + * @server_default 30s + */ + master_timeout?: Duration } }