diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/async_search.status.json b/rest-api-spec/src/main/resources/rest-api-spec/api/async_search.status.json index 2866d7ea79646..d86b8081b9754 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/async_search.status.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/async_search.status.json @@ -30,6 +30,7 @@ "params": { "keep_alive": { "type": "time", + "default": "5d", "description": "Specify the time interval in which the results (partial or final) for this search will be available" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/async_search.submit.json b/rest-api-spec/src/main/resources/rest-api-spec/api/async_search.submit.json index 797d699a9210f..38d043e3bcc8a 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/async_search.submit.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/async_search.submit.json @@ -59,6 +59,7 @@ }, "request_cache": { "type": "boolean", + "default": true, "description": "Specify if request cache should be used for this request or not, defaults to true" }, "analyzer": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/autoscaling.delete_autoscaling_policy.json b/rest-api-spec/src/main/resources/rest-api-spec/api/autoscaling.delete_autoscaling_policy.json index 50cb170b82f2f..8c244271d0aa3 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/autoscaling.delete_autoscaling_policy.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/autoscaling.delete_autoscaling_policy.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/autoscaling.put_autoscaling_policy.json b/rest-api-spec/src/main/resources/rest-api-spec/api/autoscaling.put_autoscaling_policy.json index cbd9ee413a220..9cb0928d32c8c 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/autoscaling.put_autoscaling_policy.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/autoscaling.put_autoscaling_policy.json @@ -38,6 +38,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/bulk.json b/rest-api-spec/src/main/resources/rest-api-spec/api/bulk.json index ef5db8942ba05..c6aa41ee42499 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/bulk.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/bulk.json @@ -41,6 +41,7 @@ "params": { "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)" }, "refresh": { @@ -50,6 +51,7 @@ "false", "wait_for" ], + "default": "false", "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes." }, "routing": { @@ -58,6 +60,7 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "_source": { @@ -78,18 +81,22 @@ }, "require_alias": { "type": "boolean", - "description": "Sets require_alias for all incoming documents. Defaults to unset (false)" + "default": false, + "description": "If true, the request's actions must target an index alias. Defaults to false." }, "require_data_stream": { "type": "boolean", - "description": "When true, requires the destination to be a data stream (existing or to-be-created). Default is false" + "default": false, + "description": "If true, the request's actions must target a data stream (existing or to-be-created). Default to false" }, "list_executed_pipelines": { "type": "boolean", + "default": false, "description": "Sets list_executed_pipelines for all incoming documents. Defaults to unset (false)" }, "include_source_on_error": { "type": "boolean", + "default": true, "description": "True or false if to include the document source in the error message in case of parsing errors. Defaults to true." } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.allocation.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.allocation.json index dfbeb645f78f9..8b914a5848f93 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.allocation.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.allocation.json @@ -67,6 +67,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.component_templates.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.component_templates.json index 3c3c24c37222c..83537bda37516 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.component_templates.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.component_templates.json @@ -42,6 +42,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.master.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.master.json index ff229ceae7830..b7664a5fdc5c1 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.master.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.master.json @@ -30,6 +30,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_data_frame_analytics.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_data_frame_analytics.json index 366fe0f65afd8..c13e019b31d53 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_data_frame_analytics.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_data_frame_analytics.json @@ -37,6 +37,7 @@ "params": { "allow_no_match": { "type": "boolean", + "default": false, "description": "Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)" }, "bytes": { @@ -58,6 +59,7 @@ }, "h": { "type": "list", + "default": "create_time,id,state,type", "description": "Comma-separated list of column names to display" }, "help": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json index 553a8dc3e8161..d40e9c6c00c52 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json @@ -37,6 +37,7 @@ "params": { "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)" }, "format": { @@ -46,6 +47,7 @@ }, "h": { "type": "list", + "default": "['bc', 'id', 'sc', 's']", "description": "Comma-separated list of column names to display" }, "help": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_jobs.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_jobs.json index 63a05bd974e72..08eb857b49982 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_jobs.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_jobs.json @@ -37,6 +37,7 @@ "params": { "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)" }, "bytes": { @@ -58,6 +59,7 @@ }, "h": { "type": "list", + "default": "buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state", "description": "Comma-separated list of column names to display" }, "help": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodeattrs.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodeattrs.json index e13f8821fd8eb..195cb78132c85 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodeattrs.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodeattrs.json @@ -30,6 +30,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodes.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodes.json index 1c9d5d9c3fcaf..75486146ae29d 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodes.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodes.json @@ -42,6 +42,7 @@ }, "full_id": { "type": "boolean", + "default": false, "description": "Return the full node ID instead of the shortened version (default: false)" }, "master_timeout": { @@ -51,6 +52,7 @@ }, "h": { "type": "list", + "default": "ip,hp,rp,r,m,n,cpu,l", "description": "Comma-separated list of column names to display" }, "help": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json index 58eef95528797..a4a7398c0368d 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json @@ -30,6 +30,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.plugins.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.plugins.json index ae2d82cea5fe1..24b1618795cdd 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.plugins.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.plugins.json @@ -30,6 +30,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json index 46f0f60b3c281..8cedab2c6ac07 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json @@ -64,6 +64,7 @@ }, "h": { "type": "list", + "default": "ip,hp,rp,r,m,n,cpu,l", "description": "Comma-separated list of column names to display" }, "help": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.segments.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.segments.json index d8a4ad4eeeafa..b34f46962344b 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.segments.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.segments.json @@ -42,6 +42,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { @@ -63,6 +64,7 @@ }, "h": { "type": "list", + "default": "ip,hp,rp,r,m,n,cpu,l", "description": "Comma-separated list of column names to display" }, "help": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.snapshots.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.snapshots.json index 4814604644174..214f84d4eb128 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.snapshots.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.snapshots.json @@ -52,6 +52,7 @@ }, "h": { "type": "list", + "default": "ip,hp,rp,r,m,n,cpu,l", "description": "Comma-separated list of column names to display" }, "help": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.tasks.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.tasks.json index 9282488207bb7..58ce5cc289a32 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.tasks.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.tasks.json @@ -38,6 +38,7 @@ }, "detailed": { "type": "boolean", + "default": false, "description": "Return detailed task information (default: false)" }, "parent_task_id": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.templates.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.templates.json index f78a99eadb794..fff6bc720c75e 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.templates.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.templates.json @@ -42,6 +42,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.thread_pool.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.thread_pool.json index 927b4f4323649..93aeb9981df2e 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.thread_pool.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.thread_pool.json @@ -55,6 +55,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.transforms.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.transforms.json index 479eff48a43a4..87a016b39f7ce 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.transforms.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.transforms.json @@ -37,14 +37,17 @@ "params": { "from": { "type": "int", + "default": 0, "description": "skips a number of transform configs, defaults to 0" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of transforms to get, defaults to 100" }, "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)" }, "format": { @@ -54,6 +57,7 @@ }, "h": { "type": "list", + "default": "changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state", "description": "Comma-separated list of column names to display" }, "help": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ccr.follow_stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ccr.follow_stats.json index cefeed291a99a..6417994cea366 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ccr.follow_stats.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ccr.follow_stats.json @@ -30,6 +30,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ccr.forget_follower.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ccr.forget_follower.json index 2d2e3393cc975..4631b5c3008ea 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ccr.forget_follower.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ccr.forget_follower.json @@ -33,6 +33,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ccr.stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ccr.stats.json index ae7d41cfc3428..598730337d1ee 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ccr.stats.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ccr.stats.json @@ -24,6 +24,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.allocation_explain.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.allocation_explain.json index e3165fc97ed71..f59c54f6ccc0e 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.allocation_explain.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.allocation_explain.json @@ -33,10 +33,12 @@ }, "include_yes_decisions": { "type": "boolean", + "default": false, "description": "Return 'YES' decisions in explanation (default: false)" }, "include_disk_info": { "type": "boolean", + "default": false, "description": "Return information about disk usage and shard sizes (default: false)" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.delete_component_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.delete_component_template.json index 7f1f75fcb951c..2ad57cac73e35 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.delete_component_template.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.delete_component_template.json @@ -30,6 +30,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.exists_component_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.exists_component_template.json index 6d5d6433428d0..649a64c77a72d 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.exists_component_template.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.exists_component_template.json @@ -35,6 +35,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.get_component_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.get_component_template.json index 9aef00d717579..42e89695caa67 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.get_component_template.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.get_component_template.json @@ -41,14 +41,17 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all default configurations for the component template (default: false)" }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "settings_filter": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.get_settings.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.get_settings.json index 34fbacf7fa04d..abafbdf1ee2a0 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.get_settings.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.get_settings.json @@ -24,6 +24,7 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { @@ -33,6 +34,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "include_defaults": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.health.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.health.json index eb03b44f97b84..ca79d993305b2 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.health.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.health.json @@ -58,6 +58,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { @@ -67,10 +68,12 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "wait_for_active_shards": { "type": "string", + "default": "0", "description": "Wait until the specified number of shards is active" }, "wait_for_nodes": { @@ -91,10 +94,12 @@ }, "wait_for_no_relocating_shards": { "type": "boolean", + "default": false, "description": "Whether to wait until there are no relocating shards in the cluster" }, "wait_for_no_initializing_shards": { "type": "boolean", + "default": false, "description": "Whether to wait until there are no initializing shards in the cluster" }, "wait_for_status": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.pending_tasks.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.pending_tasks.json index 8286197be210c..e313d0d8611cd 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.pending_tasks.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.pending_tasks.json @@ -24,6 +24,7 @@ "params": { "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.put_settings.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.put_settings.json index a6ccdaa0babb5..b5e0ac02ec04a 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.put_settings.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.put_settings.json @@ -36,6 +36,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.reroute.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.reroute.json index b8c337eb03bd8..76c122719b594 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.reroute.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.reroute.json @@ -27,14 +27,17 @@ "params": { "dry_run": { "type": "boolean", + "default": false, "description": "Simulate the operation only and return the resulting state" }, "explain": { "type": "boolean", + "default": false, "description": "Return an explanation of why the commands can or cannot be executed" }, "retry_failed": { "type": "boolean", + "default": false, "description": "Retries allocation of shards that are blocked due to too many subsequent allocation failures" }, "metric": { @@ -49,6 +52,7 @@ "master_node", "version" ], + "default": "all", "description": "Limit the information returned to the specified metrics. Defaults to all but metadata" }, "master_timeout": { @@ -58,6 +62,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.state.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.state.json index 61b561de48916..33500ef5e51cd 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.state.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.state.json @@ -72,6 +72,7 @@ "params": { "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { @@ -81,6 +82,7 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "wait_for_metadata_version": { @@ -93,10 +95,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.stats.json index 783644c54dc8d..07c19220819ed 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.stats.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.stats.json @@ -36,6 +36,7 @@ "params": { "include_remotes": { "type": "boolean", + "default": false, "description": "Include remote cluster data into the response (default: false)" }, "timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/count.json b/rest-api-spec/src/main/resources/rest-api-spec/api/count.json index 1812b77089197..bbd36578f2ade 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/count.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/count.json @@ -41,14 +41,17 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "ignore_throttled": { "type": "boolean", + "default": true, "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { @@ -85,6 +88,7 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "default_operator": { @@ -102,6 +106,7 @@ }, "lenient": { "type": "boolean", + "default": false, "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" }, "terminate_after": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/create.json b/rest-api-spec/src/main/resources/rest-api-spec/api/create.json index 4b897d7016778..2209a8ba1a7a4 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/create.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/create.json @@ -38,6 +38,7 @@ "params": { "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)" }, "refresh": { @@ -47,6 +48,7 @@ "false", "wait_for" ], + "default": "false", "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes." }, "routing": { @@ -55,6 +57,7 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "version": { @@ -76,14 +79,17 @@ }, "include_source_on_error": { "type": "boolean", + "default": true, "description": "True or false if to include the document source in the error message in case of parsing errors. Defaults to true." }, "require_alias": { "type": "boolean", + "default": false, "description": "When true, requires destination to be an alias. Default is false" }, "require_data_stream": { "type": "boolean", + "default": false, "description": "When true, requires destination to be a data stream (existing or to be created). Default is false" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/delete.json b/rest-api-spec/src/main/resources/rest-api-spec/api/delete.json index 9d59d498930f4..1c38463e0af73 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/delete.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/delete.json @@ -34,6 +34,7 @@ "params": { "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)" }, "refresh": { @@ -43,6 +44,7 @@ "false", "wait_for" ], + "default": "false", "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes." }, "routing": { @@ -51,6 +53,7 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "if_seq_no": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/delete_by_query.json b/rest-api-spec/src/main/resources/rest-api-spec/api/delete_by_query.json index a7681af2d53f3..c4025bc700081 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/delete_by_query.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/delete_by_query.json @@ -37,6 +37,7 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "default_operator": { @@ -54,14 +55,17 @@ }, "from": { "type": "number", + "default": 0, "description": "Starting offset (default: 0)" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "conflicts": { @@ -87,6 +91,7 @@ }, "lenient": { "type": "boolean", + "default": false, "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" }, "preference": { @@ -143,6 +148,7 @@ }, "refresh": { "type": "boolean", + "default": false, "description": "Should the affected indexes be refreshed?" }, "timeout": { @@ -152,11 +158,12 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)" }, "scroll_size": { "type": "number", - "default": 100, + "default": 1000, "description": "Size on the scroll request powering the delete by query" }, "wait_for_completion": { @@ -166,7 +173,7 @@ }, "requests_per_second": { "type": "number", - "default": 0, + "default": -1, "description": "The throttle for this request in sub-requests per second. -1 means no throttle." }, "slices": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/delete_script.json b/rest-api-spec/src/main/resources/rest-api-spec/api/delete_script.json index 202f5443d9a2c..7f70beb2b6a86 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/delete_script.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/delete_script.json @@ -30,6 +30,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/eql.search.json b/rest-api-spec/src/main/resources/rest-api-spec/api/eql.search.json index 582b0545c1f60..dac3860684ac0 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/eql.search.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/eql.search.json @@ -63,10 +63,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": true, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/esql.async_query.json b/rest-api-spec/src/main/resources/rest-api-spec/api/esql.async_query.json index fdc9b03eefde7..a962dfa019644 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/esql.async_query.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/esql.async_query.json @@ -32,7 +32,7 @@ "delimiter": { "type": "string", "description": "The character to use between values within a CSV row. Only valid for the csv format.", - "default": false + "default": "," }, "drop_null_columns": { "type": "boolean", diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/esql.async_query_stop.json b/rest-api-spec/src/main/resources/rest-api-spec/api/esql.async_query_stop.json index 7da344c29d864..c4d2921c00478 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/esql.async_query_stop.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/esql.async_query_stop.json @@ -26,6 +26,13 @@ } } ] + }, + "params": { + "drop_null_columns": { + "type": "boolean", + "default": false, + "description": "Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results." + } } } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/esql.query.json b/rest-api-spec/src/main/resources/rest-api-spec/api/esql.query.json index b3ab4339d1f52..aea24d2ba9b63 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/esql.query.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/esql.query.json @@ -32,7 +32,7 @@ "delimiter": { "type": "string", "description": "The character to use between values within a CSV row. Only valid for the csv format.", - "default": false + "default": "," }, "drop_null_columns": { "type": "boolean", diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/exists.json b/rest-api-spec/src/main/resources/rest-api-spec/api/exists.json index d4aabe02717b1..39bef24577ae0 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/exists.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/exists.json @@ -42,10 +42,12 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specify whether to perform the operation in realtime or search mode" }, "refresh": { "type": "boolean", + "default": false, "description": "Refresh the shard containing the document before performing the operation" }, "routing": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/exists_source.json b/rest-api-spec/src/main/resources/rest-api-spec/api/exists_source.json index 197c301f6a6e7..a2d4cd32608f4 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/exists_source.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/exists_source.json @@ -38,10 +38,12 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specify whether to perform the operation in realtime or search mode" }, "refresh": { "type": "boolean", + "default": false, "description": "Refresh the shard containing the document before performing the operation" }, "routing": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/explain.json b/rest-api-spec/src/main/resources/rest-api-spec/api/explain.json index b18e93abf07f6..9610da641f536 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/explain.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/explain.json @@ -38,6 +38,7 @@ "params": { "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)" }, "analyzer": { @@ -63,6 +64,7 @@ }, "lenient": { "type": "boolean", + "default": false, "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" }, "preference": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/field_caps.json b/rest-api-spec/src/main/resources/rest-api-spec/api/field_caps.json index fa982b6856aa3..69588dbb7432d 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/field_caps.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/field_caps.json @@ -45,10 +45,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/fleet.global_checkpoints.json b/rest-api-spec/src/main/resources/rest-api-spec/api/fleet.global_checkpoints.json index 3c0c19ae355a6..f58bc267f9d32 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/fleet.global_checkpoints.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/fleet.global_checkpoints.json @@ -34,12 +34,12 @@ "wait_for_advance": { "type": "boolean", "description": "Whether to wait for the global checkpoint to advance past the specified current checkpoints", - "default": "false" + "default": false }, "wait_for_index": { "type": "boolean", "description": "Whether to wait for the target index to exist and all primary shards be active", - "default": "false" + "default": false }, "checkpoints": { "type": "list", diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/get.json b/rest-api-spec/src/main/resources/rest-api-spec/api/get.json index 1f5da0a1fb560..c7ce6cd2213db 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/get.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/get.json @@ -48,10 +48,12 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specify whether to perform the operation in realtime or search mode" }, "refresh": { "type": "boolean", + "default": false, "description": "Refresh the shard containing the document before performing the operation" }, "routing": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/get_source.json b/rest-api-spec/src/main/resources/rest-api-spec/api/get_source.json index 179721351c4b6..9bf6fb0fd7da5 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/get_source.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/get_source.json @@ -38,10 +38,12 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specify whether to perform the operation in realtime or search mode" }, "refresh": { "type": "boolean", + "default": false, "description": "Refresh the shard containing the document before performing the operation" }, "routing": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.delete_lifecycle.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.delete_lifecycle.json index d10f041ca0ed5..b3d81b07ac30f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.delete_lifecycle.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.delete_lifecycle.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.get_lifecycle.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.get_lifecycle.json index c318b0152f242..282ee8be9c0f7 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.get_lifecycle.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.get_lifecycle.json @@ -41,6 +41,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.migrate_to_data_tiers.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.migrate_to_data_tiers.json index 14a2fdfd7114f..48efe46aa3063 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.migrate_to_data_tiers.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.migrate_to_data_tiers.json @@ -27,6 +27,7 @@ "params": { "dry_run": { "type": "boolean", + "default": false, "description": "If set to true it will simulate the migration, providing a way to retrieve the ILM policies and indices that need to be migrated. The default is false" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.put_lifecycle.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.put_lifecycle.json index 7d434d0f0e60a..dd36e1af0e0e9 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.put_lifecycle.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.put_lifecycle.json @@ -38,6 +38,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.start.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.start.json index 07f4a0277cd70..8026c9b27d455 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.start.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.start.json @@ -29,6 +29,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.stop.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.stop.json index 0d3b2b84391bc..c7c271735e72a 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.stop.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ilm.stop.json @@ -29,6 +29,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/index.json b/rest-api-spec/src/main/resources/rest-api-spec/api/index.json index dcc7fb1ddb96b..e53ac1a4a49b0 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/index.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/index.json @@ -50,6 +50,7 @@ "params": { "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)" }, "op_type": { @@ -67,6 +68,7 @@ "false", "wait_for" ], + "default": "false", "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes." }, "routing": { @@ -75,6 +77,7 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "version": { @@ -104,14 +107,17 @@ }, "require_alias": { "type": "boolean", + "default": false, "description": "When true, requires destination to be an alias. Default is false" }, "require_data_stream": { "type": "boolean", + "default": false, "description": "When true, requires the destination to be a data stream (existing or to-be-created). Default is false" }, "include_source_on_error": { "type": "boolean", + "default": true, "description": "True or false if to include the document source in the error message in case of parsing errors. Defaults to true." } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.add_block.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.add_block.json index a487cfb145a4e..e80819cace7d9 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.add_block.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.add_block.json @@ -34,6 +34,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -43,10 +44,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.clear_cache.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.clear_cache.json index 9778eae669b26..dff3afce17045 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.clear_cache.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.clear_cache.json @@ -48,10 +48,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.clone.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.clone.json index 82c75a16e7326..71ff74c20591e 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.clone.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.clone.json @@ -38,6 +38,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -47,6 +48,7 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for on the cloned index before the operation returns." } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.close.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.close.json index 6e127c5046581..2f9ebb45fdbf2 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.close.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.close.json @@ -30,6 +30,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -39,10 +40,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { @@ -59,6 +62,7 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of active shards to wait for before the operation returns." } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.create.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.create.json index ba27be5d102af..928d47565f456 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.create.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.create.json @@ -33,10 +33,12 @@ "params": { "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for before the operation returns." }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.create_data_stream.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.create_data_stream.json index e090364954fb1..c7ca8fbe4de73 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.create_data_stream.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.create_data_stream.json @@ -30,6 +30,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for acknowledging the cluster state update" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete.json index 239452020e0d4..adfaceb928755 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete.json @@ -30,6 +30,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -39,10 +40,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Ignore unavailable indexes (default: false)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Ignore if a wildcard expression resolves to no concrete indices (default: false)" }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_alias.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_alias.json index c7368bf4f5f1f..c125e60466001 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_alias.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_alias.json @@ -50,6 +50,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_index_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_index_template.json index 3ba22ae00d164..c74bf14f21417 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_index_template.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_index_template.json @@ -30,6 +30,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_template.json index 053ebd5d73415..fd302e920d439 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_template.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_template.json @@ -30,6 +30,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.disk_usage.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.disk_usage.json index 1b0b9ee2713e1..e14d8c629c89c 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.disk_usage.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.disk_usage.json @@ -30,18 +30,22 @@ "params": { "run_expensive_tasks": { "type": "boolean", + "default": false, "description": "Must be set to [true] in order for the task to be performed. Defaults to false." }, "flush": { "type": "boolean", + "default": true, "description": "Whether flush or not before analyzing the index disk usage. Defaults to true" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists.json index 7f05e5505f7b7..9eda5d010733b 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists.json @@ -30,14 +30,17 @@ "params": { "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Ignore unavailable indexes (default: false)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Ignore if a wildcard expression resolves to no concrete indices (default: false)" }, "expand_wildcards": { @@ -54,6 +57,7 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "include_defaults": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists_alias.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists_alias.json index 53c3f7fbc9898..9075bf19017fb 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists_alias.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists_alias.json @@ -46,10 +46,12 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists_index_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists_index_template.json index 787c37c112298..b0b81a37dbd88 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists_index_template.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists_index_template.json @@ -30,6 +30,7 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { @@ -39,6 +40,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists_template.json index 1398d1e49f3bb..2a0e02b4c7e54 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists_template.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists_template.json @@ -30,6 +30,7 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { @@ -39,6 +40,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.field_usage_stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.field_usage_stats.json index 3cf091afec9cd..54f328ad15747 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.field_usage_stats.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.field_usage_stats.json @@ -34,6 +34,7 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.flush.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.flush.json index 6df4978baa259..466289ef198b0 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.flush.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.flush.json @@ -38,18 +38,22 @@ "params": { "force": { "type": "boolean", + "default": true, "description": "Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)" }, "wait_if_ongoing": { "type": "boolean", + "default": true, "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running." }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get.json index 97d5f36c19aed..72a7cb66c7bf8 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get.json @@ -30,14 +30,17 @@ "params": { "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Ignore unavailable indexes (default: false)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Ignore if a wildcard expression resolves to no concrete indices (default: false)" }, "expand_wildcards": { @@ -64,6 +67,7 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "include_defaults": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_alias.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_alias.json index 699a98bd86f04..66c44490343f7 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_alias.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_alias.json @@ -64,10 +64,12 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_lifecycle.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_lifecycle.json index 1b02b26483ca8..1baf9909138ec 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_lifecycle.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_lifecycle.json @@ -42,6 +42,7 @@ }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for the data stream (default: false)" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream.json index 1dbd1cec443ec..dfdb339e94ef2 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream.json @@ -48,6 +48,7 @@ }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for the data stream (default: false)" }, "master_timeout": { @@ -57,6 +58,7 @@ }, "verbose": { "type": "boolean", + "default": false, "description": "Whether the maximum timestamp for each data stream should be calculated and returned (default: false)" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_field_mapping.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_field_mapping.json index 1a30ed901e2da..bbe59044636e4 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_field_mapping.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_field_mapping.json @@ -46,14 +46,17 @@ "params": { "include_defaults": { "type": "boolean", + "default": false, "description": "Whether the default mapping values should be returned as well" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_index_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_index_template.json index a0da911cf0511..c9e2498a501bd 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_index_template.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_index_template.json @@ -36,6 +36,7 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { @@ -45,10 +46,12 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for the index template (default: false)" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_mapping.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_mapping.json index 6cbcdb1295d61..dee0bf33cd457 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_mapping.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_mapping.json @@ -36,10 +36,12 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { @@ -61,6 +63,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)", "deprecated": { "version": "7.8.0", diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_settings.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_settings.json index dd36f1446f711..be61d82deb697 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_settings.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_settings.json @@ -69,10 +69,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { @@ -89,10 +91,12 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "include_defaults": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_template.json index 9bb943d4fdebd..e7af6528410e1 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_template.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_template.json @@ -36,6 +36,7 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { @@ -45,6 +46,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.migrate_to_data_stream.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.migrate_to_data_stream.json index 8ba3fbf3af41d..b7fdfe3a9c648 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.migrate_to_data_stream.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.migrate_to_data_stream.json @@ -30,6 +30,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for acknowledging the cluster state update" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.open.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.open.json index c84ad0a944c24..9f8ba31b48a08 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.open.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.open.json @@ -30,6 +30,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -39,10 +40,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { @@ -59,6 +62,7 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of active shards to wait for before the operation returns." } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_alias.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_alias.json index 1584dc58ee347..7f1925d8e594b 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_alias.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_alias.json @@ -55,6 +55,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_lifecycle.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_lifecycle.json index f8909aef6d18e..720bef6919522 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_lifecycle.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_lifecycle.json @@ -45,6 +45,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_options.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_options.json index c6c8bde335fbe..f381fdaf9c1d8 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_options.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_options.json @@ -45,6 +45,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_settings.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_settings.json index e1b8668e7f75e..c5041925548bf 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_settings.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_settings.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Period to wait for a response" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_index_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_index_template.json index 1f6c05c94ac46..109894440937a 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_index_template.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_index_template.json @@ -40,7 +40,7 @@ "cause": { "type": "string", "description": "User defined reason for creating/updating the index template", - "default": false + "default": "api" }, "master_timeout": { "type": "time", diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_mapping.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_mapping.json index c7b67b226e148..7b5d321e59a2f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_mapping.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_mapping.json @@ -34,6 +34,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -43,10 +44,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_settings.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_settings.json index e83b5f80d1bc3..57192806d37a2 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_settings.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_settings.json @@ -44,22 +44,27 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "preserve_existing": { "type": "boolean", + "default": false, "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false`" }, "reopen": { "type": "boolean", + "default": false, "description": "Whether to close and reopen the index to apply non-dynamic settings. If set to `true` the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. The default is `false`" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": false, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { @@ -76,6 +81,7 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.refresh.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.refresh.json index 00fe71e3904bf..e9e45efe53f30 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.refresh.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.refresh.json @@ -38,10 +38,12 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.resolve_cluster.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.resolve_cluster.json index 245cdb6e51d1d..36a6dd66723f4 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.resolve_cluster.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.resolve_cluster.json @@ -36,14 +36,17 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed). Only allowed when providing an index expression." }, "ignore_throttled": { "type": "boolean", + "default": false, "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled. Only allowed when providing an index expression." }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). Only allowed when providing an index expression." }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.rollover.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.rollover.json index c2b1d3472a040..7d6ecd38547e2 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.rollover.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.rollover.json @@ -49,10 +49,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "dry_run": { "type": "boolean", + "default": false, "description": "If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false" }, "master_timeout": { @@ -62,11 +64,12 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns." }, "lazy": { "type": "boolean", - "default": "false", + "default": false, "description": "If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams." } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.segments.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.segments.json index 9b5499cd1fb98..bfebd17c297d4 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.segments.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.segments.json @@ -36,10 +36,12 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.shard_stores.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.shard_stores.json index a0f0b2cd3e7fe..2f05cebe70b3f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.shard_stores.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.shard_stores.json @@ -46,6 +46,7 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.shrink.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.shrink.json index 84724909408e4..06adadc344041 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.shrink.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.shrink.json @@ -38,6 +38,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -47,6 +48,7 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.simulate_index_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.simulate_index_template.json index 78e2fe31f6763..12ae41bad4f33 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.simulate_index_template.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.simulate_index_template.json @@ -39,7 +39,7 @@ "cause": { "type": "string", "description": "User defined reason for dry-run creating the new template for simulation purposes", - "default": false + "default": "false" }, "master_timeout": { "type": "time", @@ -48,6 +48,7 @@ }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for this index template simulation (default: false)" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.simulate_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.simulate_template.json index 94f5c05826864..4e996acedfcd5 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.simulate_template.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.simulate_template.json @@ -45,7 +45,7 @@ "cause": { "type": "string", "description": "User defined reason for dry-run creating the new template for simulation purposes", - "default": false + "default": "false" }, "master_timeout": { "type": "time", @@ -54,6 +54,7 @@ }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for this template simulation (default: false)" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.split.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.split.json index 25cb26504c2ff..c6f65119823bd 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.split.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.split.json @@ -38,6 +38,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -47,6 +48,7 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.unfreeze.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.unfreeze.json index 1f3f432b88b47..158c357615ae3 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.unfreeze.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.unfreeze.json @@ -34,6 +34,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -43,10 +44,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.update_aliases.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.update_aliases.json index 73d382b4be124..a9a13b85b5f6f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.update_aliases.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.update_aliases.json @@ -27,6 +27,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Request timeout" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.validate_query.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.validate_query.json index ec457fe8b7abd..b33b9f430577a 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.validate_query.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.validate_query.json @@ -41,14 +41,17 @@ "params": { "explain": { "type": "boolean", + "default": false, "description": "Return detailed information about the error" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { @@ -73,6 +76,7 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "default_operator": { @@ -90,14 +94,17 @@ }, "lenient": { "type": "boolean", + "default": false, "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" }, "rewrite": { "type": "boolean", + "default": false, "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed." }, "all_shards": { "type": "boolean", + "default": false, "description": "Execute validation on all shards instead of one random shard per index" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/inference.delete.json b/rest-api-spec/src/main/resources/rest-api-spec/api/inference.delete.json index 4b4905bf612c4..05bf989e2b1be 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/inference.delete.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/inference.delete.json @@ -46,10 +46,12 @@ "params": { "dry_run": { "type": "boolean", + "default": false, "description": "If true the endpoint will not be deleted and a list of ingest processors which reference this endpoint will be returned." }, "force": { "type": "boolean", + "default": false, "description": "If true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields)." } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.delete_geoip_database.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.delete_geoip_database.json index 911ec218439b8..715e634883ac1 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.delete_geoip_database.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.delete_geoip_database.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.delete_ip_location_database.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.delete_ip_location_database.json index 26301c2205386..5b24356058050 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.delete_ip_location_database.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.delete_ip_location_database.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.delete_pipeline.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.delete_pipeline.json index 89c174bfdde1a..01bd1ac819828 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.delete_pipeline.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.delete_pipeline.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.get_pipeline.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.get_pipeline.json index 0c629c152d8ac..e107894205bc3 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.get_pipeline.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.get_pipeline.json @@ -36,6 +36,7 @@ "params": { "summary": { "type": "boolean", + "default": false, "description": "Return pipelines without their definitions (default: false)" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.put_geoip_database.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.put_geoip_database.json index 7f96173f79667..c32eab109444b 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.put_geoip_database.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.put_geoip_database.json @@ -38,6 +38,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.put_ip_location_database.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.put_ip_location_database.json index 51e3f579f0297..74024ab32b476 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.put_ip_location_database.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.put_ip_location_database.json @@ -38,6 +38,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.put_pipeline.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.put_pipeline.json index 07ccaa6d94195..fcd3e505db39f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.put_pipeline.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.put_pipeline.json @@ -42,6 +42,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/license.delete.json b/rest-api-spec/src/main/resources/rest-api-spec/api/license.delete.json index 5ab828f52aed2..26923e03a9933 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/license.delete.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/license.delete.json @@ -29,6 +29,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/license.get.json b/rest-api-spec/src/main/resources/rest-api-spec/api/license.get.json index ec048ba70a4fd..60a1ccaf0e42a 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/license.get.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/license.get.json @@ -24,12 +24,14 @@ "params": { "local": { "type": "boolean", + "default": true, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "accept_enterprise": { "type": "boolean", - "description": "Supported for backwards compatibility with 7.x. If this param is used it must be set to true", - "deprecated": true + "deprecated": true, + "default": true, + "description": "Supported for backwards compatibility with 7.x. If this param is used it must be set to true" } } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/license.post.json b/rest-api-spec/src/main/resources/rest-api-spec/api/license.post.json index 614c3c1eb4d49..70f237f5763e4 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/license.post.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/license.post.json @@ -28,6 +28,7 @@ "params": { "acknowledge": { "type": "boolean", + "default": false, "description": "whether the user has acknowledged acknowledge messages (default: false)" }, "master_timeout": { @@ -37,6 +38,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/license.post_start_basic.json b/rest-api-spec/src/main/resources/rest-api-spec/api/license.post_start_basic.json index 61fa0753040e9..3da91362680f5 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/license.post_start_basic.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/license.post_start_basic.json @@ -33,6 +33,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/mget.json b/rest-api-spec/src/main/resources/rest-api-spec/api/mget.json index 1c11f712ba653..49b9d5fc59547 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/mget.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/mget.json @@ -47,6 +47,7 @@ }, "stored_fields": { "type": "list", + "default": "false", "description": "A comma-separated list of stored fields to return in the response" }, "preference": { @@ -55,10 +56,12 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specify whether to perform the operation in realtime or search mode" }, "refresh": { "type": "boolean", + "default": false, "description": "Refresh the shard containing the document before performing the operation" }, "routing": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.close_job.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.close_job.json index 3afa564015743..a5666b34196aa 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.close_job.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.close_job.json @@ -33,14 +33,17 @@ "params": { "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)" }, "force": { "type": "boolean", + "default": false, "description": "True if the job should be forcefully closed" }, "timeout": { "type": "time", + "default": "30m", "description": "Controls the time to wait until a job has closed. Default to 30 minutes" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_data_frame_analytics.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_data_frame_analytics.json index f6498cf3e3883..c5b0c9184acd3 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_data_frame_analytics.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_data_frame_analytics.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Controls the time to wait until a job is deleted. Defaults to 1 minute" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_expired_data.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_expired_data.json index c79dbb19b7462..440d133b3a492 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_expired_data.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_expired_data.json @@ -43,6 +43,7 @@ }, "timeout": { "type": "time", + "default": "8h", "description": "How long can the underlying delete processes run until they are canceled" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_forecast.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_forecast.json index 71196ec133716..cbe2c5eccbd43 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_forecast.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_forecast.json @@ -46,10 +46,12 @@ "params": { "allow_no_forecasts": { "type": "boolean", + "default": true, "description": "Whether to ignore if `_all` matches no forecasts" }, "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.forecast.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.forecast.json index 2ec27b882a439..c0466209aa5f7 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.forecast.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.forecast.json @@ -33,14 +33,17 @@ "params": { "duration": { "type": "time", + "default": "1d", "description": "The duration of the forecast" }, "expires_in": { "type": "time", + "default": "14d", "description": "The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity." }, "max_model_memory": { "type": "string", + "default": "20mb", "description": "The max memory able to be used by the forecast. Default is 20mb." } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_buckets.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_buckets.json index f2c423c7f47bc..c6b95857c5151 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_buckets.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_buckets.json @@ -51,38 +51,47 @@ "params": { "expand": { "type": "boolean", + "default": false, "description": "Include anomaly records" }, "exclude_interim": { "type": "boolean", + "default": false, "description": "Exclude interim results" }, "from": { "type": "int", + "default": 0, "description": "skips a number of buckets" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of buckets to get" }, "start": { "type": "string", + "default": "-1", "description": "Start time filter for buckets" }, "end": { "type": "string", + "default": "-1", "description": "End time filter for buckets" }, "anomaly_score": { "type": "double", + "default": 0, "description": "Filter for the most anomalous buckets" }, "sort": { "type": "string", + "default": "timestamp", "description": "Sort buckets by a particular field" }, "desc": { "type": "boolean", + "default": false, "description": "Set the sort direction" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_calendar_events.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_calendar_events.json index 23d5e3b0b701b..ebcca354b878e 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_calendar_events.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_calendar_events.json @@ -42,10 +42,12 @@ }, "from": { "type": "int", + "default": 0, "description": "Skips a number of events" }, "size": { "type": "int", + "default": 100, "description": "Specifies a max number of events to get" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_calendars.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_calendars.json index 68f3ccf0e91d5..dd315e327e820 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_calendars.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_calendars.json @@ -41,10 +41,12 @@ "params": { "from": { "type": "int", + "default": 0, "description": "skips a number of calendars" }, "size": { "type": "int", + "default": 10000, "description": "specifies a max number of calendars to get" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_categories.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_categories.json index 38af4561fc42b..698fac0b922d6 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_categories.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_categories.json @@ -51,10 +51,12 @@ "params": { "from": { "type": "int", + "default": 0, "description": "skips a number of categories" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of categories to get" }, "partition_field_value": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_filters.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_filters.json index 3dacc91e1f221..9204cf4fd5ad9 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_filters.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_filters.json @@ -36,10 +36,12 @@ "params": { "from": { "type": "int", + "default": 0, "description": "skips a number of filters" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of filters to get" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_influencers.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_influencers.json index 4e596b411bef1..0001bae05e892 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_influencers.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_influencers.json @@ -34,26 +34,32 @@ "params": { "exclude_interim": { "type": "boolean", + "default": false, "description": "Exclude interim results" }, "from": { "type": "int", + "default": 0, "description": "skips a number of influencers" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of influencers to get" }, "start": { "type": "string", + "default": "-1", "description": "start timestamp for the requested influencers" }, "end": { "type": "string", + "default": "-1", "description": "end timestamp for the requested influencers" }, "influencer_score": { "type": "double", + "default": 0, "description": "influencer score threshold for the requested influencers" }, "sort": { @@ -62,6 +68,7 @@ }, "desc": { "type": "boolean", + "default": false, "description": "whether the results should be sorted in decending order" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_job_stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_job_stats.json index 852fa807770dc..e9bf35ac884d5 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_job_stats.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_job_stats.json @@ -36,6 +36,7 @@ "params": { "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_jobs.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_jobs.json index 4d56e75be0197..73dd0e71b5642 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_jobs.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_jobs.json @@ -36,6 +36,7 @@ "params": { "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)" }, "exclude_generated": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_memory_stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_memory_stats.json index 548e0629ecc1c..c4a30e7d6a4a7 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_memory_stats.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_memory_stats.json @@ -41,6 +41,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_model_snapshots.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_model_snapshots.json index fc9f4b6597c2d..1a3d0fb156bd1 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_model_snapshots.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_model_snapshots.json @@ -51,10 +51,12 @@ "params": { "from": { "type": "int", + "default": 0, "description": "Skips a number of documents" }, "size": { "type": "int", + "default": 100, "description": "The default number of documents returned in queries as a string." }, "start": { @@ -71,6 +73,7 @@ }, "desc": { "type": "boolean", + "default": false, "description": "True if the results should be sorted in descending order" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_overall_buckets.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_overall_buckets.json index cbdc9bb119169..487ae1a17c32e 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_overall_buckets.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_overall_buckets.json @@ -34,6 +34,7 @@ "params": { "top_n": { "type": "int", + "default": 1, "description": "The number of top job bucket scores to be used in the overall_score calculation" }, "bucket_span": { @@ -46,6 +47,7 @@ }, "exclude_interim": { "type": "boolean", + "default": false, "description": "If true overall buckets that include interim buckets will be excluded" }, "start": { @@ -58,6 +60,7 @@ }, "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_records.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_records.json index a2b92613f77fa..afdd59e049bbc 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_records.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_records.json @@ -34,34 +34,42 @@ "params": { "exclude_interim": { "type": "boolean", + "default": false, "description": "Exclude interim results" }, "from": { "type": "int", + "default": 0, "description": "skips a number of records" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of records to get" }, "start": { "type": "string", + "default": "-1", "description": "Start time filter for records" }, "end": { "type": "string", + "default": "-1", "description": "End time filter for records" }, "record_score": { "type": "double", + "default": 0, "description": "Returns records with anomaly scores greater or equal than this value" }, "sort": { "type": "string", + "default": "record_score", "description": "Sort records by a particular field" }, "desc": { "type": "boolean", + "default": false, "description": "Set the sort direction" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.put_datafeed.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.put_datafeed.json index 27bb39a55bb64..da68170b66b72 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.put_datafeed.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.put_datafeed.json @@ -37,14 +37,17 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Ignore unavailable indexes (default: false)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Ignore if the source indices expressions resolves to no concrete indices (default: true)" }, "ignore_throttled": { "type": "boolean", + "default": true, "description": "Ignore indices that are marked as throttled (default: true)" }, "expand_wildcards": { @@ -56,6 +59,7 @@ "none", "all" ], + "default": "open", "description": "Whether source index expressions should get expanded to open or closed indices (default: open)" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.put_job.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.put_job.json index 7c3f2cf7f55fe..08b080bb9acfb 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.put_job.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.put_job.json @@ -33,14 +33,17 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Ignore unavailable indexes (default: false). Only set if datafeed_config is provided." }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Ignore if the source indices expressions resolves to no concrete indices (default: true). Only set if datafeed_config is provided." }, "ignore_throttled": { "type": "boolean", + "default": true, "description": "Ignore indices that are marked as throttled (default: true). Only set if datafeed_config is provided." }, "expand_wildcards": { @@ -52,6 +55,7 @@ "none", "all" ], + "default": "open", "description": "Whether source index expressions should get expanded to open or closed indices (default: open). Only set if datafeed_config is provided." } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.put_trained_model_alias.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.put_trained_model_alias.json index 1ba8adb13c73d..c539366488e45 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.put_trained_model_alias.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.put_trained_model_alias.json @@ -37,6 +37,7 @@ "params": { "reassign": { "type": "boolean", + "default": false, "description": "If the model_alias already exists and points to a separate model_id, this parameter must be true. Defaults to false." } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.revert_model_snapshot.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.revert_model_snapshot.json index 6eadc69c902cf..8a53051b45b08 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.revert_model_snapshot.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.revert_model_snapshot.json @@ -37,6 +37,7 @@ "params": { "delete_intervening_results": { "type": "boolean", + "default": false, "description": "Should we reset the results back to the time of the snapshot?" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.set_upgrade_mode.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.set_upgrade_mode.json index 7daf00777990a..cfb507b228bc5 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.set_upgrade_mode.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.set_upgrade_mode.json @@ -24,10 +24,12 @@ "params": { "enabled": { "type": "boolean", + "default": false, "description": "Whether to enable upgrade_mode ML setting or not. Defaults to false." }, "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait before action times out. Defaults to 30 seconds" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_data_frame_analytics.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_data_frame_analytics.json index e3504a37e77cb..4ed0dbd23d955 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_data_frame_analytics.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_data_frame_analytics.json @@ -33,6 +33,7 @@ "params": { "timeout": { "type": "time", + "default": "20s", "description": "Controls the time to wait until the task has started. Defaults to 20 seconds" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_datafeed.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_datafeed.json index 299fec8cbc52c..8d6e31cf24c2b 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_datafeed.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_datafeed.json @@ -41,6 +41,7 @@ }, "timeout": { "type": "time", + "default": "20s", "description": "Controls the time to wait until a datafeed has started. Default to 20 seconds" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_data_frame_analytics.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_data_frame_analytics.json index c65e2cf5d12e8..d44c2d5e5547c 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_data_frame_analytics.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_data_frame_analytics.json @@ -33,14 +33,17 @@ "params": { "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)" }, "force": { "type": "boolean", + "default": false, "description": "True if the data frame analytics should be forcefully stopped" }, "timeout": { "type": "time", + "default": "20s", "description": "Controls the time to wait until the task has stopped. Defaults to 20 seconds" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_datafeed.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_datafeed.json index 07ede870d38e1..389d3099c158d 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_datafeed.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_datafeed.json @@ -33,14 +33,17 @@ "params": { "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)" }, "force": { "type": "boolean", + "default": false, "description": "True if the datafeed should be forcefully stopped." }, "timeout": { "type": "time", + "default": "20s", "description": "Controls the time to wait until a datafeed has stopped. Default to 20 seconds" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_trained_model_deployment.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_trained_model_deployment.json index dcff856260b7a..6b8e740e3b552 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_trained_model_deployment.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_trained_model_deployment.json @@ -34,10 +34,12 @@ "params": { "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no deployments. (This includes `_all` string or when no deployments have been specified)" }, "force": { "type": "boolean", + "default": false, "description": "True if the deployment should be forcefully stopped" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.update_datafeed.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.update_datafeed.json index 1de277eb6f69c..dff67ab3d5c60 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.update_datafeed.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.update_datafeed.json @@ -37,14 +37,17 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Ignore unavailable indexes (default: false)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Ignore if the source indices expressions resolves to no concrete indices (default: true)" }, "ignore_throttled": { "type": "boolean", + "default": true, "description": "Ignore indices that are marked as throttled (default: true)" }, "expand_wildcards": { @@ -56,6 +59,7 @@ "none", "all" ], + "default": "open", "description": "Whether source index expressions should get expanded to open or closed indices (default: open)" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.update_trained_model_deployment.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.update_trained_model_deployment.json index cfa56bd3f1880..2a8fee32ce2d9 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.update_trained_model_deployment.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.update_trained_model_deployment.json @@ -33,6 +33,7 @@ "params": { "number_of_allocations": { "type": "int", + "default": 1, "description": "Update the model deployment to this number of allocations." } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.upgrade_job_snapshot.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.upgrade_job_snapshot.json index 15f6ac39ac7c3..83fa0bb6cc587 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.upgrade_job_snapshot.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.upgrade_job_snapshot.json @@ -34,10 +34,12 @@ "params": { "timeout": { "type": "time", + "default": "30m", "description": "How long should the API wait for the job to be opened and the old snapshot to be loaded." }, "wait_for_completion": { "type": "boolean", + "default": false, "description": "Should the request wait until the task is complete before responding to the caller. Default is false." } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/msearch.json b/rest-api-spec/src/main/resources/rest-api-spec/api/msearch.json index 4bdbf46596b2d..bd74e58141aee 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/msearch.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/msearch.json @@ -72,7 +72,7 @@ "ccs_minimize_roundtrips": { "type": "boolean", "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", - "default": "true" + "default": true }, "index": { "type": "list", @@ -80,12 +80,14 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "ignore_throttled": { "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled", - "deprecated": true + "deprecated": true, + "default": false, + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled" }, "allow_no_indices": { "type": "boolean", diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/msearch_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/msearch_template.json index 26e6acbdb18b7..b4aca115e2cf4 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/msearch_template.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/msearch_template.json @@ -49,6 +49,7 @@ }, "typed_keys": { "type": "boolean", + "default": false, "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response" }, "max_concurrent_searches": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/mtermvectors.json b/rest-api-spec/src/main/resources/rest-api-spec/api/mtermvectors.json index f18bf913fe287..5d293a3c7fa13 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/mtermvectors.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/mtermvectors.json @@ -82,6 +82,7 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specifies if requests are real-time as opposed to near-real-time (default: true)." }, "version": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.hot_threads.json b/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.hot_threads.json index cb388390f6b02..48b484670476d 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.hot_threads.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.hot_threads.json @@ -36,18 +36,22 @@ "params": { "interval": { "type": "time", + "default": "500ms", "description": "The interval for the second sampling of threads" }, "snapshots": { "type": "number", + "default": 10, "description": "Number of samples of thread stacktrace (default: 10)" }, "threads": { "type": "number", + "default": 3, "description": "Specify the number of threads to provide information for (default: 3)" }, "ignore_idle_threads": { "type": "boolean", + "default": true, "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)" }, "type": { @@ -58,6 +62,7 @@ "block", "mem" ], + "default": "cpu", "description": "The type to sample (default: cpu)" }, "sort": { @@ -70,6 +75,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.info.json b/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.info.json index f78a187de5c5c..d6353adf60ba4 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.info.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.info.json @@ -92,10 +92,12 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.reload_secure_settings.json b/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.reload_secure_settings.json index 2302621f3a202..519e67a4c8e7f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.reload_secure_settings.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.reload_secure_settings.json @@ -39,6 +39,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.stats.json index fffddfa3b30b8..308b4b607819f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.stats.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.stats.json @@ -226,6 +226,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "include_segment_file_sizes": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.usage.json b/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.usage.json index 3940a24859a36..f60d3255316d0 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.usage.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/nodes.usage.json @@ -72,6 +72,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/open_point_in_time.json b/rest-api-spec/src/main/resources/rest-api-spec/api/open_point_in_time.json index 8ed416924525c..13e82d21417db 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/open_point_in_time.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/open_point_in_time.json @@ -41,6 +41,7 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "expand_wildcards": { @@ -62,6 +63,7 @@ }, "allow_partial_search_results": { "type": "boolean", + "default": false, "description": "Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception. (default: false)" }, "max_concurrent_shard_requests": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/put_script.json b/rest-api-spec/src/main/resources/rest-api-spec/api/put_script.json index c3f7effd9796d..3bc55655191c3 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/put_script.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/put_script.json @@ -51,6 +51,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/rank_eval.json b/rest-api-spec/src/main/resources/rest-api-spec/api/rank_eval.json index 74f7b62539c0e..7ebc062ab7a94 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/rank_eval.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/rank_eval.json @@ -41,10 +41,12 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/reindex.json b/rest-api-spec/src/main/resources/rest-api-spec/api/reindex.json index 0936c7fa45a72..0cbfe13522768 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/reindex.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/reindex.json @@ -27,6 +27,7 @@ "params": { "refresh": { "type": "boolean", + "default": false, "description": "Should the affected indexes be refreshed?" }, "timeout": { @@ -36,6 +37,7 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)" }, "wait_for_completion": { @@ -45,7 +47,7 @@ }, "requests_per_second": { "type": "number", - "default": 0, + "default": -1, "description": "The throttle to set on this request in sub-requests per second. -1 means no throttle." }, "scroll": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/rollup.stop_job.json b/rest-api-spec/src/main/resources/rest-api-spec/api/rollup.stop_job.json index 9f0d605190886..579629691145b 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/rollup.stop_job.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/rollup.stop_job.json @@ -30,10 +30,12 @@ "params": { "wait_for_completion": { "type": "boolean", + "default": false, "description": "True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false." }, "timeout": { "type": "time", + "default": "30s", "description": "Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s." } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/scroll.json b/rest-api-spec/src/main/resources/rest-api-spec/api/scroll.json index f266bf5902c27..80b6520fd4ff9 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/scroll.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/scroll.json @@ -46,6 +46,7 @@ "params": { "scroll": { "type": "time", + "default": "1d", "description": "Specify how long a consistent view of the index should be maintained for scrolled search" }, "scroll_id": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/search.json b/rest-api-spec/src/main/resources/rest-api-spec/api/search.json index 0ba67885e2138..e29442ae0df25 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/search.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/search.json @@ -45,12 +45,13 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", - "default": "true" + "default": true }, "default_operator": { "type": "enum", @@ -67,6 +68,7 @@ }, "explain": { "type": "boolean", + "default": false, "description": "Specify whether to return detailed information about score computation as part of a hit" }, "stored_fields": { @@ -79,6 +81,7 @@ }, "from": { "type": "number", + "default": 0, "description": "Starting offset (default: 0)" }, "force_synthetic_source": { @@ -89,14 +92,17 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "ignore_throttled": { "type": "boolean", + "default": true, "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { @@ -113,6 +119,7 @@ }, "lenient": { "type": "boolean", + "default": false, "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" }, "preference": { @@ -141,6 +148,7 @@ }, "size": { "type": "number", + "default": 10, "description": "Number of hits to return (default: 10)" }, "sort": { @@ -149,6 +157,7 @@ }, "_source": { "type": "list", + "default": "true", "description": "True or false to return the _source field or not, or a list of fields to return" }, "_source_excludes": { @@ -161,6 +170,7 @@ }, "terminate_after": { "type": "number", + "default": 0, "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early." }, "stats": { @@ -195,10 +205,12 @@ }, "track_scores": { "type": "boolean", + "default": false, "description": "Whether to calculate and return scores even if they are not used for sorting" }, "track_total_hits": { "type": "boolean|long", + "default": "10000", "description": "Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number." }, "allow_partial_search_results": { @@ -208,10 +220,12 @@ }, "typed_keys": { "type": "boolean", + "default": false, "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response" }, "version": { "type": "boolean", + "default": false, "description": "Specify whether to return document version as part of a hit" }, "seq_no_primary_term": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.list.json b/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.list.json index 2eb530e5c92b3..955a79864fbf3 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.list.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.list.json @@ -28,6 +28,7 @@ }, "from": { "type": "int", + "default": 0, "description": "Starting offset (default: 0)" }, "size": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.put.json b/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.put.json index 5103df79e6e58..ec15cd8f11093 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.put.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.put.json @@ -33,6 +33,7 @@ "params": { "create": { "type": "boolean", + "default": false, "description": "If true, requires that a search application with the specified resource_id does not already exist. (default: false)" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/search_mvt.json b/rest-api-spec/src/main/resources/rest-api-spec/api/search_mvt.json index b6f1bd3c6fa64..d8940f93538d7 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/search_mvt.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/search_mvt.json @@ -89,6 +89,7 @@ }, "track_total_hits": { "type": "boolean|long", + "default": "10000", "description": "Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number." }, "with_labels": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/search_shards.json b/rest-api-spec/src/main/resources/rest-api-spec/api/search_shards.json index b3d0a2e2d9a64..45ef719a1ad07 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/search_shards.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/search_shards.json @@ -46,14 +46,17 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": false, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/search_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/search_template.json index 3af3a2aa0ab0b..1b1186fc6f7ec 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/search_template.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/search_template.json @@ -41,14 +41,17 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "ignore_throttled": { "type": "boolean", + "default": true, "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { @@ -85,14 +88,17 @@ }, "explain": { "type": "boolean", + "default": false, "description": "Specify whether to return detailed information about score computation as part of a hit" }, "profile": { "type": "boolean", + "default": false, "description": "Specify whether to profile the query execution" }, "typed_keys": { "type": "boolean", + "default": false, "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response" }, "rest_total_hits_as_int": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/searchable_snapshots.clear_cache.json b/rest-api-spec/src/main/resources/rest-api-spec/api/searchable_snapshots.clear_cache.json index 5fddd4e98d5b4..e93452f15b9e7 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/searchable_snapshots.clear_cache.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/searchable_snapshots.clear_cache.json @@ -47,6 +47,7 @@ "options": [ "open", "closed", + "hidden", "none", "all" ], diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/searchable_snapshots.mount.json b/rest-api-spec/src/main/resources/rest-api-spec/api/searchable_snapshots.mount.json index 8c5c0d7634b4c..1da334ff6f612 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/searchable_snapshots.mount.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/searchable_snapshots.mount.json @@ -48,7 +48,7 @@ "storage": { "type": "string", "description": "Selects the kind of local storage used to accelerate searches. Experimental, and defaults to `full_copy`", - "default": false + "default": "full_copy" } }, "body": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/security.disable_user_profile.json b/rest-api-spec/src/main/resources/rest-api-spec/api/security.disable_user_profile.json index 375f46339a66e..6b762d2713f76 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/security.disable_user_profile.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/security.disable_user_profile.json @@ -36,6 +36,7 @@ "false", "wait_for" ], + "default": "false", "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes." } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/security.enable_user_profile.json b/rest-api-spec/src/main/resources/rest-api-spec/api/security.enable_user_profile.json index cba413023bbdd..a3db70683c8b3 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/security.enable_user_profile.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/security.enable_user_profile.json @@ -36,6 +36,7 @@ "false", "wait_for" ], + "default": "false", "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes." } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/security.grant_api_key.json b/rest-api-spec/src/main/resources/rest-api-spec/api/security.grant_api_key.json index eb1d370c4ddfb..46d29eb59d2b6 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/security.grant_api_key.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/security.grant_api_key.json @@ -32,6 +32,7 @@ "false", "wait_for" ], + "default": "false", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes." } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/security.put_user.json b/rest-api-spec/src/main/resources/rest-api-spec/api/security.put_user.json index c5ee34da8195c..95ab3f4227e4c 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/security.put_user.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/security.put_user.json @@ -39,6 +39,7 @@ "false", "wait_for" ], + "default": "true", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes." } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/security.update_user_profile_data.json b/rest-api-spec/src/main/resources/rest-api-spec/api/security.update_user_profile_data.json index bf0f9c2c3d01a..c8fd48b682d00 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/security.update_user_profile_data.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/security.update_user_profile_data.json @@ -47,6 +47,7 @@ "false", "wait_for" ], + "default": "false", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes." } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/shutdown.delete_node.json b/rest-api-spec/src/main/resources/rest-api-spec/api/shutdown.delete_node.json index 724b5f0c16d72..4c23966b32f4f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/shutdown.delete_node.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/shutdown.delete_node.json @@ -38,6 +38,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/shutdown.put_node.json b/rest-api-spec/src/main/resources/rest-api-spec/api/shutdown.put_node.json index e70492a778832..8bfc6ea743321 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/shutdown.put_node.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/shutdown.put_node.json @@ -38,6 +38,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.delete_lifecycle.json b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.delete_lifecycle.json index 7884045da94e6..a6a46d485bf66 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.delete_lifecycle.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.delete_lifecycle.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.execute_lifecycle.json b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.execute_lifecycle.json index 81a8b9f19c709..637ffbb9dce52 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.execute_lifecycle.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.execute_lifecycle.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.execute_retention.json b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.execute_retention.json index ef9a8f686d544..42117d1db492c 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.execute_retention.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.execute_retention.json @@ -29,6 +29,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.get_lifecycle.json b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.get_lifecycle.json index 362277f52fc8d..775ed4556e1f4 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.get_lifecycle.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.get_lifecycle.json @@ -41,6 +41,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.get_stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.get_stats.json index f80738e260d02..7a09535cbf2f8 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.get_stats.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.get_stats.json @@ -29,6 +29,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.get_status.json b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.get_status.json index d9ed8e056e885..b62e11f834701 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.get_status.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.get_status.json @@ -29,6 +29,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.put_lifecycle.json b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.put_lifecycle.json index d51e1f986c115..3095a694f6bba 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.put_lifecycle.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.put_lifecycle.json @@ -38,6 +38,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.start.json b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.start.json index 9d83e1e6fa110..a924d56bc6d3c 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.start.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.start.json @@ -29,6 +29,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.stop.json b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.stop.json index 23e50a36a696b..ca8892042bc56 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/slm.stop.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/slm.stop.json @@ -29,6 +29,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.cleanup_repository.json b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.cleanup_repository.json index 81a6e33f4adb7..8a9d5bb0945ee 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.cleanup_repository.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.cleanup_repository.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.create_repository.json b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.create_repository.json index a703ade8811f9..b12a359b0d4ea 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.create_repository.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.create_repository.json @@ -39,10 +39,12 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "verify": { "type": "boolean", + "default": true, "description": "Whether to verify the repository after creation" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.delete_repository.json b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.delete_repository.json index fdc879aabe7d5..8054528fefdb8 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.delete_repository.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.delete_repository.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.get.json b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.get.json index 82d3c022cfb6f..9f1357024acad 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.get.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.get.json @@ -39,18 +39,22 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown" }, "index_names": { "type": "boolean", + "default": true, "description": "Whether to include the name of each index in the snapshot. Defaults to true." }, "index_details": { "type": "boolean", + "default": false, "description": "Whether to include details of each index in the snapshot, if those details are available. Defaults to false." }, "include_repository": { "type": "boolean", + "default": true, "description": "Whether to include the repository name in the snapshot info. Defaults to true." }, "sort": { @@ -69,6 +73,7 @@ }, "size": { "type": "integer", + "default": 0, "description": "Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit." }, "order": { @@ -90,6 +95,7 @@ }, "offset": { "type": "integer", + "default": 0, "description": "Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0" }, "slm_policy_filter": { @@ -98,6 +104,7 @@ }, "verbose": { "type": "boolean", + "default": true, "description": "Whether to show verbose snapshot info or only show the basic info found in the repository index blob" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.get_repository.json b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.get_repository.json index 6088fa97d721f..4917a4550cffb 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.get_repository.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.get_repository.json @@ -41,6 +41,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.repository_analyze.json b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.repository_analyze.json index 36c7bbcc44bed..10aeefe3611b6 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.repository_analyze.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.repository_analyze.json @@ -30,22 +30,27 @@ "params": { "blob_count": { "type": "number", + "default": 100, "description": "Number of blobs to create during the test. Defaults to 100." }, "concurrency": { "type": "number", + "default": 10, "description": "Number of operations to run concurrently during the test. Defaults to 10." }, "register_operation_count": { "type": "number", + "default": 10, "description": "The minimum number of linearizable register operations to perform in total. Defaults to 10." }, "read_node_count": { "type": "number", + "default": 10, "description": "Number of nodes on which to read a blob after writing. Defaults to 10." }, "early_read_node_count": { "type": "number", + "default": 2, "description": "Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the 'rare_action_probability' parameter is also relevant. Defaults to 2." }, "seed": { @@ -54,26 +59,32 @@ }, "rare_action_probability": { "type": "number", + "default": 0, "description": "Probability of taking a rare action such as an early read or an overwrite. Defaults to 0.02." }, "max_blob_size": { "type": "string", + "default": "10mb", "description": "Maximum size of a blob to create during the test, e.g '1gb' or '100mb'. Defaults to '10mb'." }, "max_total_data_size": { "type": "string", + "default": "1gb", "description": "Maximum total size of all blobs to create during the test, e.g '1tb' or '100gb'. Defaults to '1gb'." }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout. Defaults to '30s'." }, "detailed": { "type": "boolean", + "default": false, "description": "Whether to return detailed results or a summary. Defaults to 'false' so that only the summary is returned." }, "rarely_abort_writes": { "type": "boolean", + "default": true, "description": "Whether to rarely abort writes before they complete. Defaults to 'true'." } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.repository_verify_integrity.json b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.repository_verify_integrity.json index 4ea5898b95ecb..115b61f1b0e13 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.repository_verify_integrity.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.repository_verify_integrity.json @@ -30,34 +30,42 @@ "params": { "meta_thread_pool_concurrency": { "type": "number", + "default": 0, "description": "Number of threads to use for reading metadata" }, "blob_thread_pool_concurrency": { "type": "number", + "default": 1, "description": "Number of threads to use for reading blob contents" }, "snapshot_verification_concurrency": { "type": "number", + "default": 0, "description": "Number of snapshots to verify concurrently" }, "index_verification_concurrency": { "type": "number", + "default": 0, "description": "Number of indices to verify concurrently" }, "index_snapshot_verification_concurrency": { "type": "number", + "default": 1, "description": "Number of snapshots to verify concurrently within each index" }, "max_failed_shard_snapshots": { "type": "number", + "default": 10000, "description": "Maximum permitted number of failed shard snapshots" }, "verify_blob_contents": { "type": "boolean", + "default": false, "description": "Whether to verify the contents of individual blobs" }, "max_bytes_per_sec": { "type": "string", + "default": "10mb", "description": "Rate limit for individual blob verification" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.status.json b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.status.json index 2df6466e176d9..0521f98a0821c 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.status.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.status.json @@ -57,6 +57,7 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.verify_repository.json b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.verify_repository.json index 9c13cb5bce52d..5ad8528d84182 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.verify_repository.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.verify_repository.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/streams.logs_disable.json b/rest-api-spec/src/main/resources/rest-api-spec/api/streams.logs_disable.json index a003447be4001..3dbe137740b94 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/streams.logs_disable.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/streams.logs_disable.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/streams.logs_enable.json b/rest-api-spec/src/main/resources/rest-api-spec/api/streams.logs_enable.json index 3db4182d32b18..86e611caabdd5 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/streams.logs_enable.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/streams.logs_enable.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." }, "master_timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/streams.status.json b/rest-api-spec/src/main/resources/rest-api-spec/api/streams.status.json index ef9f597b3ecb7..0e5359019a456 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/streams.status.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/streams.status.json @@ -22,6 +22,12 @@ } ] }, - "params": {} + "params": { + "master_timeout": { + "type": "time", + "default": "30s", + "description": "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/rest-api-spec/src/main/resources/rest-api-spec/api/tasks.cancel.json b/rest-api-spec/src/main/resources/rest-api-spec/api/tasks.cancel.json index 9a00bf9c3f7eb..0ad75d3f2244f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/tasks.cancel.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/tasks.cancel.json @@ -48,6 +48,7 @@ }, "wait_for_completion": { "type": "boolean", + "default": false, "description": "Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/tasks.get.json b/rest-api-spec/src/main/resources/rest-api-spec/api/tasks.get.json index cdde989c1a06c..c3abd3d375844 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/tasks.get.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/tasks.get.json @@ -30,10 +30,12 @@ "params": { "wait_for_completion": { "type": "boolean", + "default": false, "description": "Wait for the matching tasks to complete (default: false)" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/tasks.list.json b/rest-api-spec/src/main/resources/rest-api-spec/api/tasks.list.json index e435729a4a833..ba156a3345192 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/tasks.list.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/tasks.list.json @@ -32,6 +32,7 @@ }, "detailed": { "type": "boolean", + "default": false, "description": "Return detailed task information (default: false)" }, "parent_task_id": { @@ -40,6 +41,7 @@ }, "wait_for_completion": { "type": "boolean", + "default": false, "description": "Wait for the matching tasks to complete (default: false)" }, "group_by": { @@ -54,6 +56,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/termvectors.json b/rest-api-spec/src/main/resources/rest-api-spec/api/termvectors.json index 82c311fd56f82..1751cd481b625 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/termvectors.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/termvectors.json @@ -88,6 +88,7 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specifies if request is real-time as opposed to near-real-time (default: true)." }, "version": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.find_field_structure.json b/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.find_field_structure.json index 838d0f93bf106..b19327fe8c293 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.find_field_structure.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.find_field_structure.json @@ -74,6 +74,7 @@ }, "ecs_compatibility": { "type": "string", + "default": "disabled", "description": "Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'" }, "timestamp_field": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.find_message_structure.json b/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.find_message_structure.json index cab33f028d533..45f3649c2cc6f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.find_message_structure.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.find_message_structure.json @@ -63,6 +63,7 @@ }, "ecs_compatibility": { "type": "string", + "default": "disabled", "description": "Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'" }, "timestamp_field": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.find_structure.json b/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.find_structure.json index 3f108583d7c23..376c6cfe2a4c9 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.find_structure.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.find_structure.json @@ -80,6 +80,7 @@ }, "ecs_compatibility": { "type": "string", + "default": "disabled", "description": "Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'" }, "timestamp_field": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.test_grok_pattern.json b/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.test_grok_pattern.json index aa8cbaff67b76..343e2b6ce3971 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.test_grok_pattern.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.test_grok_pattern.json @@ -28,6 +28,7 @@ "params": { "ecs_compatibility": { "type": "string", + "default": "disabled", "description": "Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.delete_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.delete_transform.json index 232728790717c..34b94995315a6 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.delete_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.delete_transform.json @@ -30,14 +30,17 @@ "params": { "force": { "type": "boolean", + "default": false, "description": "When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted." }, "delete_dest_index": { "type": "boolean", + "default": false, "description": "When `true`, the destination index is deleted together with the transform. The default value is `false`, meaning that the destination index will not be deleted." }, "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait for the transform deletion" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform.json index d01981eb84888..3e47856f7cfc7 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform.json @@ -36,14 +36,17 @@ "params": { "from": { "type": "int", + "default": 0, "description": "skips a number of transform configs, defaults to 0" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of transforms to get, defaults to 100" }, "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)" }, "exclude_generated": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform_stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform_stats.json index 0e8a887cab93b..16f5c0c89af0d 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform_stats.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform_stats.json @@ -30,10 +30,12 @@ "params": { "from": { "type": "number", + "default": 0, "description": "skips a number of transform stats, defaults to 0" }, "size": { "type": "number", + "default": 100, "description": "specifies a max number of transform stats to get, defaults to 100" }, "timeout": { @@ -42,6 +44,7 @@ }, "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.preview_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.preview_transform.json index 411be11388e37..2a9538cf5c6e5 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.preview_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.preview_transform.json @@ -41,6 +41,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait for the preview" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.put_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.put_transform.json index 1c618dd316143..91d869cc0e458 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.put_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.put_transform.json @@ -33,10 +33,12 @@ "params": { "defer_validation": { "type": "boolean", + "default": false, "description": "If validations should be deferred until transform starts, defaults to false." }, "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait for the transform to start" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.reset_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.reset_transform.json index b8946c65e1447..1322e327cb3ea 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.reset_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.reset_transform.json @@ -30,10 +30,12 @@ "params": { "force": { "type": "boolean", + "default": false, "description": "When `true`, the transform is reset regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be reset." }, "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait for the transform to reset" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.schedule_now_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.schedule_now_transform.json index d7d4a7c2b90a6..1cd37d65a0d27 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.schedule_now_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.schedule_now_transform.json @@ -34,6 +34,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait for the scheduling to take place" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.set_upgrade_mode.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.set_upgrade_mode.json index 2dc472e4ce6e4..e3bfdab287c6d 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.set_upgrade_mode.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.set_upgrade_mode.json @@ -24,10 +24,12 @@ "params": { "enabled": { "type": "boolean", + "default": false, "description": "Whether to enable upgrade_mode Transform setting or not. Defaults to false." }, "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait before action times out. Defaults to 30 seconds" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.start_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.start_transform.json index ca32d93bac3ba..94bf026b6dadc 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.start_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.start_transform.json @@ -34,6 +34,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait for the transform to start" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.stop_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.stop_transform.json index f824205829699..6d6eb2d05178a 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.stop_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.stop_transform.json @@ -30,22 +30,27 @@ "params": { "force": { "type": "boolean", + "default": false, "description": "Whether to force stop a failed transform or not. Default to false" }, "wait_for_completion": { "type": "boolean", + "default": false, "description": "Whether to wait for the transform to fully stop before returning or not. Default to false" }, "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait until the transform has stopped. Default to 30 seconds" }, "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)" }, "wait_for_checkpoint": { "type": "boolean", + "default": false, "description": "Whether to wait for the transform to reach a checkpoint before stopping. Default to false" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.update_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.update_transform.json index 94658ad776da9..66ed229f9011b 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.update_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.update_transform.json @@ -38,6 +38,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait for the update" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.upgrade_transforms.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.upgrade_transforms.json index cd8e6586531f2..58ad4aed7f98e 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.upgrade_transforms.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.upgrade_transforms.json @@ -27,10 +27,12 @@ "params": { "dry_run": { "type": "boolean", + "default": false, "description": "Whether to only check for updates but don't execute" }, "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait for the upgrade" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/update.json b/rest-api-spec/src/main/resources/rest-api-spec/api/update.json index 0dc26b173215f..3ca88fe612cf2 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/update.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/update.json @@ -37,10 +37,12 @@ "params": { "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)" }, "_source": { "type": "list", + "default": "true", "description": "True or false to return the _source field or not, or a list of fields to return" }, "_source_excludes": { @@ -53,6 +55,7 @@ }, "lang": { "type": "string", + "default": "painless", "description": "The script language (default: painless)" }, "refresh": { @@ -62,10 +65,12 @@ "false", "wait_for" ], + "default": "false", "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes." }, "retry_on_conflict": { "type": "number", + "default": 0, "description": "Specify how many times should the operation be retried when a conflict occurs (default: 0)" }, "routing": { @@ -74,6 +79,7 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "if_seq_no": { @@ -86,10 +92,12 @@ }, "require_alias": { "type": "boolean", + "default": false, "description": "When true, requires destination is an alias. Default is false" }, "include_source_on_error": { "type": "boolean", + "default": true, "description": "True or false if to include the document source in the error message in case of parsing errors. Defaults to true." } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/update_by_query.json b/rest-api-spec/src/main/resources/rest-api-spec/api/update_by_query.json index b4bd10693fc27..19b41a12266c1 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/update_by_query.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/update_by_query.json @@ -37,6 +37,7 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "default_operator": { @@ -54,14 +55,17 @@ }, "from": { "type": "number", + "default": 0, "description": "Starting offset (default: 0)" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "conflicts": { @@ -87,6 +91,7 @@ }, "lenient": { "type": "boolean", + "default": false, "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" }, "pipeline": { @@ -107,6 +112,7 @@ }, "scroll": { "type": "time", + "default": "5m", "description": "Specify how long a consistent view of the index should be maintained for scrolled search" }, "search_type": { @@ -151,6 +157,7 @@ }, "refresh": { "type": "boolean", + "default": false, "description": "Should the affected indexes be refreshed?" }, "timeout": { @@ -160,11 +167,12 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)" }, "scroll_size": { "type": "number", - "default": 100, + "default": 1000, "description": "Size on the scroll request powering the update by query" }, "wait_for_completion": { @@ -174,7 +182,7 @@ }, "requests_per_second": { "type": "number", - "default": 0, + "default": -1, "description": "The throttle to set on this request in sub-requests per second. -1 means no throttle." }, "slices": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/update_by_query_rethrottle.json b/rest-api-spec/src/main/resources/rest-api-spec/api/update_by_query_rethrottle.json index 2d7313cba9667..f74c87ef96b31 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/update_by_query_rethrottle.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/update_by_query_rethrottle.json @@ -31,6 +31,7 @@ "requests_per_second": { "type": "number", "required": true, + "default": -1, "description": "The throttle to set on this request in floating sub-requests per second. -1 means set no throttle." } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.execute_watch.json b/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.execute_watch.json index 6eff5dedbcfca..561bca28bbb9a 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.execute_watch.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.execute_watch.json @@ -41,6 +41,7 @@ "params": { "debug": { "type": "boolean", + "default": false, "description": "indicates whether the watch should execute in debug mode" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.put_watch.json b/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.put_watch.json index f5ed7fc07e1bb..d6ce24c45d9b5 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.put_watch.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.put_watch.json @@ -34,6 +34,7 @@ "params": { "active": { "type": "boolean", + "default": true, "description": "Specify whether the watch is in/active by default" }, "version": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.stats.json index 68f53d36b295d..80d5c84af2d30 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.stats.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.stats.json @@ -52,6 +52,7 @@ }, "emit_stacktraces": { "type": "boolean", + "default": false, "description": "Emits stack traces of currently running watches" } }