From c5bf6c656ffbcde5a037ec76267a12fd9717cc89 Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Wed, 18 Dec 2024 17:02:03 +0400 Subject: [PATCH] Fix cat common query parameters (#3340) (#3362) * Fix cat common query parameters Co-authored-by: Sylvain Wallez * Address review requests --------- Co-authored-by: Sylvain Wallez (cherry picked from commit eb357d581b62b371223de9a0064a220c055a7fe1) # Conflicts: # output/openapi/elasticsearch-openapi.json # output/openapi/elasticsearch-serverless-openapi.json # output/schema/schema-serverless.json # output/schema/schema.json # output/schema/validation-errors.json # output/typescript/types.ts # specification/cat/aliases/CatAliasesRequest.ts --- output/openapi/elasticsearch-openapi.json | 360 +++++++++++++- .../elasticsearch-serverless-openapi.json | 82 +++- output/schema/schema-serverless.json | 132 +++--- output/schema/schema.json | 445 ++++++++++++++---- output/schema/validation-errors.json | 31 +- output/typescript/types.ts | 38 +- specification/_spec_utils/behaviors.ts | 6 - .../cat/aliases/CatAliasesRequest.ts | 6 + .../cat/allocation/CatAllocationRequest.ts | 6 + .../CatComponentTemplatesRequest.ts | 6 + specification/cat/help/CatHelpRequest.ts | 4 +- specification/cat/help/CatHelpResponse.ts | 7 +- specification/cat/help/types.ts | 22 - .../cat/indices/CatIndicesRequest.ts | 7 +- specification/cat/master/CatMasterRequest.ts | 6 + .../CatDataFrameAnalyticsRequest.ts | 4 +- .../CatTrainedModelsRequest.ts | 5 + .../cat/nodeattrs/CatNodeAttributesRequest.ts | 6 + specification/cat/nodes/CatNodesRequest.ts | 10 + .../pending_tasks/CatPendingTasksRequest.ts | 10 + .../cat/plugins/CatPluginsRequest.ts | 11 + .../cat/recovery/CatRecoveryRequest.ts | 5 + .../repositories/CatRepositoriesRequest.ts | 19 +- .../cat/segments/CatSegmentsRequest.ts | 6 + specification/cat/shards/CatShardsRequest.ts | 10 + .../cat/snapshots/CatSnapshotsRequest.ts | 10 + specification/cat/tasks/CatTasksRequest.ts | 18 +- .../cat/templates/CatTemplatesRequest.ts | 6 + .../cat/thread_pool/CatThreadPoolRequest.ts | 7 +- 29 files changed, 1028 insertions(+), 257 deletions(-) delete mode 100644 specification/cat/help/types.ts diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 6566587658..c4b7a7b2e7 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -908,6 +908,9 @@ }, { "$ref": "#/components/parameters/cat.aliases#local" + }, + { + "$ref": "#/components/parameters/cat.aliases#master_timeout" } ], "responses": { @@ -934,6 +937,9 @@ }, { "$ref": "#/components/parameters/cat.aliases#local" + }, + { + "$ref": "#/components/parameters/cat.aliases#master_timeout" } ], "responses": { @@ -957,6 +963,9 @@ }, { "$ref": "#/components/parameters/cat.allocation#local" + }, + { + "$ref": "#/components/parameters/cat.allocation#master_timeout" } ], "responses": { @@ -983,6 +992,9 @@ }, { "$ref": "#/components/parameters/cat.allocation#local" + }, + { + "$ref": "#/components/parameters/cat.allocation#master_timeout" } ], "responses": { @@ -1003,6 +1015,9 @@ "parameters": [ { "$ref": "#/components/parameters/cat.component_templates#local" + }, + { + "$ref": "#/components/parameters/cat.component_templates#master_timeout" } ], "responses": { @@ -1027,6 +1042,9 @@ }, { "$ref": "#/components/parameters/cat.component_templates#local" + }, + { + "$ref": "#/components/parameters/cat.component_templates#master_timeout" } ], "responses": { @@ -1182,10 +1200,7 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/cat.help:HelpRecord" - } + "type": "object" } } } @@ -1219,6 +1234,9 @@ }, { "$ref": "#/components/parameters/cat.indices#time" + }, + { + "$ref": "#/components/parameters/cat.indices#master_timeout" } ], "responses": { @@ -1257,6 +1275,9 @@ }, { "$ref": "#/components/parameters/cat.indices#time" + }, + { + "$ref": "#/components/parameters/cat.indices#master_timeout" } ], "responses": { @@ -1284,6 +1305,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": { @@ -1530,6 +1561,9 @@ }, { "$ref": "#/components/parameters/cat.ml_trained_models#size" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#time" } ], "responses": { @@ -1569,6 +1603,9 @@ }, { "$ref": "#/components/parameters/cat.ml_trained_models#size" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#time" } ], "responses": { @@ -1597,6 +1634,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": { @@ -1661,6 +1708,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": { @@ -1698,6 +1765,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": { @@ -1726,6 +1813,16 @@ "description": "IMPORTANT: 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", @@ -1735,6 +1832,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": { @@ -1771,6 +1878,9 @@ }, { "$ref": "#/components/parameters/cat.recovery#detailed" + }, + { + "$ref": "#/components/parameters/cat.recovery#time" } ], "responses": { @@ -1800,6 +1910,9 @@ }, { "$ref": "#/components/parameters/cat.recovery#detailed" + }, + { + "$ref": "#/components/parameters/cat.recovery#time" } ], "responses": { @@ -1817,6 +1930,28 @@ "summary": "Returns the snapshot repositories for a cluster", "description": "IMPORTANT: 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": "", @@ -1849,6 +1984,9 @@ }, { "$ref": "#/components/parameters/cat.segments#local" + }, + { + "$ref": "#/components/parameters/cat.segments#master_timeout" } ], "responses": { @@ -1875,6 +2013,9 @@ }, { "$ref": "#/components/parameters/cat.segments#local" + }, + { + "$ref": "#/components/parameters/cat.segments#master_timeout" } ], "responses": { @@ -1895,6 +2036,12 @@ "parameters": [ { "$ref": "#/components/parameters/cat.shards#bytes" + }, + { + "$ref": "#/components/parameters/cat.shards#master_timeout" + }, + { + "$ref": "#/components/parameters/cat.shards#time" } ], "responses": { @@ -1918,6 +2065,12 @@ }, { "$ref": "#/components/parameters/cat.shards#bytes" + }, + { + "$ref": "#/components/parameters/cat.shards#master_timeout" + }, + { + "$ref": "#/components/parameters/cat.shards#time" } ], "responses": { @@ -1938,6 +2091,12 @@ "parameters": [ { "$ref": "#/components/parameters/cat.snapshots#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/cat.snapshots#master_timeout" + }, + { + "$ref": "#/components/parameters/cat.snapshots#time" } ], "responses": { @@ -1962,6 +2121,12 @@ }, { "$ref": "#/components/parameters/cat.snapshots#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/cat.snapshots#master_timeout" + }, + { + "$ref": "#/components/parameters/cat.snapshots#time" } ], "responses": { @@ -2006,7 +2171,7 @@ }, { "in": "query", - "name": "node_id", + "name": "nodes", "description": "Unique node identifiers, which are used to limit the response.", "deprecated": false, "schema": { @@ -2026,6 +2191,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": { @@ -2057,6 +2252,9 @@ "parameters": [ { "$ref": "#/components/parameters/cat.templates#local" + }, + { + "$ref": "#/components/parameters/cat.templates#master_timeout" } ], "responses": { @@ -2081,6 +2279,9 @@ }, { "$ref": "#/components/parameters/cat.templates#local" + }, + { + "$ref": "#/components/parameters/cat.templates#master_timeout" } ], "responses": { @@ -2105,6 +2306,9 @@ }, { "$ref": "#/components/parameters/cat.thread_pool#local" + }, + { + "$ref": "#/components/parameters/cat.thread_pool#master_timeout" } ], "responses": { @@ -2131,6 +2335,9 @@ }, { "$ref": "#/components/parameters/cat.thread_pool#local" + }, + { + "$ref": "#/components/parameters/cat.thread_pool#master_timeout" } ], "responses": { @@ -50176,17 +50383,6 @@ } } }, - "cat.help:HelpRecord": { - "type": "object", - "properties": { - "endpoint": { - "type": "string" - } - }, - "required": [ - "endpoint" - ] - }, "_types:HealthStatus": { "type": "string", "enum": [ @@ -94047,6 +94243,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", @@ -94078,6 +94284,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", @@ -94099,6 +94315,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", @@ -94212,6 +94438,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", @@ -94269,7 +94505,7 @@ "description": "Unit used to display time values.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "$ref": "#/components/schemas/_types:TimeUnit" }, "style": "form" }, @@ -94456,6 +94692,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", @@ -94497,6 +94743,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", @@ -94528,6 +94784,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", @@ -94549,6 +94815,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", @@ -94570,6 +94856,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", @@ -94591,6 +94897,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", @@ -94622,6 +94938,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 fd3041e4d7..d558df29e1 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -686,6 +686,9 @@ }, { "$ref": "#/components/parameters/cat.aliases#local" + }, + { + "$ref": "#/components/parameters/cat.aliases#master_timeout" } ], "responses": { @@ -712,6 +715,9 @@ }, { "$ref": "#/components/parameters/cat.aliases#local" + }, + { + "$ref": "#/components/parameters/cat.aliases#master_timeout" } ], "responses": { @@ -732,6 +738,9 @@ "parameters": [ { "$ref": "#/components/parameters/cat.component_templates#local" + }, + { + "$ref": "#/components/parameters/cat.component_templates#master_timeout" } ], "responses": { @@ -756,6 +765,9 @@ }, { "$ref": "#/components/parameters/cat.component_templates#local" + }, + { + "$ref": "#/components/parameters/cat.component_templates#master_timeout" } ], "responses": { @@ -815,10 +827,7 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/cat.help:HelpRecord" - } + "type": "object" } } } @@ -852,6 +861,9 @@ }, { "$ref": "#/components/parameters/cat.indices#time" + }, + { + "$ref": "#/components/parameters/cat.indices#master_timeout" } ], "responses": { @@ -890,6 +902,9 @@ }, { "$ref": "#/components/parameters/cat.indices#time" + }, + { + "$ref": "#/components/parameters/cat.indices#master_timeout" } ], "responses": { @@ -1126,6 +1141,9 @@ }, { "$ref": "#/components/parameters/cat.ml_trained_models#size" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#time" } ], "responses": { @@ -1165,6 +1183,9 @@ }, { "$ref": "#/components/parameters/cat.ml_trained_models#size" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#time" } ], "responses": { @@ -33264,17 +33285,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": [ @@ -57834,6 +57844,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", @@ -57855,6 +57875,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", @@ -57937,6 +57967,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", @@ -57994,7 +58034,7 @@ "description": "Unit used to display time values.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "$ref": "#/components/schemas/_types:TimeUnit" }, "style": "form" }, @@ -58181,6 +58221,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 f9039be2e6..92e38d4ffe 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -11622,9 +11622,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/aliases/CatAliasesRequest.ts#L23-L51" + "specLocation": "cat/aliases/CatAliasesRequest.ts#L24-L57" }, { "body": { @@ -11694,9 +11707,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": { @@ -11778,20 +11804,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", @@ -11799,28 +11815,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": [ @@ -11930,9 +11937,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": { @@ -12046,7 +12066,7 @@ "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "TimeUnit", "namespace": "_types" } } @@ -12412,9 +12432,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": { @@ -45562,7 +45594,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L29-L37" + "specLocation": "_spec_utils/behaviors.ts#L28-L36" }, { "codegenNames": [ @@ -49919,7 +49951,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L39-L48" + "specLocation": "_spec_utils/behaviors.ts#L38-L47" }, { "generics": [ @@ -106067,7 +106099,7 @@ } } ], - "specLocation": "_spec_utils/behaviors.ts#L50-L84" + "specLocation": "_spec_utils/behaviors.ts#L49-L83" }, { "kind": "interface", @@ -107356,19 +107388,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", @@ -107395,7 +107414,7 @@ } } ], - "specLocation": "_spec_utils/behaviors.ts#L86-L124" + "specLocation": "_spec_utils/behaviors.ts#L85-L118" }, { "kind": "interface", @@ -107667,27 +107686,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": { @@ -137047,7 +137045,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 9d80b212de..2ddc07a4fe 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -90786,9 +90786,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/aliases/CatAliasesRequest.ts#L23-L51" + "specLocation": "cat/aliases/CatAliasesRequest.ts#L24-L57" }, { "kind": "response", @@ -91219,9 +91232,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-L49" + "specLocation": "cat/allocation/CatAllocationRequest.ts#L24-L55" }, { "kind": "response", @@ -91378,9 +91404,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", @@ -92057,71 +92096,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", @@ -94313,9 +94312,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", @@ -94436,9 +94448,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-L42" + "specLocation": "cat/master/CatMasterRequest.ts#L23-L48" }, { "kind": "response", @@ -94809,7 +94834,7 @@ "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "TimeUnit", "namespace": "_types" } } @@ -96333,9 +96358,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", @@ -96795,9 +96832,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-L42" + "specLocation": "cat/nodeattrs/CatNodeAttributesRequest.ts#L23-L48" }, { "kind": "response", @@ -98406,9 +98456,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-L49" + "specLocation": "cat/nodes/CatNodesRequest.ts#L24-L59" }, { "kind": "response", @@ -98535,9 +98610,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-L42" + "specLocation": "cat/pending_tasks/CatPendingTasksRequest.ts#L23-L52" }, { "kind": "response", @@ -98679,6 +98779,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", @@ -98691,9 +98804,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-L42" + "specLocation": "cat/plugins/CatPluginsRequest.ts#L23-L53" }, { "kind": "response", @@ -99209,9 +99335,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-L59" + "specLocation": "cat/recovery/CatRecoveryRequest.ts#L24-L64" }, { "kind": "response", @@ -99295,8 +99433,35 @@ "namespace": "cat.repositories" }, "path": [], - "query": [], - "specLocation": "cat/repositories/CatRepositoriesRequest.ts#L22-L31" + "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-L48" }, { "kind": "response", @@ -99378,9 +99543,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-L57" + "specLocation": "cat/segments/CatSegmentsRequest.ts#L24-L63" }, { "kind": "response", @@ -99689,9 +99867,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-L49" + "specLocation": "cat/shards/CatShardsRequest.ts#L24-L59" }, { "kind": "response", @@ -101042,9 +101245,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-L50" + "specLocation": "cat/snapshots/CatSnapshotsRequest.ts#L24-L60" }, { "kind": "response", @@ -101365,7 +101593,7 @@ }, { "description": "Unique node identifiers, which are used to limit the response.", - "name": "node_id", + "name": "nodes", "required": false, "type": { "kind": "array_of", @@ -101389,9 +101617,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-L47" + "specLocation": "cat/tasks/CatTasksRequest.ts#L23-L63" }, { "kind": "response", @@ -101707,9 +101973,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-L51" + "specLocation": "cat/templates/CatTemplatesRequest.ts#L24-L57" }, { "kind": "response", @@ -101889,9 +102168,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-L56" + "specLocation": "cat/thread_pool/CatThreadPoolRequest.ts#L24-L61" }, { "kind": "response", @@ -222224,7 +222516,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L29-L37" + "specLocation": "_spec_utils/behaviors.ts#L28-L36" }, { "kind": "interface", @@ -222244,7 +222536,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L39-L48" + "specLocation": "_spec_utils/behaviors.ts#L38-L47" }, { "kind": "interface", @@ -222321,7 +222613,7 @@ } } ], - "specLocation": "_spec_utils/behaviors.ts#L50-L84" + "specLocation": "_spec_utils/behaviors.ts#L49-L83" }, { "kind": "interface", @@ -222369,19 +222661,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", @@ -222408,7 +222687,7 @@ } } ], - "specLocation": "_spec_utils/behaviors.ts#L86-L124" + "specLocation": "_spec_utils/behaviors.ts#L85-L118" }, { "kind": "interface", @@ -222424,7 +222703,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 cd8206b166..d4b0ff9fdb 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -51,6 +51,7 @@ }, "cat.aliases": { "request": [ + "Request: query parameter 'master_timeout' does not exist in the json spec", "Request: missing json spec query parameter 'format'", "Request: missing json spec query parameter 'h'", "Request: missing json spec query parameter 'help'", @@ -63,7 +64,6 @@ "cat.allocation": { "request": [ "Request: missing json spec query parameter 'format'", - "Request: missing json spec query parameter 'master_timeout'", "Request: missing json spec query parameter 'h'", "Request: missing json spec query parameter 'help'", "Request: missing json spec query parameter 's'", @@ -75,7 +75,6 @@ "cat.component_templates": { "request": [ "Request: missing json spec query parameter 'format'", - "Request: missing json spec query parameter 'master_timeout'", "Request: missing json spec query parameter 'h'", "Request: missing json spec query parameter 'help'", "Request: missing json spec query parameter 's'", @@ -120,15 +119,13 @@ "cat.help": { "request": [ "Request: missing json spec query parameter 'help'", - "Request: missing json spec query parameter 's'", - "request definition cat.help:Request / body - A request with inherited properties must have a PropertyBody" + "Request: missing json spec query parameter 's'" ], "response": [] }, "cat.indices": { "request": [ "Request: missing json spec query parameter 'format'", - "Request: missing json spec query parameter 'master_timeout'", "Request: missing json spec query parameter 'h'", "Request: missing json spec query parameter 'help'", "Request: missing json spec query parameter 's'", @@ -140,7 +137,6 @@ "cat.master": { "request": [ "Request: missing json spec query parameter 'format'", - "Request: missing json spec query parameter 'master_timeout'", "Request: missing json spec query parameter 'h'", "Request: missing json spec query parameter 'help'", "Request: missing json spec query parameter 's'", @@ -186,7 +182,6 @@ "request": [ "Request: missing json spec query parameter 'format'", "Request: missing json spec query parameter 'help'", - "Request: missing json spec query parameter 'time'", "Request: missing json spec query parameter 'v'", "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", @@ -197,7 +192,6 @@ "cat.nodeattrs": { "request": [ "Request: missing json spec query parameter 'format'", - "Request: missing json spec query parameter 'master_timeout'", "Request: missing json spec query parameter 'h'", "Request: missing json spec query parameter 'help'", "Request: missing json spec query parameter 's'", @@ -209,11 +203,9 @@ "cat.nodes": { "request": [ "Request: missing json spec query parameter 'format'", - "Request: missing json spec query parameter 'master_timeout'", "Request: missing json spec query parameter 'h'", "Request: missing json spec query parameter 'help'", "Request: missing json spec query parameter 's'", - "Request: missing json spec query parameter 'time'", "Request: missing json spec query parameter 'v'", "request definition cat.nodes:Request / body - A request with inherited properties must have a PropertyBody" ], @@ -222,11 +214,9 @@ "cat.pending_tasks": { "request": [ "Request: missing json spec query parameter 'format'", - "Request: missing json spec query parameter 'master_timeout'", "Request: missing json spec query parameter 'h'", "Request: missing json spec query parameter 'help'", "Request: missing json spec query parameter 's'", - "Request: missing json spec query parameter 'time'", "Request: missing json spec query parameter 'v'", "request definition cat.pending_tasks:Request / body - A request with inherited properties must have a PropertyBody" ], @@ -235,10 +225,8 @@ "cat.plugins": { "request": [ "Request: missing json spec query parameter 'format'", - "Request: missing json spec query parameter 'master_timeout'", "Request: missing json spec query parameter 'h'", "Request: missing json spec query parameter 'help'", - "Request: missing json spec query parameter 'include_bootstrap'", "Request: missing json spec query parameter 's'", "Request: missing json spec query parameter 'v'", "request definition cat.plugins:Request / body - A request with inherited properties must have a PropertyBody" @@ -252,7 +240,6 @@ "Request: missing json spec query parameter 'help'", "Request: missing json spec query parameter 'index'", "Request: missing json spec query parameter 's'", - "Request: missing json spec query parameter 'time'", "Request: missing json spec query parameter 'v'", "request definition cat.recovery:Request / body - A request with inherited properties must have a PropertyBody" ], @@ -261,8 +248,6 @@ "cat.repositories": { "request": [ "Request: missing json spec query parameter 'format'", - "Request: missing json spec query parameter 'local'", - "Request: missing json spec query parameter 'master_timeout'", "Request: missing json spec query parameter 'h'", "Request: missing json spec query parameter 'help'", "Request: missing json spec query parameter 's'", @@ -274,6 +259,7 @@ "cat.segments": { "request": [ "Request: query parameter 'local' 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 'format'", "Request: missing json spec query parameter 'h'", "Request: missing json spec query parameter 'help'", @@ -286,11 +272,9 @@ "cat.shards": { "request": [ "Request: missing json spec query parameter 'format'", - "Request: missing json spec query parameter 'master_timeout'", "Request: missing json spec query parameter 'h'", "Request: missing json spec query parameter 'help'", "Request: missing json spec query parameter 's'", - "Request: missing json spec query parameter 'time'", "Request: missing json spec query parameter 'v'", "request definition cat.shards:Request / body - A request with inherited properties must have a PropertyBody" ], @@ -299,11 +283,9 @@ "cat.snapshots": { "request": [ "Request: missing json spec query parameter 'format'", - "Request: missing json spec query parameter 'master_timeout'", "Request: missing json spec query parameter 'h'", "Request: missing json spec query parameter 'help'", "Request: missing json spec query parameter 's'", - "Request: missing json spec query parameter 'time'", "Request: missing json spec query parameter 'v'", "request definition cat.snapshots:Request / body - A request with inherited properties must have a PropertyBody" ], @@ -311,13 +293,12 @@ }, "cat.tasks": { "request": [ - "Request: query parameter 'node_id' does not exist in the json spec", + "Request: query parameter 'timeout' does not exist in the json spec", + "Request: query parameter 'wait_for_completion' does not exist in the json spec", "Request: missing json spec query parameter 'format'", - "Request: missing json spec query parameter 'nodes'", "Request: missing json spec query parameter 'h'", "Request: missing json spec query parameter 'help'", "Request: missing json spec query parameter 's'", - "Request: missing json spec query parameter 'time'", "Request: missing json spec query parameter 'v'", "request definition cat.tasks:Request / body - A request with inherited properties must have a PropertyBody" ], @@ -326,7 +307,6 @@ "cat.templates": { "request": [ "Request: missing json spec query parameter 'format'", - "Request: missing json spec query parameter 'master_timeout'", "Request: missing json spec query parameter 'h'", "Request: missing json spec query parameter 'help'", "Request: missing json spec query parameter 's'", @@ -338,7 +318,6 @@ "cat.thread_pool": { "request": [ "Request: missing json spec query parameter 'format'", - "Request: missing json spec query parameter 'master_timeout'", "Request: missing json spec query parameter 'h'", "Request: missing json spec query parameter 'help'", "Request: missing json spec query parameter 's'", diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 5fb4e65679..7dbc544181 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -6940,6 +6940,7 @@ export interface CatAliasesRequest extends CatCatRequestBase { name?: Names expand_wildcards?: ExpandWildcards local?: boolean + master_timeout?: Duration } export type CatAliasesResponse = CatAliasesAliasesRecord[] @@ -6984,6 +6985,7 @@ export interface CatAllocationRequest extends CatCatRequestBase { node_id?: NodeIds bytes?: Bytes local?: boolean + master_timeout?: Duration } export type CatAllocationResponse = CatAllocationAllocationRecord[] @@ -7001,6 +7003,7 @@ export interface CatComponentTemplatesComponentTemplate { export interface CatComponentTemplatesRequest extends CatCatRequestBase { name?: string local?: boolean + master_timeout?: Duration } export type CatComponentTemplatesResponse = CatComponentTemplatesComponentTemplate[] @@ -7104,15 +7107,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 @@ -7412,6 +7412,7 @@ export interface CatIndicesRequest extends CatCatRequestBase { include_unloaded_segments?: boolean pri?: boolean time?: TimeUnit + master_timeout?: Duration } export type CatIndicesResponse = CatIndicesIndicesRecord[] @@ -7427,6 +7428,7 @@ export interface CatMasterMasterRecord { export interface CatMasterRequest extends CatCatRequestBase { local?: boolean + master_timeout?: Duration } export type CatMasterResponse = CatMasterMasterRecord[] @@ -7481,7 +7483,7 @@ export interface CatMlDataFrameAnalyticsRequest extends CatCatRequestBase { bytes?: Bytes h?: CatCatDfaColumns s?: CatCatDfaColumns - time?: Duration + time?: TimeUnit } export type CatMlDataFrameAnalyticsResponse = CatMlDataFrameAnalyticsDataFrameAnalyticsRecord[] @@ -7727,6 +7729,7 @@ export interface CatMlTrainedModelsRequest extends CatCatRequestBase { s?: CatCatTrainedModelsColumns from?: integer size?: integer + time?: TimeUnit } export type CatMlTrainedModelsResponse = CatMlTrainedModelsTrainedModelsRecord[] @@ -7795,6 +7798,7 @@ export interface CatNodeattrsNodeAttributesRecord { export interface CatNodeattrsRequest extends CatCatRequestBase { local?: boolean + master_timeout?: Duration } export type CatNodeattrsResponse = CatNodeattrsNodeAttributesRecord[] @@ -8073,6 +8077,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[] @@ -8090,6 +8096,8 @@ export interface CatPendingTasksPendingTasksRecord { export interface CatPendingTasksRequest extends CatCatRequestBase { local?: boolean + master_timeout?: Duration + time?: TimeUnit } export type CatPendingTasksResponse = CatPendingTasksPendingTasksRecord[] @@ -8109,7 +8117,9 @@ export interface CatPluginsPluginsRecord { } export interface CatPluginsRequest extends CatCatRequestBase { + include_bootstrap?: boolean local?: boolean + master_timeout?: Duration } export type CatPluginsResponse = CatPluginsPluginsRecord[] @@ -8177,6 +8187,7 @@ export interface CatRecoveryRequest extends CatCatRequestBase { active_only?: boolean bytes?: Bytes detailed?: boolean + time?: TimeUnit } export type CatRecoveryResponse = CatRecoveryRecoveryRecord[] @@ -8189,6 +8200,8 @@ export interface CatRepositoriesRepositoriesRecord { } export interface CatRepositoriesRequest extends CatCatRequestBase { + local?: boolean + master_timeout?: Duration } export type CatRepositoriesResponse = CatRepositoriesRepositoriesRecord[] @@ -8197,6 +8210,7 @@ export interface CatSegmentsRequest extends CatCatRequestBase { index?: Indices bytes?: Bytes local?: boolean + master_timeout?: Duration } export type CatSegmentsResponse = CatSegmentsSegmentsRecord[] @@ -8246,6 +8260,8 @@ export interface CatSegmentsSegmentsRecord { export interface CatShardsRequest extends CatCatRequestBase { index?: Indices bytes?: Bytes + master_timeout?: Duration + time?: TimeUnit } export type CatShardsResponse = CatShardsShardsRecord[] @@ -8468,6 +8484,8 @@ export interface CatShardsShardsRecord { export interface CatSnapshotsRequest extends CatCatRequestBase { repository?: Names ignore_unavailable?: boolean + master_timeout?: Duration + time?: TimeUnit } export type CatSnapshotsResponse = CatSnapshotsSnapshotsRecord[] @@ -8509,8 +8527,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[] @@ -8553,6 +8574,7 @@ export interface CatTasksTasksRecord { export interface CatTemplatesRequest extends CatCatRequestBase { name?: Name local?: boolean + master_timeout?: Duration } export type CatTemplatesResponse = CatTemplatesTemplatesRecord[] @@ -8575,6 +8597,7 @@ export interface CatThreadPoolRequest extends CatCatRequestBase { thread_pool_patterns?: Names time?: TimeUnit local?: boolean + master_timeout?: Duration } export type CatThreadPoolResponse = CatThreadPoolThreadPoolRecord[] @@ -21337,7 +21360,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 c890eeddc9..4aa4613fdd 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. @@ -47,5 +48,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/allocation/CatAllocationRequest.ts b/specification/cat/allocation/CatAllocationRequest.ts index f29817b4d4..8128caf67b 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' /** * Provides a snapshot of the number of shards allocated to each data node and their disk space. @@ -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/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 48e80f9455..e6d010bcb2 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' /** * Returns information about the master node, including the ID, bound IP address, and name. @@ -38,5 +39,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 9bae2d680f..7bd515b027 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' /** * Returns information about custom node attributes. @@ -38,5 +39,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 97d709f9c7..953afcf292 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' /** * Returns information about the nodes in a cluster. @@ -45,5 +46,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 0d316f233d..27f0e76fd4 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' /** * Returns cluster-level changes that have not yet been executed. @@ -38,5 +39,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 8a1c715d04..97b392cc71 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' /** * Returns a list of plugins running on each node of a cluster. @@ -30,6 +31,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 @@ -38,5 +44,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 666ef6a06c..516bf08e3f 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' /** * Returns information about ongoing and completed shard recoveries. @@ -55,5 +56,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 2ce038260a..08c1ae9700 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' /** * Returns the snapshot repositories for a cluster. @@ -28,4 +29,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 673b83f374..62b5791fd4 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' /** * Returns low-level information about the Lucene segments in index shards. @@ -53,5 +54,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 fa6a11f221..880b6e36c4 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' /** * Returns information about the shards in a cluster. @@ -45,5 +46,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 fa54d7e435..b3e8750c5a 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' /** * Returns information about the snapshots stored in one or more repositories. @@ -46,5 +47,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 e583d4029b..f6c0c2c6b3 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' /** * Returns information about tasks currently executing in the cluster. @@ -40,8 +41,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 00a18d6492..634190943d 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' /** * Returns information about index templates in a cluster. @@ -47,5 +48,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 b8046a83d4..b20d01ae6f 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' /** * Returns thread pool statistics for each node in a cluster. @@ -52,5 +52,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 } }