From f1159d6e93902cac874b97e5128bf2ba6d41c368 Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Thu, 9 Oct 2025 18:22:23 +0400 Subject: [PATCH] Add default values from rest-api-spec (#5454) * Add default values from rest-api-spec * Run make contrib (cherry picked from commit 88ed8664f1c6662d0a277627092255bde3259c5c) --- output/openapi/elasticsearch-openapi.json | 12 +- .../elasticsearch-serverless-openapi.json | 8 +- output/schema/schema.json | 135 ++++++++++++------ .../_global/get_script/GetScriptRequest.ts | 2 +- .../_global/reindex/ReindexRequest.ts | 1 + .../_global/search_mvt/SearchMvtRequest.ts | 2 + .../submit/AsyncSearchSubmitRequest.ts | 15 ++ .../CatDataFrameAnalyticsRequest.ts | 5 + .../CatTrainedModelsRequest.ts | 10 +- .../ccr/follow/CreateFollowIndexRequest.ts | 1 + .../delete/ConnectorDeleteRequest.ts | 3 +- .../connector/list/ConnectorListRequest.ts | 4 +- .../sync_job_list/SyncJobListRequest.ts | 4 +- .../DeleteDanglingIndexRequest.ts | 3 + .../ImportDanglingIndexRequest.ts | 3 + specification/eql/get/EqlGetRequest.ts | 1 + .../esql/async_query/AsyncQueryRequest.ts | 1 + specification/esql/query/QueryRequest.ts | 1 + .../IndicesDeleteDataLifecycleRequest.ts | 3 + .../IndicesDeleteDataStreamOptionsRequest.ts | 3 + .../IndicesExplainDataLifecycleRequest.ts | 3 + .../forcemerge/IndicesForceMergeRequest.ts | 3 + .../IndicesPutIndexTemplateRequest.ts | 4 +- .../put_template/IndicesPutTemplateRequest.ts | 4 +- .../IndicesSimulateTemplateRequest.ts | 1 + .../indices/stats/IndicesStatsRequest.ts | 3 +- .../simulate/SimulatePipelineRequest.ts | 1 + .../ml/delete_job/MlDeleteJobRequest.ts | 1 + .../MlPutTrainedModelRequest.ts | 2 + .../nodes/stats/NodesStatsRequest.ts | 5 +- .../list_rulesets/QueryRulesetListRequest.ts | 1 + .../rollup_search/RollupSearchRequest.ts | 3 + .../stats/SearchableSnapshotsStatsRequest.ts | 3 + .../SecurityGetSettingsRequest.ts | 1 + .../query_api_keys/QueryApiKeysRequest.ts | 1 + .../SecurityUpdateSettingsRequest.ts | 1 + .../SnapshotGetRepositoryRequest.ts | 2 +- .../sql/get_async/SqlGetAsyncRequest.ts | 1 + specification/tasks/list/ListTasksRequest.ts | 1 + .../get_settings/WatcherGetSettingsRequest.ts | 1 + .../WatcherUpdateSettingsRequest.ts | 1 + 41 files changed, 194 insertions(+), 66 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 09dcfc3ac1..8f8063df50 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -5813,7 +5813,7 @@ { "in": "query", "name": "delete_sync_jobs", - "description": "A flag indicating if associated sync jobs should be also removed. Defaults to false.", + "description": "A flag indicating if associated sync jobs should be also removed.", "deprecated": false, "schema": { "type": "boolean" @@ -5869,7 +5869,7 @@ { "in": "query", "name": "from", - "description": "Starting offset (default: 0)", + "description": "Starting offset", "deprecated": false, "schema": { "type": "number" @@ -6406,7 +6406,7 @@ { "in": "query", "name": "from", - "description": "Starting offset (default: 0)", + "description": "Starting offset", "deprecated": false, "schema": { "type": "number" @@ -137047,7 +137047,7 @@ "cat.ml_data_frame_analytics-allow_no_match": { "in": "query", "name": "allow_no_match", - "description": "Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)", + "description": "Whether to ignore if a wildcard expression matches no configs.\n(This includes `_all` string or when no configs have been specified.)", "deprecated": false, "schema": { "type": "boolean" @@ -141369,7 +141369,7 @@ "indices.stats-level": { "in": "query", "name": "level", - "description": "Indicates whether statistics are aggregated at the cluster, index, or shard level.", + "description": "Indicates whether statistics are aggregated at the cluster, indices, or shards level.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.Level" @@ -143516,7 +143516,7 @@ "nodes.stats-level": { "in": "query", "name": "level", - "description": "Indicates whether statistics are aggregated at the cluster, index, or shard level.", + "description": "Indicates whether statistics are aggregated at the node, indices, or shards level.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.NodeStatsLevel" diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index ee474c9c2c..cdd238e56c 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -2294,7 +2294,7 @@ { "in": "query", "name": "delete_sync_jobs", - "description": "A flag indicating if associated sync jobs should be also removed. Defaults to false.", + "description": "A flag indicating if associated sync jobs should be also removed.", "deprecated": false, "schema": { "type": "boolean" @@ -2350,7 +2350,7 @@ { "in": "query", "name": "from", - "description": "Starting offset (default: 0)", + "description": "Starting offset", "deprecated": false, "schema": { "type": "number" @@ -2708,7 +2708,7 @@ { "in": "query", "name": "from", - "description": "Starting offset (default: 0)", + "description": "Starting offset", "deprecated": false, "schema": { "type": "number" @@ -84124,7 +84124,7 @@ "cat.ml_data_frame_analytics-allow_no_match": { "in": "query", "name": "allow_no_match", - "description": "Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)", + "description": "Whether to ignore if a wildcard expression matches no configs.\n(This includes `_all` string or when no configs have been specified.)", "deprecated": false, "schema": { "type": "boolean" diff --git a/output/schema/schema.json b/output/schema/schema.json index 732abba1ce..98de41dd97 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -29987,7 +29987,7 @@ "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "name": "master_timeout", "required": false, - "serverDefault": "", + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -36560,6 +36560,7 @@ "description": "The period of time that a consistent view of the index should be maintained for scrolled search.", "name": "scroll", "required": false, + "serverDefault": "5m", "type": { "kind": "instance_of", "type": { @@ -36648,7 +36649,7 @@ } } ], - "specLocation": "_global/reindex/ReindexRequest.ts#L27-L184" + "specLocation": "_global/reindex/ReindexRequest.ts#L27-L185" }, { "kind": "response", @@ -46215,6 +46216,7 @@ "description": "Aggregation used to create a grid for `field`.", "name": "grid_agg", "required": false, + "serverDefault": "geotile", "type": { "kind": "instance_of", "type": { @@ -46298,6 +46300,7 @@ "description": "If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.\n\n* `Point` and `MultiPoint` features will have one of the points selected.\n* `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree.\n* `LineString` features will likewise provide a roughly central point selected from the triangle-tree.\n* The aggregation results will provide one central point for each aggregation bucket.\n\nAll attributes from the original features will also be copied to the new label features.\nIn addition, the new features will be distinguishable using the tag `_mvt_label_position`.", "name": "with_labels", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -46307,7 +46310,7 @@ } } ], - "specLocation": "_global/search_mvt/SearchMvtRequest.ts#L33-L346" + "specLocation": "_global/search_mvt/SearchMvtRequest.ts#L33-L348" }, { "kind": "response", @@ -99592,6 +99595,7 @@ "description": "Indicate if an error should be returned if there is a partial search failure or timeout", "name": "allow_partial_search_results", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -99654,6 +99658,7 @@ "description": "The default operator for query string query (AND or OR)", "name": "default_operator", "required": false, + "serverDefault": "or", "type": { "kind": "instance_of", "type": { @@ -99750,6 +99755,7 @@ "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", "name": "max_concurrent_shard_requests", "required": false, + "serverDefault": 5, "type": { "kind": "instance_of", "type": { @@ -99869,6 +99875,7 @@ "description": "Specify suggest mode", "name": "suggest_mode", "required": false, + "serverDefault": "missing", "type": { "kind": "instance_of", "type": { @@ -99965,6 +99972,7 @@ "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "name": "rest_total_hits_as_int", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -100097,7 +100105,7 @@ } } ], - "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L307" + "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L322" }, { "kind": "response", @@ -110773,9 +110781,10 @@ ], "query": [ { - "description": "Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)", + "description": "Whether to ignore if a wildcard expression matches no configs.\n(This includes `_all` string or when no configs have been specified.)", "name": "allow_no_match", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -110810,7 +110819,7 @@ } } ], - "specLocation": "cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts#L23-L64" + "specLocation": "cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts#L23-L69" }, { "kind": "response", @@ -112363,6 +112372,7 @@ "description": "Skips the specified number of transforms.", "name": "from", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -112375,6 +112385,7 @@ "description": "The maximum number of transforms to display.", "name": "size", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { @@ -112384,7 +112395,7 @@ } } ], - "specLocation": "cat/ml_trained_models/CatTrainedModelsRequest.ts#L24-L73" + "specLocation": "cat/ml_trained_models/CatTrainedModelsRequest.ts#L24-L79" }, { "kind": "response", @@ -120778,6 +120789,7 @@ "description": "Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be\nactive.\nA shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the\nremote Lucene segment files to the follower index.", "name": "wait_for_active_shards", "required": false, + "serverDefault": "0", "type": { "kind": "instance_of", "type": { @@ -120787,7 +120799,7 @@ } } ], - "specLocation": "ccr/follow/CreateFollowIndexRequest.ts#L26-L124" + "specLocation": "ccr/follow/CreateFollowIndexRequest.ts#L26-L125" }, { "kind": "response", @@ -134183,9 +134195,10 @@ ], "query": [ { - "description": "A flag indicating if associated sync jobs should be also removed. Defaults to false.", + "description": "A flag indicating if associated sync jobs should be also removed.", "name": "delete_sync_jobs", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -134208,7 +134221,7 @@ } } ], - "specLocation": "connector/delete/ConnectorDeleteRequest.ts#L22-L58" + "specLocation": "connector/delete/ConnectorDeleteRequest.ts#L22-L59" }, { "kind": "response", @@ -134597,9 +134610,10 @@ "path": [], "query": [ { - "description": "Starting offset (default: 0)", + "description": "Starting offset", "name": "from", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -134612,6 +134626,7 @@ "description": "Specifies a max number of results to get", "name": "size", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { @@ -134682,7 +134697,7 @@ } } ], - "specLocation": "connector/list/ConnectorListRequest.ts#L23-L70" + "specLocation": "connector/list/ConnectorListRequest.ts#L23-L72" }, { "kind": "response", @@ -135615,9 +135630,10 @@ "path": [], "query": [ { - "description": "Starting offset (default: 0)", + "description": "Starting offset", "name": "from", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -135630,6 +135646,7 @@ "description": "Specifies a max number of results to get", "name": "size", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { @@ -135690,7 +135707,7 @@ } } ], - "specLocation": "connector/sync_job_list/SyncJobListRequest.ts#L25-L63" + "specLocation": "connector/sync_job_list/SyncJobListRequest.ts#L25-L65" }, { "kind": "response", @@ -137631,6 +137648,7 @@ "description": "Specify timeout for connection to master", "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -137652,7 +137670,7 @@ } } ], - "specLocation": "dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts#L24-L55" + "specLocation": "dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts#L24-L58" }, { "kind": "response", @@ -137750,6 +137768,7 @@ "description": "Specify timeout for connection to master", "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -137771,7 +137790,7 @@ } } ], - "specLocation": "dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts#L24-L57" + "specLocation": "dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts#L24-L60" }, { "kind": "response", @@ -139415,6 +139434,7 @@ "description": "Period for which the search and its results are stored on the cluster.\nDefaults to the keep_alive value set by the search’s EQL search API request.", "name": "keep_alive", "required": false, + "serverDefault": "5d", "type": { "kind": "instance_of", "type": { @@ -139436,7 +139456,7 @@ } } ], - "specLocation": "eql/get/EqlGetRequest.ts#L24-L57" + "specLocation": "eql/get/EqlGetRequest.ts#L24-L58" }, { "kind": "response", @@ -141165,6 +141185,7 @@ "description": "The character to use between values within a CSV row.\nIt is valid only for the CSV format.", "name": "delimiter", "required": false, + "serverDefault": ",", "type": { "kind": "instance_of", "type": { @@ -141199,7 +141220,7 @@ } } ], - "specLocation": "esql/async_query/AsyncQueryRequest.ts#L28-L139" + "specLocation": "esql/async_query/AsyncQueryRequest.ts#L28-L140" }, { "kind": "response", @@ -141976,6 +141997,7 @@ "description": "The character to use between values within a CSV row. Only valid for the CSV format.", "name": "delimiter", "required": false, + "serverDefault": ",", "type": { "kind": "instance_of", "type": { @@ -142011,7 +142033,7 @@ } } ], - "specLocation": "esql/query/QueryRequest.ts#L27-L116" + "specLocation": "esql/query/QueryRequest.ts#L27-L117" }, { "kind": "response", @@ -155192,6 +155214,7 @@ "description": "Specify timeout for connection to master", "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -155213,7 +155236,7 @@ } } ], - "specLocation": "indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts#L24-L48" + "specLocation": "indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts#L24-L51" }, { "kind": "response", @@ -155399,6 +155422,7 @@ "description": "Specify timeout for connection to master", "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -155420,7 +155444,7 @@ } } ], - "specLocation": "indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts#L24-L48" + "specLocation": "indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts#L24-L51" }, { "kind": "response", @@ -156615,6 +156639,7 @@ "description": "Specify timeout for connection to master", "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -156624,7 +156649,7 @@ } } ], - "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts#L24-L48" + "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts#L24-L51" }, { "kind": "response", @@ -157463,6 +157488,7 @@ "description": "Should the request wait until the force merge is completed.", "name": "wait_for_completion", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -157472,7 +157498,7 @@ } } ], - "specLocation": "indices/forcemerge/IndicesForceMergeRequest.ts#L24-L108" + "specLocation": "indices/forcemerge/IndicesForceMergeRequest.ts#L24-L111" }, { "kind": "response", @@ -162036,7 +162062,7 @@ } } ], - "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L159-L181" + "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L161-L183" }, { "kind": "request", @@ -162289,6 +162315,7 @@ "description": "User defined reason for creating/updating the index template", "name": "cause", "required": false, + "serverDefault": "api", "type": { "kind": "instance_of", "type": { @@ -162298,7 +162325,7 @@ } } ], - "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L37-L157" + "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L37-L159" }, { "kind": "response", @@ -163136,6 +163163,7 @@ "description": "User defined reason for creating/updating the index template", "name": "cause", "required": false, + "serverDefault": "", "type": { "kind": "instance_of", "type": { @@ -163145,7 +163173,7 @@ } } ], - "specLocation": "indices/put_template/IndicesPutTemplateRequest.ts#L29-L124" + "specLocation": "indices/put_template/IndicesPutTemplateRequest.ts#L29-L126" }, { "kind": "response", @@ -167542,6 +167570,7 @@ "description": "User defined reason for dry-run creating the new template for simulation purposes", "name": "cause", "required": false, + "serverDefault": "false", "type": { "kind": "instance_of", "type": { @@ -167586,7 +167615,7 @@ } } ], - "specLocation": "indices/simulate_template/IndicesSimulateTemplateRequest.ts#L27-L135" + "specLocation": "indices/simulate_template/IndicesSimulateTemplateRequest.ts#L27-L136" }, { "kind": "response", @@ -168484,9 +168513,10 @@ } }, { - "description": "Indicates whether statistics are aggregated at the cluster, index, or shard level.", + "description": "Indicates whether statistics are aggregated at the cluster, indices, or shards level.", "name": "level", "required": false, + "serverDefault": "indices", "type": { "kind": "instance_of", "type": { @@ -168496,7 +168526,7 @@ } } ], - "specLocation": "indices/stats/IndicesStatsRequest.ts#L29-L113" + "specLocation": "indices/stats/IndicesStatsRequest.ts#L29-L114" }, { "kind": "response", @@ -188748,6 +188778,7 @@ "description": "If `true`, the response includes output data for each processor in the executed pipeline.", "name": "verbose", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -188757,7 +188788,7 @@ } } ], - "specLocation": "ingest/simulate/SimulatePipelineRequest.ts#L25-L72" + "specLocation": "ingest/simulate/SimulatePipelineRequest.ts#L25-L73" }, { "kind": "response", @@ -205265,6 +205296,7 @@ "description": "Use to forcefully delete an opened job; this method is quicker than\nclosing and deleting the job.", "name": "force", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -205300,7 +205332,7 @@ } } ], - "specLocation": "ml/delete_job/MlDeleteJobRequest.ts#L23-L72" + "specLocation": "ml/delete_job/MlDeleteJobRequest.ts#L23-L73" }, { "kind": "response", @@ -214942,6 +214974,7 @@ "description": "If set to `true` and a `compressed_definition` is provided,\nthe request defers definition decompression and skips relevant\nvalidations.", "name": "defer_definition_decompression", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -214960,6 +214993,7 @@ "description": "Whether to wait for all child operations (e.g. model download)\nto complete.", "name": "wait_for_completion", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -214969,7 +215003,7 @@ } } ], - "specLocation": "ml/put_trained_model/MlPutTrainedModelRequest.ts#L31-L135" + "specLocation": "ml/put_trained_model/MlPutTrainedModelRequest.ts#L31-L137" }, { "kind": "response", @@ -227804,9 +227838,10 @@ } }, { - "description": "Indicates whether statistics are aggregated at the cluster, index, or shard level.", + "description": "Indicates whether statistics are aggregated at the node, indices, or shards level.", "name": "level", "required": false, + "serverDefault": "node", "type": { "kind": "instance_of", "type": { @@ -227857,7 +227892,7 @@ } } ], - "specLocation": "nodes/stats/NodesStatsRequest.ts#L24-L99" + "specLocation": "nodes/stats/NodesStatsRequest.ts#L24-L102" }, { "kind": "response", @@ -229144,6 +229179,7 @@ "description": "The maximum number of results to retrieve.", "name": "size", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { @@ -229153,7 +229189,7 @@ } } ], - "specLocation": "query_rules/list_rulesets/QueryRulesetListRequest.ts#L22-L50" + "specLocation": "query_rules/list_rulesets/QueryRulesetListRequest.ts#L22-L51" }, { "kind": "response", @@ -231305,6 +231341,7 @@ "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "name": "rest_total_hits_as_int", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -231326,7 +231363,7 @@ } } ], - "specLocation": "rollup/rollup_search/RollupSearchRequest.ts#L27-L86" + "specLocation": "rollup/rollup_search/RollupSearchRequest.ts#L27-L89" }, { "kind": "response", @@ -233638,6 +233675,7 @@ "description": "Return stats aggregated at cluster, index or shard level", "name": "level", "required": false, + "serverDefault": "indices", "type": { "kind": "instance_of", "type": { @@ -233647,7 +233685,7 @@ } } ], - "specLocation": "searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts#L24-L52" + "specLocation": "searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts#L24-L55" }, { "kind": "response", @@ -241834,6 +241872,7 @@ "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -241843,7 +241882,7 @@ } } ], - "specLocation": "security/get_settings/SecurityGetSettingsRequest.ts#L23-L51" + "specLocation": "security/get_settings/SecurityGetSettingsRequest.ts#L23-L52" }, { "kind": "response", @@ -247001,6 +247040,7 @@ "description": "Return the snapshot of the owner user's role descriptors associated with the API key.\nAn API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors (effectively limited by it).\nAn API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has `manage_api_key` or higher privileges.", "name": "with_limited_by", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -247048,7 +247088,7 @@ } } ], - "specLocation": "security/query_api_keys/QueryApiKeysRequest.ts#L26-L126" + "specLocation": "security/query_api_keys/QueryApiKeysRequest.ts#L26-L127" }, { "kind": "response", @@ -249632,6 +249672,7 @@ "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -249653,7 +249694,7 @@ } } ], - "specLocation": "security/update_settings/SecurityUpdateSettingsRequest.ts#L24-L71" + "specLocation": "security/update_settings/SecurityUpdateSettingsRequest.ts#L24-L72" }, { "kind": "response", @@ -256424,7 +256465,7 @@ "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "name": "master_timeout", "required": false, - "serverDefault": "to 30s", + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -258831,6 +258872,7 @@ "description": "The retention period for the search and its results.\nIt defaults to the `keep_alive` period for the original SQL search.", "name": "keep_alive", "required": false, + "serverDefault": "5d", "type": { "kind": "instance_of", "type": { @@ -258852,7 +258894,7 @@ } } ], - "specLocation": "sql/get_async/SqlGetAsyncRequest.ts#L24-L71" + "specLocation": "sql/get_async/SqlGetAsyncRequest.ts#L24-L72" }, { "kind": "response", @@ -262094,6 +262136,7 @@ "description": "A key that is used to group tasks in the response.\nThe task lists can be grouped either by nodes or by parent tasks.", "name": "group_by", "required": false, + "serverDefault": "nodes", "type": { "kind": "instance_of", "type": { @@ -262153,7 +262196,7 @@ } } ], - "specLocation": "tasks/list/ListTasksRequest.ts#L25-L138" + "specLocation": "tasks/list/ListTasksRequest.ts#L25-L139" }, { "kind": "response", @@ -272661,6 +272704,7 @@ "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -272670,7 +272714,7 @@ } } ], - "specLocation": "watcher/get_settings/WatcherGetSettingsRequest.ts#L23-L45" + "specLocation": "watcher/get_settings/WatcherGetSettingsRequest.ts#L23-L46" }, { "kind": "response", @@ -274010,6 +274054,7 @@ "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -274031,7 +274076,7 @@ } } ], - "specLocation": "watcher/update_settings/WatcherUpdateSettingsRequest.ts#L24-L61" + "specLocation": "watcher/update_settings/WatcherUpdateSettingsRequest.ts#L24-L62" }, { "kind": "response", diff --git a/specification/_global/get_script/GetScriptRequest.ts b/specification/_global/get_script/GetScriptRequest.ts index 422e1fbf24..ae747ad3a8 100644 --- a/specification/_global/get_script/GetScriptRequest.ts +++ b/specification/_global/get_script/GetScriptRequest.ts @@ -49,7 +49,7 @@ export interface Request extends RequestBase { * The period to wait for the master node. * If the master node is not available before the timeout expires, the request fails and returns an error. * It can also be set to `-1` to indicate that the request should never timeout. - * @server_default + * @server_default 30s */ master_timeout?: Duration } diff --git a/specification/_global/reindex/ReindexRequest.ts b/specification/_global/reindex/ReindexRequest.ts index fdeb3c1745..4a0cfacd71 100644 --- a/specification/_global/reindex/ReindexRequest.ts +++ b/specification/_global/reindex/ReindexRequest.ts @@ -102,6 +102,7 @@ export interface Request extends RequestBase { requests_per_second?: float /** * The period of time that a consistent view of the index should be maintained for scrolled search. + * @server_default 5m */ scroll?: Duration /** diff --git a/specification/_global/search_mvt/SearchMvtRequest.ts b/specification/_global/search_mvt/SearchMvtRequest.ts index 63e128901d..8486422fb5 100644 --- a/specification/_global/search_mvt/SearchMvtRequest.ts +++ b/specification/_global/search_mvt/SearchMvtRequest.ts @@ -177,6 +177,7 @@ export interface Request extends RequestBase { extent?: integer /** * Aggregation used to create a grid for `field`. + * @server_default geotile */ grid_agg?: GridAggregationType /** @@ -230,6 +231,7 @@ export interface Request extends RequestBase { * * All attributes from the original features will also be copied to the new label features. * In addition, the new features will be distinguishable using the tag `_mvt_label_position`. + * @server_default false */ with_labels?: boolean } diff --git a/specification/async_search/submit/AsyncSearchSubmitRequest.ts b/specification/async_search/submit/AsyncSearchSubmitRequest.ts index fc71e1e164..a4e2d88ee6 100644 --- a/specification/async_search/submit/AsyncSearchSubmitRequest.ts +++ b/specification/async_search/submit/AsyncSearchSubmitRequest.ts @@ -103,6 +103,9 @@ export interface Request extends RequestBase { */ keep_on_completion?: boolean allow_no_indices?: boolean + /** + * @server_default true + */ allow_partial_search_results?: boolean analyzer?: string analyze_wildcard?: boolean @@ -117,6 +120,9 @@ export interface Request extends RequestBase { * @server_default false */ ccs_minimize_roundtrips?: boolean + /** + * @server_default or + */ default_operator?: Operator df?: string docvalue_fields?: Fields @@ -125,6 +131,9 @@ export interface Request extends RequestBase { ignore_throttled?: boolean ignore_unavailable?: boolean lenient?: boolean + /** + * @server_default 5 + */ max_concurrent_shard_requests?: integer preference?: string /** @@ -149,6 +158,9 @@ export interface Request extends RequestBase { * Specifies which field to use for suggestions. */ suggest_field?: Field + /** + * @server_default missing + */ suggest_mode?: SuggestMode suggest_size?: long /** @@ -160,6 +172,9 @@ export interface Request extends RequestBase { track_total_hits?: TrackHits track_scores?: boolean typed_keys?: boolean + /** + * @server_default false + */ rest_total_hits_as_int?: boolean version?: boolean _source?: SourceConfigParam diff --git a/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts b/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts index fd2183fa6e..44138f5ba6 100644 --- a/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts +++ b/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts @@ -50,6 +50,11 @@ export interface Request extends CatRequestBase { id?: Id } query_parameters: { + /** + * Whether to ignore if a wildcard expression matches no configs. + * (This includes `_all` string or when no configs have been specified.) + * @server_default false + */ allow_no_match?: boolean /** * Comma-separated list of column names to display. diff --git a/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts b/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts index a91198199e..d9413b5281 100644 --- a/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts +++ b/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts @@ -65,9 +65,15 @@ export interface Request extends CatRequestBase { h?: CatTrainedModelsColumns /** A comma-separated list of column names or aliases used to sort the response. */ s?: CatTrainedModelsColumns - /** Skips the specified number of transforms. */ + /** + * Skips the specified number of transforms. + * @server_default 0 + */ from?: integer - /** The maximum number of transforms to display. */ + /** + * The maximum number of transforms to display. + * @server_default 100 + */ size?: integer } } diff --git a/specification/ccr/follow/CreateFollowIndexRequest.ts b/specification/ccr/follow/CreateFollowIndexRequest.ts index 4db2f95ee8..9b28d5c35a 100644 --- a/specification/ccr/follow/CreateFollowIndexRequest.ts +++ b/specification/ccr/follow/CreateFollowIndexRequest.ts @@ -55,6 +55,7 @@ export interface Request extends RequestBase { * active. * A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the * remote Lucene segment files to the follower index. + * @server_default 0 */ wait_for_active_shards?: WaitForActiveShards } diff --git a/specification/connector/delete/ConnectorDeleteRequest.ts b/specification/connector/delete/ConnectorDeleteRequest.ts index 3943378a02..cef3beccad 100644 --- a/specification/connector/delete/ConnectorDeleteRequest.ts +++ b/specification/connector/delete/ConnectorDeleteRequest.ts @@ -46,7 +46,8 @@ export interface Request extends RequestBase { } query_parameters: { /** - * A flag indicating if associated sync jobs should be also removed. Defaults to false. + * A flag indicating if associated sync jobs should be also removed. + * @server_default false */ delete_sync_jobs?: boolean /** diff --git a/specification/connector/list/ConnectorListRequest.ts b/specification/connector/list/ConnectorListRequest.ts index 572f2ea338..e482785619 100644 --- a/specification/connector/list/ConnectorListRequest.ts +++ b/specification/connector/list/ConnectorListRequest.ts @@ -38,11 +38,13 @@ export interface Request extends RequestBase { ] query_parameters: { /** - * Starting offset (default: 0) + * Starting offset + * @server_default 0 */ from?: integer /** * Specifies a max number of results to get + * @server_default 100 */ size?: integer /** diff --git a/specification/connector/sync_job_list/SyncJobListRequest.ts b/specification/connector/sync_job_list/SyncJobListRequest.ts index 94d3569892..0ef837f650 100644 --- a/specification/connector/sync_job_list/SyncJobListRequest.ts +++ b/specification/connector/sync_job_list/SyncJobListRequest.ts @@ -40,11 +40,13 @@ export interface Request extends RequestBase { ] query_parameters: { /** - * Starting offset (default: 0) + * Starting offset + * @server_default 0 */ from?: integer /** * Specifies a max number of results to get + * @server_default 100 */ size?: integer /** diff --git a/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts b/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts index 31eaef70a5..437981b53e 100644 --- a/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts +++ b/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts @@ -49,6 +49,9 @@ export interface Request extends RequestBase { * This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index. */ accept_data_loss: boolean + /** + * @server_default 30s + */ master_timeout?: Duration timeout?: Duration } diff --git a/specification/dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts b/specification/dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts index 9d3a148cbc..3715c1fb02 100644 --- a/specification/dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts +++ b/specification/dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts @@ -51,6 +51,9 @@ export interface Request extends RequestBase { * Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. */ accept_data_loss: boolean + /** + * @server_default 30s + */ master_timeout?: Duration timeout?: Duration } diff --git a/specification/eql/get/EqlGetRequest.ts b/specification/eql/get/EqlGetRequest.ts index feeb821ff5..ba5fb258ce 100644 --- a/specification/eql/get/EqlGetRequest.ts +++ b/specification/eql/get/EqlGetRequest.ts @@ -46,6 +46,7 @@ export interface Request extends RequestBase { /** * Period for which the search and its results are stored on the cluster. * Defaults to the keep_alive value set by the search’s EQL search API request. + * @server_default 5d */ keep_alive?: Duration /** diff --git a/specification/esql/async_query/AsyncQueryRequest.ts b/specification/esql/async_query/AsyncQueryRequest.ts index f3c360f625..4118ebaf3d 100644 --- a/specification/esql/async_query/AsyncQueryRequest.ts +++ b/specification/esql/async_query/AsyncQueryRequest.ts @@ -49,6 +49,7 @@ export interface Request extends RequestBase { /** * The character to use between values within a CSV row. * It is valid only for the CSV format. + * @server_default , */ delimiter?: string /** diff --git a/specification/esql/query/QueryRequest.ts b/specification/esql/query/QueryRequest.ts index ee9025ce67..05cb9b9c7d 100644 --- a/specification/esql/query/QueryRequest.ts +++ b/specification/esql/query/QueryRequest.ts @@ -49,6 +49,7 @@ export interface Request extends RequestBase { format?: EsqlFormat /** * The character to use between values within a CSV row. Only valid for the CSV format. + * @server_default , */ delimiter?: string /** diff --git a/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts b/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts index 55f421c09f..a25a66257d 100644 --- a/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts +++ b/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts @@ -42,6 +42,9 @@ export interface Request extends RequestBase { } query_parameters: { expand_wildcards?: ExpandWildcards + /** + * @server_default 30s + */ master_timeout?: Duration timeout?: Duration } diff --git a/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts b/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts index e58b4ca6a9..e53b07423e 100644 --- a/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts +++ b/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts @@ -42,6 +42,9 @@ export interface Request extends RequestBase { } query_parameters: { expand_wildcards?: ExpandWildcards + /** + * @server_default 30s + */ master_timeout?: Duration timeout?: Duration } diff --git a/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts b/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts index 8f256f7f15..0b893a628a 100644 --- a/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts +++ b/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts @@ -43,6 +43,9 @@ export interface Request extends RequestBase { } query_parameters: { include_defaults?: boolean + /** + * @server_default 30s + */ master_timeout?: Duration } } diff --git a/specification/indices/forcemerge/IndicesForceMergeRequest.ts b/specification/indices/forcemerge/IndicesForceMergeRequest.ts index a119aef10b..d18a6a4adc 100644 --- a/specification/indices/forcemerge/IndicesForceMergeRequest.ts +++ b/specification/indices/forcemerge/IndicesForceMergeRequest.ts @@ -103,6 +103,9 @@ export interface Request extends RequestBase { ignore_unavailable?: boolean max_num_segments?: long only_expunge_deletes?: boolean + /** + * @server_default true + */ wait_for_completion?: boolean } } diff --git a/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts b/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts index 52bbd20df8..d655526a64 100644 --- a/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts +++ b/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts @@ -151,7 +151,9 @@ export interface Request extends RequestBase { * If no response is received before the timeout expires, the request fails and returns an error. * @server_default 30s */ master_timeout?: Duration - + /** + * @server_default api + */ cause?: string } } diff --git a/specification/indices/put_template/IndicesPutTemplateRequest.ts b/specification/indices/put_template/IndicesPutTemplateRequest.ts index f4115263ee..a1c5507f67 100644 --- a/specification/indices/put_template/IndicesPutTemplateRequest.ts +++ b/specification/indices/put_template/IndicesPutTemplateRequest.ts @@ -85,7 +85,9 @@ export interface Request extends RequestBase { * 'order' values are merged later, overriding templates with lower values. */ order?: integer - + /** + * @server_default + */ cause?: string } body: { diff --git a/specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts b/specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts index 3433374c17..93c1d9197e 100644 --- a/specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts +++ b/specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts @@ -59,6 +59,7 @@ export interface Request extends RequestBase { create?: boolean /** * User defined reason for dry-run creating the new template for simulation purposes + * @server_default false */ cause?: string /** diff --git a/specification/indices/stats/IndicesStatsRequest.ts b/specification/indices/stats/IndicesStatsRequest.ts index 22d784d481..b5d32d11ec 100644 --- a/specification/indices/stats/IndicesStatsRequest.ts +++ b/specification/indices/stats/IndicesStatsRequest.ts @@ -106,7 +106,8 @@ export interface Request extends RequestBase { */ include_unloaded_segments?: boolean /** - * Indicates whether statistics are aggregated at the cluster, index, or shard level. + * Indicates whether statistics are aggregated at the cluster, indices, or shards level. + * @server_default indices */ level?: Level } diff --git a/specification/ingest/simulate/SimulatePipelineRequest.ts b/specification/ingest/simulate/SimulatePipelineRequest.ts index 7d3a00425a..cf32f592ce 100644 --- a/specification/ingest/simulate/SimulatePipelineRequest.ts +++ b/specification/ingest/simulate/SimulatePipelineRequest.ts @@ -54,6 +54,7 @@ export interface Request extends RequestBase { query_parameters: { /** * If `true`, the response includes output data for each processor in the executed pipeline. + * @server_default false */ verbose?: boolean } diff --git a/specification/ml/delete_job/MlDeleteJobRequest.ts b/specification/ml/delete_job/MlDeleteJobRequest.ts index 9b51440f44..05e34611f4 100644 --- a/specification/ml/delete_job/MlDeleteJobRequest.ts +++ b/specification/ml/delete_job/MlDeleteJobRequest.ts @@ -53,6 +53,7 @@ export interface Request extends RequestBase { /** * Use to forcefully delete an opened job; this method is quicker than * closing and deleting the job. + * @server_default false */ force?: boolean /** diff --git a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts index 39b8476879..7d9ce13d0c 100644 --- a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts +++ b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts @@ -58,6 +58,7 @@ export interface Request extends RequestBase { * validations. * @availability stack since=8.0.0 * @availability serverless + * @server_default false */ defer_definition_decompression?: boolean @@ -66,6 +67,7 @@ export interface Request extends RequestBase { * to complete. * @availability stack since=8.8.0 * @availability serverless + * @server_default false */ wait_for_completion?: boolean } diff --git a/specification/nodes/stats/NodesStatsRequest.ts b/specification/nodes/stats/NodesStatsRequest.ts index e3882f1107..5b1ec00b42 100644 --- a/specification/nodes/stats/NodesStatsRequest.ts +++ b/specification/nodes/stats/NodesStatsRequest.ts @@ -81,7 +81,10 @@ export interface Request extends RequestBase { * @server_default false */ include_segment_file_sizes?: boolean - /** Indicates whether statistics are aggregated at the cluster, index, or shard level. */ + /** + * Indicates whether statistics are aggregated at the node, indices, or shards level. + * @server_default node + */ level?: NodeStatsLevel /** * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. diff --git a/specification/query_rules/list_rulesets/QueryRulesetListRequest.ts b/specification/query_rules/list_rulesets/QueryRulesetListRequest.ts index 49df46ccbf..cc7f3c2521 100644 --- a/specification/query_rules/list_rulesets/QueryRulesetListRequest.ts +++ b/specification/query_rules/list_rulesets/QueryRulesetListRequest.ts @@ -44,6 +44,7 @@ export interface Request extends RequestBase { from?: integer /** * The maximum number of results to retrieve. + * @server_default 100 */ size?: integer } diff --git a/specification/rollup/rollup_search/RollupSearchRequest.ts b/specification/rollup/rollup_search/RollupSearchRequest.ts index 622cd9dd2d..760a336a46 100644 --- a/specification/rollup/rollup_search/RollupSearchRequest.ts +++ b/specification/rollup/rollup_search/RollupSearchRequest.ts @@ -63,6 +63,9 @@ export interface Request extends RequestBase { index: Indices } query_parameters: { + /** + * @server_default false + */ rest_total_hits_as_int?: boolean typed_keys?: boolean } diff --git a/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts b/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts index d2a0002d96..e376952582 100644 --- a/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts +++ b/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts @@ -47,6 +47,9 @@ export interface Request extends RequestBase { index?: Indices } query_parameters: { + /** + * @server_default indices + */ level?: StatsLevel } } diff --git a/specification/security/get_settings/SecurityGetSettingsRequest.ts b/specification/security/get_settings/SecurityGetSettingsRequest.ts index 61bb5d4e93..f11604eb34 100644 --- a/specification/security/get_settings/SecurityGetSettingsRequest.ts +++ b/specification/security/get_settings/SecurityGetSettingsRequest.ts @@ -45,6 +45,7 @@ export interface Request extends RequestBase { /** * Period to wait for a connection to the master node. * If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s */ master_timeout?: Duration } diff --git a/specification/security/query_api_keys/QueryApiKeysRequest.ts b/specification/security/query_api_keys/QueryApiKeysRequest.ts index 91ccda6a12..510c390331 100644 --- a/specification/security/query_api_keys/QueryApiKeysRequest.ts +++ b/specification/security/query_api_keys/QueryApiKeysRequest.ts @@ -52,6 +52,7 @@ export interface Request extends RequestBase { * Return the snapshot of the owner user's role descriptors associated with the API key. * An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors (effectively limited by it). * An API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has `manage_api_key` or higher privileges. + * @server_default false * @availability stack since=8.5.0 * @availability serverless */ diff --git a/specification/security/update_settings/SecurityUpdateSettingsRequest.ts b/specification/security/update_settings/SecurityUpdateSettingsRequest.ts index 0043e4d29c..2da4b02416 100644 --- a/specification/security/update_settings/SecurityUpdateSettingsRequest.ts +++ b/specification/security/update_settings/SecurityUpdateSettingsRequest.ts @@ -46,6 +46,7 @@ export interface Request extends RequestBase { /** * The period to wait for a connection to the master node. * If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s */ master_timeout?: Duration /** diff --git a/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts b/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts index 7c01fe1fdb..0ab0bc6b22 100644 --- a/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts +++ b/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts @@ -61,7 +61,7 @@ export interface Request extends RequestBase { * The period to wait for the master node. * If the master node is not available before the timeout expires, the request fails and returns an error. * To indicate that the request should never timeout, set it to `-1`. - * @server_default to 30s + * @server_default 30s */ master_timeout?: Duration } diff --git a/specification/sql/get_async/SqlGetAsyncRequest.ts b/specification/sql/get_async/SqlGetAsyncRequest.ts index 058b84a3cd..3d51d11263 100644 --- a/specification/sql/get_async/SqlGetAsyncRequest.ts +++ b/specification/sql/get_async/SqlGetAsyncRequest.ts @@ -60,6 +60,7 @@ export interface Request extends RequestBase { /** * The retention period for the search and its results. * It defaults to the `keep_alive` period for the original SQL search. + * @server_default 5d */ keep_alive?: Duration /** diff --git a/specification/tasks/list/ListTasksRequest.ts b/specification/tasks/list/ListTasksRequest.ts index 939dda5ff5..1e29df5594 100644 --- a/specification/tasks/list/ListTasksRequest.ts +++ b/specification/tasks/list/ListTasksRequest.ts @@ -110,6 +110,7 @@ export interface Request extends RequestBase { /** * A key that is used to group tasks in the response. * The task lists can be grouped either by nodes or by parent tasks. + * @server_default nodes */ group_by?: GroupBy /** diff --git a/specification/watcher/get_settings/WatcherGetSettingsRequest.ts b/specification/watcher/get_settings/WatcherGetSettingsRequest.ts index d79bb2e14f..16dfcc0719 100644 --- a/specification/watcher/get_settings/WatcherGetSettingsRequest.ts +++ b/specification/watcher/get_settings/WatcherGetSettingsRequest.ts @@ -39,6 +39,7 @@ export interface Request extends RequestBase { /** * The period to wait for a connection to the master node. * If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s */ master_timeout?: Duration } diff --git a/specification/watcher/update_settings/WatcherUpdateSettingsRequest.ts b/specification/watcher/update_settings/WatcherUpdateSettingsRequest.ts index df8364f308..b46f3780e1 100644 --- a/specification/watcher/update_settings/WatcherUpdateSettingsRequest.ts +++ b/specification/watcher/update_settings/WatcherUpdateSettingsRequest.ts @@ -45,6 +45,7 @@ export interface Request extends RequestBase { /** * The period to wait for a connection to the master node. * If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s */ master_timeout?: Duration /**