Add default values from rest-api-spec

pquentin · pquentin · commit 6e02292a41e3 · 2025-10-09T14:42:36.000+04:00
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
diff --git a/specification/watcher/get_settings/WatcherGetSettingsRequest.ts b/specification/watcher/get_settings/WatcherGetSettingsRequest.ts
diff --git a/specification/watcher/update_settings/WatcherUpdateSettingsRequest.ts b/specification/watcher/update_settings/WatcherUpdateSettingsRequest.ts

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ export interface Request extends RequestBase {`
`49`	`49`	`* The period to wait for the master node.`
`50`	`50`	`* If the master node is not available before the timeout expires, the request fails and returns an error.`
`51`	`51`	* It can also be set to `-1` to indicate that the request should never timeout.
`52`		`- * @server_default`
	`52`	`+ * @server_default 30s`
`53`	`53`	`*/`
`54`	`54`	`master_timeout?: Duration`
`55`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@ export interface Request extends RequestBase {`
`55`	`55`	`* active.`
`56`	`56`	`* A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the`
`57`	`57`	`* remote Lucene segment files to the follower index.`
	`58`	`+ * @server_default 0`
`58`	`59`	`*/`
`59`	`60`	`wait_for_active_shards?: WaitForActiveShards`
`60`	`61`	`}`