diff --git a/output/schema/schema.json b/output/schema/schema.json index 7b76d29f0a..cc38186a04 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -11757,7 +11757,7 @@ "docUrl": null, "name": "knn_search", "request": null, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index 9b7efa5d7a..58ee2ecd9f 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -1,5 +1,16 @@ { - "endpointErrors": {}, + "endpointErrors": { + "cat.segments": { + "request": [ + "Request: missing json spec query parameter 'ignore_unavailable'", + "Request: missing json spec query parameter 'ignore_throttled'", + "Request: missing json spec query parameter 'allow_no_indices'", + "Request: missing json spec query parameter 'expand_wildcards'", + "Request: missing json spec query parameter 'allow_closed'" + ], + "response": [] + } + }, "generalErrors": [ "Dangling type '_global.scripts_painless_execute:PainlessExecutionPosition'", "Dangling type '_global.scripts_painless_execute:PainlessScript'", diff --git a/specification/_json_spec/_internal.update_desired_nodes.json b/specification/_json_spec/_internal.update_desired_nodes.json index 0b49c16c62..72c16720c1 100644 --- a/specification/_json_spec/_internal.update_desired_nodes.json +++ b/specification/_json_spec/_internal.update_desired_nodes.json @@ -21,7 +21,7 @@ "description": "the history id" }, "version": { - "type": "integer", + "type": "int", "description": "the version number" } } diff --git a/specification/_json_spec/async_search.status.json b/specification/_json_spec/async_search.status.json index d7cc480d2d..6cefe95fe0 100644 --- a/specification/_json_spec/async_search.status.json +++ b/specification/_json_spec/async_search.status.json @@ -26,6 +26,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/specification/_json_spec/async_search.submit.json b/specification/_json_spec/async_search.submit.json index 70a6c2f25d..bfb55ef4ba 100644 --- a/specification/_json_spec/async_search.submit.json +++ b/specification/_json_spec/async_search.submit.json @@ -45,12 +45,13 @@ "default": "5d" }, "batched_reduce_size": { - "type": "number", + "type": "long", "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available.", "default": 5 }, "request_cache": { "type": "boolean", + "default": true, "description": "Specify if request cache should be used for this request or not, defaults to true" }, "analyzer": { @@ -68,8 +69,8 @@ }, "default_operator": { "type": "enum", - "options": ["AND", "OR"], - "default": "OR", + "options": ["and", "or"], + "default": "or", "description": "The default operator for query string query (AND or OR)" }, "df": { @@ -89,7 +90,7 @@ "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit" }, "from": { - "type": "number", + "type": "int", "description": "Starting offset (default: 0)" }, "ignore_unavailable": { @@ -141,7 +142,7 @@ "description": "Search operation type" }, "size": { - "type": "number", + "type": "int", "description": "Number of hits to return (default: 10)" }, "sort": { @@ -161,7 +162,7 @@ "description": "A list of fields to extract and return from the _source field" }, "terminate_after": { - "type": "number", + "type": "long", "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early." }, "stats": { @@ -179,7 +180,7 @@ "description": "Specify suggest mode" }, "suggest_size": { - "type": "number", + "type": "long", "description": "How many suggestions to return in response" }, "suggest_text": { @@ -216,13 +217,14 @@ "description": "Specify whether to return sequence number and primary term of the last modification of each hit" }, "max_concurrent_shard_requests": { - "type": "number", + "type": "int", "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", "default": 5 } }, "body": { - "description": "The search definition using the Query DSL" + "description": "The search definition using the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/autoscaling.delete_autoscaling_policy.json b/specification/_json_spec/autoscaling.delete_autoscaling_policy.json index d2ae7a2f6c..20183fcfc9 100644 --- a/specification/_json_spec/autoscaling.delete_autoscaling_policy.json +++ b/specification/_json_spec/autoscaling.delete_autoscaling_policy.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/specification/_json_spec/autoscaling.put_autoscaling_policy.json b/specification/_json_spec/autoscaling.put_autoscaling_policy.json index ddf8844284..48ecc2294e 100644 --- a/specification/_json_spec/autoscaling.put_autoscaling_policy.json +++ b/specification/_json_spec/autoscaling.put_autoscaling_policy.json @@ -32,6 +32,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } }, diff --git a/specification/_json_spec/bulk.json b/specification/_json_spec/bulk.json index 5758d8721e..95dd4f0720 100644 --- a/specification/_json_spec/bulk.json +++ b/specification/_json_spec/bulk.json @@ -31,11 +31,13 @@ "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": { "type": "enum", "options": ["true", "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": { @@ -44,6 +46,7 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "_source": { @@ -64,18 +67,22 @@ }, "require_alias": { "type": "boolean", + "default": false, "description": "If true, the request's actions must target an index alias. Defaults to false." }, "require_data_stream": { "type": "boolean", + "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/specification/_json_spec/cat.allocation.json b/specification/_json_spec/cat.allocation.json index e9619ba60d..0f41072b13 100644 --- a/specification/_json_spec/cat.allocation.json +++ b/specification/_json_spec/cat.allocation.json @@ -45,6 +45,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/specification/_json_spec/cat.component_templates.json b/specification/_json_spec/cat.component_templates.json index 307d6bb2b1..a0726ba991 100644 --- a/specification/_json_spec/cat.component_templates.json +++ b/specification/_json_spec/cat.component_templates.json @@ -35,6 +35,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/specification/_json_spec/cat.master.json b/specification/_json_spec/cat.master.json index beba459f17..d57a92fab8 100644 --- a/specification/_json_spec/cat.master.json +++ b/specification/_json_spec/cat.master.json @@ -25,6 +25,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/specification/_json_spec/cat.ml_data_frame_analytics.json b/specification/_json_spec/cat.ml_data_frame_analytics.json index c184e31fa8..240d036f68 100644 --- a/specification/_json_spec/cat.ml_data_frame_analytics.json +++ b/specification/_json_spec/cat.ml_data_frame_analytics.json @@ -30,6 +30,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": { @@ -44,6 +45,7 @@ }, "h": { "type": "list", + "default": "create_time,id,state,type", "description": "Comma-separated list of column names to display" }, "help": { diff --git a/specification/_json_spec/cat.ml_datafeeds.json b/specification/_json_spec/cat.ml_datafeeds.json index 3cc24754f3..3a370e943b 100644 --- a/specification/_json_spec/cat.ml_datafeeds.json +++ b/specification/_json_spec/cat.ml_datafeeds.json @@ -30,6 +30,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": { @@ -39,6 +40,7 @@ }, "h": { "type": "list", + "default": "['bc', 'id', 'sc', 's']", "description": "Comma-separated list of column names to display" }, "help": { diff --git a/specification/_json_spec/cat.ml_jobs.json b/specification/_json_spec/cat.ml_jobs.json index 304979056f..1e1ff05b88 100644 --- a/specification/_json_spec/cat.ml_jobs.json +++ b/specification/_json_spec/cat.ml_jobs.json @@ -30,6 +30,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": { @@ -44,6 +45,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/specification/_json_spec/cat.nodeattrs.json b/specification/_json_spec/cat.nodeattrs.json index 1f6931aa5a..0bd62a78d9 100644 --- a/specification/_json_spec/cat.nodeattrs.json +++ b/specification/_json_spec/cat.nodeattrs.json @@ -25,6 +25,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/specification/_json_spec/cat.nodes.json b/specification/_json_spec/cat.nodes.json index b297f8ea8f..4e687f2e4e 100644 --- a/specification/_json_spec/cat.nodes.json +++ b/specification/_json_spec/cat.nodes.json @@ -30,6 +30,7 @@ }, "full_id": { "type": "boolean", + "default": false, "description": "Return the full node ID instead of the shortened version (default: false)" }, "master_timeout": { @@ -39,6 +40,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/specification/_json_spec/cat.pending_tasks.json b/specification/_json_spec/cat.pending_tasks.json index a2bb597fc9..8db95f12b2 100644 --- a/specification/_json_spec/cat.pending_tasks.json +++ b/specification/_json_spec/cat.pending_tasks.json @@ -25,6 +25,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/specification/_json_spec/cat.plugins.json b/specification/_json_spec/cat.plugins.json index 05ae6a49be..77d44dd75a 100644 --- a/specification/_json_spec/cat.plugins.json +++ b/specification/_json_spec/cat.plugins.json @@ -25,6 +25,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/specification/_json_spec/cat.recovery.json b/specification/_json_spec/cat.recovery.json index a568082a70..bf9a513cc8 100644 --- a/specification/_json_spec/cat.recovery.json +++ b/specification/_json_spec/cat.recovery.json @@ -50,6 +50,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/specification/_json_spec/cat.segments.json b/specification/_json_spec/cat.segments.json index b8848a5c0f..d33bb93cd4 100644 --- a/specification/_json_spec/cat.segments.json +++ b/specification/_json_spec/cat.segments.json @@ -35,6 +35,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { @@ -49,6 +50,7 @@ }, "h": { "type": "list", + "default": "ip,hp,rp,r,m,n,cpu,l", "description": "Comma-separated list of column names to display" }, "help": { @@ -69,6 +71,29 @@ "type": "enum", "description": "The unit in which to display time values", "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] + }, + "ignore_unavailable": { + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed). Only allowed when providing an index expression." + }, + "ignore_throttled": { + "type": "boolean", + "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", + "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": { + "type": "enum", + "options": ["open", "closed", "hidden", "none", "all"], + "default": "open", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both." + }, + "allow_closed": { + "type": "boolean", + "description": "If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour of throwing an exception if index pattern matches closed indices", + "default": false } } } diff --git a/specification/_json_spec/cat.snapshots.json b/specification/_json_spec/cat.snapshots.json index 78bad84c22..9733a93bf0 100644 --- a/specification/_json_spec/cat.snapshots.json +++ b/specification/_json_spec/cat.snapshots.json @@ -45,6 +45,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/specification/_json_spec/cat.tasks.json b/specification/_json_spec/cat.tasks.json index 94c54e9194..0d952f290f 100644 --- a/specification/_json_spec/cat.tasks.json +++ b/specification/_json_spec/cat.tasks.json @@ -33,6 +33,7 @@ }, "detailed": { "type": "boolean", + "default": false, "description": "Return detailed task information (default: false)" }, "parent_task_id": { diff --git a/specification/_json_spec/cat.templates.json b/specification/_json_spec/cat.templates.json index 2adf171932..fc69b211b2 100644 --- a/specification/_json_spec/cat.templates.json +++ b/specification/_json_spec/cat.templates.json @@ -35,6 +35,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/specification/_json_spec/cat.thread_pool.json b/specification/_json_spec/cat.thread_pool.json index 2ddcccd6a1..4b72a21f2c 100644 --- a/specification/_json_spec/cat.thread_pool.json +++ b/specification/_json_spec/cat.thread_pool.json @@ -40,6 +40,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/specification/_json_spec/cat.transforms.json b/specification/_json_spec/cat.transforms.json index dba1ce927d..99d93b1eb5 100644 --- a/specification/_json_spec/cat.transforms.json +++ b/specification/_json_spec/cat.transforms.json @@ -30,14 +30,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": { @@ -47,6 +50,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/specification/_json_spec/ccr.follow_stats.json b/specification/_json_spec/ccr.follow_stats.json index bd6405d646..0852bb3f4f 100644 --- a/specification/_json_spec/ccr.follow_stats.json +++ b/specification/_json_spec/ccr.follow_stats.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ccr.forget_follower.json b/specification/_json_spec/ccr.forget_follower.json index 23ea493603..b1cab12116 100644 --- a/specification/_json_spec/ccr.forget_follower.json +++ b/specification/_json_spec/ccr.forget_follower.json @@ -27,6 +27,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/ccr.stats.json b/specification/_json_spec/ccr.stats.json index 51b3ed0ae1..70993a4f5d 100644 --- a/specification/_json_spec/ccr.stats.json +++ b/specification/_json_spec/ccr.stats.json @@ -20,6 +20,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/specification/_json_spec/clear_scroll.json b/specification/_json_spec/clear_scroll.json index 31881b7c3a..ae8974a419 100644 --- a/specification/_json_spec/clear_scroll.json +++ b/specification/_json_spec/clear_scroll.json @@ -35,7 +35,8 @@ }, "params": {}, "body": { - "description": "A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter" + "description": "A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter", + "required": false } } } diff --git a/specification/_json_spec/close_point_in_time.json b/specification/_json_spec/close_point_in_time.json index d81eb9f46d..19dec7215b 100644 --- a/specification/_json_spec/close_point_in_time.json +++ b/specification/_json_spec/close_point_in_time.json @@ -20,7 +20,8 @@ }, "params": {}, "body": { - "description": "a point-in-time id to close" + "description": "a point-in-time id to close", + "required": true } } } diff --git a/specification/_json_spec/cluster.allocation_explain.json b/specification/_json_spec/cluster.allocation_explain.json index 1710ecf758..47056bfda4 100644 --- a/specification/_json_spec/cluster.allocation_explain.json +++ b/specification/_json_spec/cluster.allocation_explain.json @@ -24,7 +24,7 @@ "description": "Specifies the name of the index that you would like an explanation for" }, "shard": { - "type": "number", + "type": "int", "description": "Specifies the ID of the shard that you would like an explanation for" }, "primary": { @@ -42,15 +42,18 @@ }, "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)" } }, "body": { - "description": "The index, shard, and primary flag to explain. Empty means 'explain a randomly-chosen unassigned shard'" + "description": "The index, shard, and primary flag to explain. Empty means 'explain a randomly-chosen unassigned shard'", + "required": false } } } diff --git a/specification/_json_spec/cluster.delete_component_template.json b/specification/_json_spec/cluster.delete_component_template.json index caefdf48d7..19c84afb0c 100644 --- a/specification/_json_spec/cluster.delete_component_template.json +++ b/specification/_json_spec/cluster.delete_component_template.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/specification/_json_spec/cluster.exists_component_template.json b/specification/_json_spec/cluster.exists_component_template.json index c99d5fb16d..0ce28f607f 100644 --- a/specification/_json_spec/cluster.exists_component_template.json +++ b/specification/_json_spec/cluster.exists_component_template.json @@ -32,6 +32,7 @@ "local": { "deprecated": true, "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/specification/_json_spec/cluster.get_component_template.json b/specification/_json_spec/cluster.get_component_template.json index 542a9ee0b5..8c18bfc80f 100644 --- a/specification/_json_spec/cluster.get_component_template.json +++ b/specification/_json_spec/cluster.get_component_template.json @@ -36,14 +36,17 @@ "local": { "deprecated": true, "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/specification/_json_spec/cluster.get_settings.json b/specification/_json_spec/cluster.get_settings.json index 2122e854f5..363a0780ff 100644 --- a/specification/_json_spec/cluster.get_settings.json +++ b/specification/_json_spec/cluster.get_settings.json @@ -20,6 +20,7 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { @@ -29,6 +30,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "include_defaults": { diff --git a/specification/_json_spec/cluster.health.json b/specification/_json_spec/cluster.health.json index 5872557875..55c9036715 100644 --- a/specification/_json_spec/cluster.health.json +++ b/specification/_json_spec/cluster.health.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": { @@ -51,10 +52,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": { @@ -68,10 +71,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/specification/_json_spec/cluster.pending_tasks.json b/specification/_json_spec/cluster.pending_tasks.json index d2bf061221..27b20916cc 100644 --- a/specification/_json_spec/cluster.pending_tasks.json +++ b/specification/_json_spec/cluster.pending_tasks.json @@ -20,6 +20,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/specification/_json_spec/cluster.put_settings.json b/specification/_json_spec/cluster.put_settings.json index e17da45c9c..69246ee29c 100644 --- a/specification/_json_spec/cluster.put_settings.json +++ b/specification/_json_spec/cluster.put_settings.json @@ -30,6 +30,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/cluster.reroute.json b/specification/_json_spec/cluster.reroute.json index d704870ef3..41f86859c0 100644 --- a/specification/_json_spec/cluster.reroute.json +++ b/specification/_json_spec/cluster.reroute.json @@ -21,14 +21,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": { @@ -43,6 +46,7 @@ "master_node", "version" ], + "default": "all", "description": "Limit the information returned to the specified metrics. Defaults to all but metadata" }, "master_timeout": { @@ -52,11 +56,13 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, "body": { - "description": "The definition of `commands` to perform (`move`, `cancel`, `allocate`)" + "description": "The definition of `commands` to perform (`move`, `cancel`, `allocate`)", + "required": false } } } diff --git a/specification/_json_spec/cluster.state.json b/specification/_json_spec/cluster.state.json index e36034be2a..265ba6c010 100644 --- a/specification/_json_spec/cluster.state.json +++ b/specification/_json_spec/cluster.state.json @@ -65,6 +65,7 @@ "local": { "deprecated": true, "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { @@ -74,10 +75,11 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "wait_for_metadata_version": { - "type": "number", + "type": "long", "description": "Wait for the metadata version to be equal or greater than the specified metadata version" }, "wait_for_timeout": { @@ -86,10 +88,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/specification/_json_spec/cluster.stats.json b/specification/_json_spec/cluster.stats.json index 4e9c08dc7f..0b51fc9340 100644 --- a/specification/_json_spec/cluster.stats.json +++ b/specification/_json_spec/cluster.stats.json @@ -30,6 +30,7 @@ "params": { "include_remotes": { "type": "boolean", + "default": false, "description": "Include remote cluster data into the response (default: false)" }, "timeout": { diff --git a/specification/_json_spec/count.json b/specification/_json_spec/count.json index 11c8ec0096..8581ac3ef2 100644 --- a/specification/_json_spec/count.json +++ b/specification/_json_spec/count.json @@ -31,14 +31,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": { @@ -48,7 +51,7 @@ "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both." }, "min_score": { - "type": "number", + "type": "double", "description": "Include only documents with a specific `_score` value in the result" }, "preference": { @@ -73,12 +76,13 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "default_operator": { "type": "enum", - "options": ["AND", "OR"], - "default": "OR", + "options": ["and", "or"], + "default": "or", "description": "The default operator for query string query (AND or OR)" }, "df": { @@ -87,15 +91,17 @@ }, "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": { - "type": "number", + "type": "long", "description": "The maximum count for each shard, upon reaching which the query execution will terminate early" } }, "body": { - "description": "A query to restrict the results specified with the Query DSL (optional)" + "description": "A query to restrict the results specified with the Query DSL (optional)", + "required": false } } } diff --git a/specification/_json_spec/create.json b/specification/_json_spec/create.json index f98a9fe960..e472328289 100644 --- a/specification/_json_spec/create.json +++ b/specification/_json_spec/create.json @@ -31,11 +31,13 @@ "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": { "type": "enum", "options": ["true", "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": { @@ -44,10 +46,11 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { @@ -61,14 +64,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/specification/_json_spec/delete.json b/specification/_json_spec/delete.json index cde2086bba..d59aad041b 100644 --- a/specification/_json_spec/delete.json +++ b/specification/_json_spec/delete.json @@ -30,11 +30,13 @@ "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": { "type": "enum", "options": ["true", "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": { @@ -43,18 +45,19 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "if_seq_no": { - "type": "number", + "type": "long", "description": "only perform the delete operation if the last operation that has changed the document has the specified sequence number" }, "if_primary_term": { - "type": "number", + "type": "long", "description": "only perform the delete operation if the last operation that has changed the document has the specified primary term" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/delete_by_query.json b/specification/_json_spec/delete_by_query.json index 19c6469800..d77e88bcab 100644 --- a/specification/_json_spec/delete_by_query.json +++ b/specification/_json_spec/delete_by_query.json @@ -31,12 +31,13 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "default_operator": { "type": "enum", - "options": ["AND", "OR"], - "default": "OR", + "options": ["and", "or"], + "default": "or", "description": "The default operator for query string query (AND or OR)" }, "df": { @@ -44,15 +45,18 @@ "description": "The field to use as default where no field prefix is given in the query string" }, "from": { - "type": "number", + "type": "long", + "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": { @@ -69,6 +73,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": { @@ -97,7 +102,7 @@ "description": "Explicit timeout for each search request. Defaults to no timeout." }, "max_docs": { - "type": "number", + "type": "long", "description": "Maximum number of documents to process (default: all documents)" }, "sort": { @@ -105,7 +110,7 @@ "description": "A comma-separated list of : pairs" }, "terminate_after": { - "type": "number", + "type": "long", "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early." }, "stats": { @@ -122,6 +127,7 @@ }, "refresh": { "type": "boolean", + "default": false, "description": "Should the affected indexes be refreshed?" }, "timeout": { @@ -131,11 +137,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, + "type": "long", + "default": 1000, "description": "Size on the scroll request powering the delete by query" }, "wait_for_completion": { @@ -145,7 +152,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/specification/_json_spec/delete_script.json b/specification/_json_spec/delete_script.json index 74c7da8c78..e0fb1095c5 100644 --- a/specification/_json_spec/delete_script.json +++ b/specification/_json_spec/delete_script.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/specification/_json_spec/eql.search.json b/specification/_json_spec/eql.search.json index 2094be69c1..c25c9cf35e 100644 --- a/specification/_json_spec/eql.search.json +++ b/specification/_json_spec/eql.search.json @@ -56,10 +56,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/specification/_json_spec/esql.async_query.json b/specification/_json_spec/esql.async_query.json index e6329d6b2b..737b54a72b 100644 --- a/specification/_json_spec/esql.async_query.json +++ b/specification/_json_spec/esql.async_query.json @@ -26,7 +26,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/specification/_json_spec/esql.async_query_stop.json b/specification/_json_spec/esql.async_query_stop.json index 4e45255ac7..28aa4c9d44 100644 --- a/specification/_json_spec/esql.async_query_stop.json +++ b/specification/_json_spec/esql.async_query_stop.json @@ -22,6 +22,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/specification/_json_spec/esql.query.json b/specification/_json_spec/esql.query.json index d6552cecea..739c4652bd 100644 --- a/specification/_json_spec/esql.query.json +++ b/specification/_json_spec/esql.query.json @@ -26,7 +26,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/specification/_json_spec/exists.json b/specification/_json_spec/exists.json index 6aa0b1fd7d..93b53476fd 100644 --- a/specification/_json_spec/exists.json +++ b/specification/_json_spec/exists.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": { @@ -61,7 +63,7 @@ "description": "A list of fields to extract and return from the _source field" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/exists_source.json b/specification/_json_spec/exists_source.json index 0ed14905a8..574a433543 100644 --- a/specification/_json_spec/exists_source.json +++ b/specification/_json_spec/exists_source.json @@ -34,10 +34,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": { @@ -57,7 +59,7 @@ "description": "A list of fields to extract and return from the _source field" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/explain.json b/specification/_json_spec/explain.json index e3e4cc2151..53630185d1 100644 --- a/specification/_json_spec/explain.json +++ b/specification/_json_spec/explain.json @@ -31,6 +31,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": { @@ -39,8 +40,8 @@ }, "default_operator": { "type": "enum", - "options": ["AND", "OR"], - "default": "OR", + "options": ["and", "or"], + "default": "or", "description": "The default operator for query string query (AND or OR)" }, "df": { @@ -53,6 +54,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": { @@ -81,7 +83,8 @@ } }, "body": { - "description": "The query definition using the Query DSL" + "description": "The query definition using the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/field_caps.json b/specification/_json_spec/field_caps.json index 04c490f34d..1ae6d2794f 100644 --- a/specification/_json_spec/field_caps.json +++ b/specification/_json_spec/field_caps.json @@ -35,10 +35,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": { @@ -71,7 +73,8 @@ } }, "body": { - "description": "An index filter specified with the Query DSL" + "description": "An index filter specified with the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/fleet.global_checkpoints.json b/specification/_json_spec/fleet.global_checkpoints.json index e66d468b91..c69f51d6d7 100644 --- a/specification/_json_spec/fleet.global_checkpoints.json +++ b/specification/_json_spec/fleet.global_checkpoints.json @@ -28,12 +28,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/specification/_json_spec/fleet.search.json b/specification/_json_spec/fleet.search.json index 7737316d8e..80d62ef84c 100644 --- a/specification/_json_spec/fleet.search.json +++ b/specification/_json_spec/fleet.search.json @@ -41,7 +41,8 @@ } }, "body": { - "description": "The search definition using the Query DSL" + "description": "The search definition using the Query DSL", + "required": true } } } diff --git a/specification/_json_spec/get.json b/specification/_json_spec/get.json index 7ab5a94192..776455f993 100644 --- a/specification/_json_spec/get.json +++ b/specification/_json_spec/get.json @@ -44,10 +44,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": { @@ -68,10 +70,11 @@ }, "_source_exclude_vectors": { "type": "boolean", + "default": false, "description": "Whether vectors should be excluded from _source" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/get_source.json b/specification/_json_spec/get_source.json index 0c57cf7a09..6f784c0f55 100644 --- a/specification/_json_spec/get_source.json +++ b/specification/_json_spec/get_source.json @@ -34,10 +34,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": { @@ -57,7 +59,7 @@ "description": "A list of fields to extract and return from the _source field" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/graph.explore.json b/specification/_json_spec/graph.explore.json index af8e6bfb55..f68a153c7e 100644 --- a/specification/_json_spec/graph.explore.json +++ b/specification/_json_spec/graph.explore.json @@ -35,7 +35,8 @@ } }, "body": { - "description": "Graph Query DSL" + "description": "Graph Query DSL", + "required": true } } } diff --git a/specification/_json_spec/ilm.delete_lifecycle.json b/specification/_json_spec/ilm.delete_lifecycle.json index d8844a71fa..6dd11a2665 100644 --- a/specification/_json_spec/ilm.delete_lifecycle.json +++ b/specification/_json_spec/ilm.delete_lifecycle.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ilm.get_lifecycle.json b/specification/_json_spec/ilm.get_lifecycle.json index 7187eeaba3..fdb4775d85 100644 --- a/specification/_json_spec/ilm.get_lifecycle.json +++ b/specification/_json_spec/ilm.get_lifecycle.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ilm.migrate_to_data_tiers.json b/specification/_json_spec/ilm.migrate_to_data_tiers.json index c6805f21de..beb0dcb9a0 100644 --- a/specification/_json_spec/ilm.migrate_to_data_tiers.json +++ b/specification/_json_spec/ilm.migrate_to_data_tiers.json @@ -26,6 +26,7 @@ }, "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/specification/_json_spec/ilm.move_to_step.json b/specification/_json_spec/ilm.move_to_step.json index f8c9fd3e36..5f3554637c 100644 --- a/specification/_json_spec/ilm.move_to_step.json +++ b/specification/_json_spec/ilm.move_to_step.json @@ -26,7 +26,8 @@ }, "params": {}, "body": { - "description": "The new lifecycle step to move to" + "description": "The new lifecycle step to move to", + "required": true } } } diff --git a/specification/_json_spec/ilm.put_lifecycle.json b/specification/_json_spec/ilm.put_lifecycle.json index 5a47f10821..6bdae191ca 100644 --- a/specification/_json_spec/ilm.put_lifecycle.json +++ b/specification/_json_spec/ilm.put_lifecycle.json @@ -32,11 +32,13 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, "body": { - "description": "The lifecycle policy definition to register" + "description": "The lifecycle policy definition to register", + "required": true } } } diff --git a/specification/_json_spec/ilm.start.json b/specification/_json_spec/ilm.start.json index 43d7ec7590..4c28c02ca8 100644 --- a/specification/_json_spec/ilm.start.json +++ b/specification/_json_spec/ilm.start.json @@ -25,6 +25,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ilm.stop.json b/specification/_json_spec/ilm.stop.json index 0bf41556f8..289c3d12b6 100644 --- a/specification/_json_spec/ilm.stop.json +++ b/specification/_json_spec/ilm.stop.json @@ -25,6 +25,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/index.json b/specification/_json_spec/index.json index 2acdde3342..f8fd38cd40 100644 --- a/specification/_json_spec/index.json +++ b/specification/_json_spec/index.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 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": { @@ -51,6 +52,7 @@ "refresh": { "type": "enum", "options": ["true", "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": { @@ -59,10 +61,11 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { @@ -71,11 +74,11 @@ "description": "Specific version type" }, "if_seq_no": { - "type": "number", + "type": "long", "description": "only perform the index operation if the last operation that has changed the document has the specified sequence number" }, "if_primary_term": { - "type": "number", + "type": "long", "description": "only perform the index operation if the last operation that has changed the document has the specified primary term" }, "pipeline": { @@ -84,14 +87,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/specification/_json_spec/indices.add_block.json b/specification/_json_spec/indices.add_block.json index 3796e83ee9..36cedbc06d 100644 --- a/specification/_json_spec/indices.add_block.json +++ b/specification/_json_spec/indices.add_block.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": { diff --git a/specification/_json_spec/indices.analyze.json b/specification/_json_spec/indices.analyze.json index 0bb0a9e0fb..7f4d7b6818 100644 --- a/specification/_json_spec/indices.analyze.json +++ b/specification/_json_spec/indices.analyze.json @@ -35,7 +35,8 @@ } }, "body": { - "description": "Define analyzer/tokenizer parameters and the text on which the analysis should be performed" + "description": "Define analyzer/tokenizer parameters and the text on which the analysis should be performed", + "required": true } } } diff --git a/specification/_json_spec/indices.clear_cache.json b/specification/_json_spec/indices.clear_cache.json index af5469d729..62ea4b5255 100644 --- a/specification/_json_spec/indices.clear_cache.json +++ b/specification/_json_spec/indices.clear_cache.json @@ -42,10 +42,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/specification/_json_spec/indices.clone.json b/specification/_json_spec/indices.clone.json index 52138eb9db..85e90bd633 100644 --- a/specification/_json_spec/indices.clone.json +++ b/specification/_json_spec/indices.clone.json @@ -31,6 +31,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -40,11 +41,13 @@ }, "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." } }, "body": { - "description": "The configuration for the target index (`settings` and `aliases`)" + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": false } } } diff --git a/specification/_json_spec/indices.close.json b/specification/_json_spec/indices.close.json index 290ca9a242..ed9ec0f28b 100644 --- a/specification/_json_spec/indices.close.json +++ b/specification/_json_spec/indices.close.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -35,10 +36,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": { @@ -49,6 +52,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/specification/_json_spec/indices.create.json b/specification/_json_spec/indices.create.json index 6bc348b945..ca213e498c 100644 --- a/specification/_json_spec/indices.create.json +++ b/specification/_json_spec/indices.create.json @@ -27,10 +27,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": { @@ -40,7 +42,8 @@ } }, "body": { - "description": "The configuration for the index (`settings` and `mappings`)" + "description": "The configuration for the index (`settings` and `mappings`)", + "required": false } } } diff --git a/specification/_json_spec/indices.create_data_stream.json b/specification/_json_spec/indices.create_data_stream.json index 0a1e72bbd2..592e30dcb4 100644 --- a/specification/_json_spec/indices.create_data_stream.json +++ b/specification/_json_spec/indices.create_data_stream.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for acknowledging the cluster state update" }, "master_timeout": { diff --git a/specification/_json_spec/indices.delete.json b/specification/_json_spec/indices.delete.json index 2197c8a6ec..f63ca2ad35 100644 --- a/specification/_json_spec/indices.delete.json +++ b/specification/_json_spec/indices.delete.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -35,10 +36,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/specification/_json_spec/indices.delete_alias.json b/specification/_json_spec/indices.delete_alias.json index 3469778438..82d875f4ac 100644 --- a/specification/_json_spec/indices.delete_alias.json +++ b/specification/_json_spec/indices.delete_alias.json @@ -44,6 +44,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { diff --git a/specification/_json_spec/indices.delete_index_template.json b/specification/_json_spec/indices.delete_index_template.json index 34534747fb..c8d8ced179 100644 --- a/specification/_json_spec/indices.delete_index_template.json +++ b/specification/_json_spec/indices.delete_index_template.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/specification/_json_spec/indices.delete_template.json b/specification/_json_spec/indices.delete_template.json index 095983e895..d047052d89 100644 --- a/specification/_json_spec/indices.delete_template.json +++ b/specification/_json_spec/indices.delete_template.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/specification/_json_spec/indices.disk_usage.json b/specification/_json_spec/indices.disk_usage.json index d383625ec1..18319b4801 100644 --- a/specification/_json_spec/indices.disk_usage.json +++ b/specification/_json_spec/indices.disk_usage.json @@ -26,18 +26,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/specification/_json_spec/indices.exists.json b/specification/_json_spec/indices.exists.json index 7eb5342846..0cbadffe70 100644 --- a/specification/_json_spec/indices.exists.json +++ b/specification/_json_spec/indices.exists.json @@ -26,14 +26,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": { @@ -44,6 +47,7 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "include_defaults": { diff --git a/specification/_json_spec/indices.exists_alias.json b/specification/_json_spec/indices.exists_alias.json index e92c8f4b6c..a5e14aabaf 100644 --- a/specification/_json_spec/indices.exists_alias.json +++ b/specification/_json_spec/indices.exists_alias.json @@ -40,10 +40,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/specification/_json_spec/indices.exists_index_template.json b/specification/_json_spec/indices.exists_index_template.json index 22f8d89357..177943b923 100644 --- a/specification/_json_spec/indices.exists_index_template.json +++ b/specification/_json_spec/indices.exists_index_template.json @@ -26,6 +26,7 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { @@ -35,6 +36,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/specification/_json_spec/indices.exists_template.json b/specification/_json_spec/indices.exists_template.json index 827582b023..f4a859c8ab 100644 --- a/specification/_json_spec/indices.exists_template.json +++ b/specification/_json_spec/indices.exists_template.json @@ -26,6 +26,7 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { @@ -36,6 +37,7 @@ "local": { "deprecated": true, "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/specification/_json_spec/indices.field_usage_stats.json b/specification/_json_spec/indices.field_usage_stats.json index 82cb8f2017..e56d4b2672 100644 --- a/specification/_json_spec/indices.field_usage_stats.json +++ b/specification/_json_spec/indices.field_usage_stats.json @@ -30,6 +30,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/specification/_json_spec/indices.flush.json b/specification/_json_spec/indices.flush.json index 706c207676..e7be5a2abc 100644 --- a/specification/_json_spec/indices.flush.json +++ b/specification/_json_spec/indices.flush.json @@ -30,18 +30,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/specification/_json_spec/indices.forcemerge.json b/specification/_json_spec/indices.forcemerge.json index befcda41a4..fb5bc29308 100644 --- a/specification/_json_spec/indices.forcemerge.json +++ b/specification/_json_spec/indices.forcemerge.json @@ -47,7 +47,7 @@ "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both." }, "max_num_segments": { - "type": "number", + "type": "long", "description": "The number of segments the index should be merged into (default: dynamic)" }, "only_expunge_deletes": { diff --git a/specification/_json_spec/indices.get.json b/specification/_json_spec/indices.get.json index 62e663557a..96c81c6a68 100644 --- a/specification/_json_spec/indices.get.json +++ b/specification/_json_spec/indices.get.json @@ -26,14 +26,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": { @@ -50,6 +53,7 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "include_defaults": { diff --git a/specification/_json_spec/indices.get_alias.json b/specification/_json_spec/indices.get_alias.json index c263cc3f72..947eace028 100644 --- a/specification/_json_spec/indices.get_alias.json +++ b/specification/_json_spec/indices.get_alias.json @@ -54,10 +54,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/specification/_json_spec/indices.get_data_lifecycle.json b/specification/_json_spec/indices.get_data_lifecycle.json index a067bef879..fb8d4fb73c 100644 --- a/specification/_json_spec/indices.get_data_lifecycle.json +++ b/specification/_json_spec/indices.get_data_lifecycle.json @@ -32,6 +32,7 @@ }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for the data stream (default: false)" }, "master_timeout": { diff --git a/specification/_json_spec/indices.get_data_stream.json b/specification/_json_spec/indices.get_data_stream.json index 6a690bb417..646e5844ef 100644 --- a/specification/_json_spec/indices.get_data_stream.json +++ b/specification/_json_spec/indices.get_data_stream.json @@ -36,6 +36,7 @@ }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for the data stream (default: false)" }, "master_timeout": { @@ -45,6 +46,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/specification/_json_spec/indices.get_field_mapping.json b/specification/_json_spec/indices.get_field_mapping.json index 7bc404b48b..51955706f7 100644 --- a/specification/_json_spec/indices.get_field_mapping.json +++ b/specification/_json_spec/indices.get_field_mapping.json @@ -40,14 +40,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/specification/_json_spec/indices.get_index_template.json b/specification/_json_spec/indices.get_index_template.json index 802a48e82e..1c7b97c2ed 100644 --- a/specification/_json_spec/indices.get_index_template.json +++ b/specification/_json_spec/indices.get_index_template.json @@ -30,6 +30,7 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { @@ -40,10 +41,12 @@ "local": { "deprecated": true, "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/specification/_json_spec/indices.get_mapping.json b/specification/_json_spec/indices.get_mapping.json index 9d9feb19f9..7f3d930470 100644 --- a/specification/_json_spec/indices.get_mapping.json +++ b/specification/_json_spec/indices.get_mapping.json @@ -30,10 +30,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": { @@ -49,8 +51,9 @@ }, "local": { "type": "boolean", - "description": "Return local information, do not retrieve the state from master node (default: false)", - "deprecated": true + "deprecated": true, + "default": false, + "description": "Return local information, do not retrieve the state from master node (default: false)" } } } diff --git a/specification/_json_spec/indices.get_settings.json b/specification/_json_spec/indices.get_settings.json index 419b8af685..22d07c3521 100644 --- a/specification/_json_spec/indices.get_settings.json +++ b/specification/_json_spec/indices.get_settings.json @@ -59,10 +59,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": { @@ -73,11 +75,13 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "local": { "deprecated": true, "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "include_defaults": { diff --git a/specification/_json_spec/indices.get_template.json b/specification/_json_spec/indices.get_template.json index 796fc63d0b..d30a3be0ab 100644 --- a/specification/_json_spec/indices.get_template.json +++ b/specification/_json_spec/indices.get_template.json @@ -30,6 +30,7 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { @@ -40,6 +41,7 @@ "local": { "deprecated": true, "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/specification/_json_spec/indices.migrate_to_data_stream.json b/specification/_json_spec/indices.migrate_to_data_stream.json index 7bf74c9815..1bc53824a0 100644 --- a/specification/_json_spec/indices.migrate_to_data_stream.json +++ b/specification/_json_spec/indices.migrate_to_data_stream.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for acknowledging the cluster state update" }, "master_timeout": { diff --git a/specification/_json_spec/indices.open.json b/specification/_json_spec/indices.open.json index b5be892e19..5c27090e05 100644 --- a/specification/_json_spec/indices.open.json +++ b/specification/_json_spec/indices.open.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -35,10 +36,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": { @@ -49,6 +52,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/specification/_json_spec/indices.put_alias.json b/specification/_json_spec/indices.put_alias.json index 67073c33ef..6c0f3b73e2 100644 --- a/specification/_json_spec/indices.put_alias.json +++ b/specification/_json_spec/indices.put_alias.json @@ -45,6 +45,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { diff --git a/specification/_json_spec/indices.put_data_lifecycle.json b/specification/_json_spec/indices.put_data_lifecycle.json index 7d7255adb2..362fa41a71 100644 --- a/specification/_json_spec/indices.put_data_lifecycle.json +++ b/specification/_json_spec/indices.put_data_lifecycle.json @@ -33,6 +33,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { @@ -42,7 +43,8 @@ } }, "body": { - "description": "The data stream lifecycle configuration that consist of the data retention" + "description": "The data stream lifecycle configuration that consist of the data retention", + "required": true } } } diff --git a/specification/_json_spec/indices.put_data_stream_mappings.json b/specification/_json_spec/indices.put_data_stream_mappings.json index 264736e467..a5c33f3aac 100644 --- a/specification/_json_spec/indices.put_data_stream_mappings.json +++ b/specification/_json_spec/indices.put_data_stream_mappings.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Period to wait for a response" }, "master_timeout": { diff --git a/specification/_json_spec/indices.put_data_stream_options.json b/specification/_json_spec/indices.put_data_stream_options.json index c4e93db91d..5f087ca80b 100644 --- a/specification/_json_spec/indices.put_data_stream_options.json +++ b/specification/_json_spec/indices.put_data_stream_options.json @@ -33,6 +33,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { @@ -42,7 +43,8 @@ } }, "body": { - "description": "The data stream options configuration that consist of the failure store configuration" + "description": "The data stream options configuration that consist of the failure store configuration", + "required": true } } } diff --git a/specification/_json_spec/indices.put_data_stream_settings.json b/specification/_json_spec/indices.put_data_stream_settings.json index aa89992191..5ef9932506 100644 --- a/specification/_json_spec/indices.put_data_stream_settings.json +++ b/specification/_json_spec/indices.put_data_stream_settings.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Period to wait for a response" }, "master_timeout": { diff --git a/specification/_json_spec/indices.put_index_template.json b/specification/_json_spec/indices.put_index_template.json index 25fbf145cf..810ad7b02b 100644 --- a/specification/_json_spec/indices.put_index_template.json +++ b/specification/_json_spec/indices.put_index_template.json @@ -33,7 +33,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/specification/_json_spec/indices.put_mapping.json b/specification/_json_spec/indices.put_mapping.json index e11749392b..3ce04268d8 100644 --- a/specification/_json_spec/indices.put_mapping.json +++ b/specification/_json_spec/indices.put_mapping.json @@ -27,6 +27,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -36,10 +37,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/specification/_json_spec/indices.put_settings.json b/specification/_json_spec/indices.put_settings.json index 88d0847baa..60b1e83f76 100644 --- a/specification/_json_spec/indices.put_settings.json +++ b/specification/_json_spec/indices.put_settings.json @@ -36,22 +36,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": { @@ -62,6 +67,7 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" } }, diff --git a/specification/_json_spec/indices.put_template.json b/specification/_json_spec/indices.put_template.json index 8caf083184..9d7f96094d 100644 --- a/specification/_json_spec/indices.put_template.json +++ b/specification/_json_spec/indices.put_template.json @@ -26,7 +26,7 @@ }, "params": { "order": { - "type": "number", + "type": "int", "description": "The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)" }, "create": { diff --git a/specification/_json_spec/indices.refresh.json b/specification/_json_spec/indices.refresh.json index 1ee6a4f2b3..dac659538d 100644 --- a/specification/_json_spec/indices.refresh.json +++ b/specification/_json_spec/indices.refresh.json @@ -30,10 +30,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/specification/_json_spec/indices.remove_block.json b/specification/_json_spec/indices.remove_block.json index 20f12e7f0e..39fc1f3181 100644 --- a/specification/_json_spec/indices.remove_block.json +++ b/specification/_json_spec/indices.remove_block.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": { diff --git a/specification/_json_spec/indices.resolve_cluster.json b/specification/_json_spec/indices.resolve_cluster.json index 83034f1787..2164811a2b 100644 --- a/specification/_json_spec/indices.resolve_cluster.json +++ b/specification/_json_spec/indices.resolve_cluster.json @@ -30,14 +30,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/specification/_json_spec/indices.rollover.json b/specification/_json_spec/indices.rollover.json index e81972e445..079cc26a17 100644 --- a/specification/_json_spec/indices.rollover.json +++ b/specification/_json_spec/indices.rollover.json @@ -41,10 +41,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": { @@ -54,16 +56,18 @@ }, "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." } }, "body": { - "description": "The conditions that needs to be met for executing rollover" + "description": "The conditions that needs to be met for executing rollover", + "required": false } } } diff --git a/specification/_json_spec/indices.segments.json b/specification/_json_spec/indices.segments.json index d4d523e73f..e4e02ffcc3 100644 --- a/specification/_json_spec/indices.segments.json +++ b/specification/_json_spec/indices.segments.json @@ -30,10 +30,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/specification/_json_spec/indices.shard_stores.json b/specification/_json_spec/indices.shard_stores.json index 338b50af45..dd0f8d3449 100644 --- a/specification/_json_spec/indices.shard_stores.json +++ b/specification/_json_spec/indices.shard_stores.json @@ -35,6 +35,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/specification/_json_spec/indices.shrink.json b/specification/_json_spec/indices.shrink.json index 0f14e0d1b2..e1a7a39dee 100644 --- a/specification/_json_spec/indices.shrink.json +++ b/specification/_json_spec/indices.shrink.json @@ -31,6 +31,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -40,11 +41,13 @@ }, "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." } }, "body": { - "description": "The configuration for the target index (`settings` and `aliases`)" + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": true } } } diff --git a/specification/_json_spec/indices.simulate_index_template.json b/specification/_json_spec/indices.simulate_index_template.json index 62731ee33e..30860558e1 100644 --- a/specification/_json_spec/indices.simulate_index_template.json +++ b/specification/_json_spec/indices.simulate_index_template.json @@ -33,7 +33,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", @@ -42,6 +42,7 @@ }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for this index template simulation (default: false)" } }, diff --git a/specification/_json_spec/indices.simulate_template.json b/specification/_json_spec/indices.simulate_template.json index a5f043cbb0..ef163a3694 100644 --- a/specification/_json_spec/indices.simulate_template.json +++ b/specification/_json_spec/indices.simulate_template.json @@ -37,7 +37,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", @@ -46,6 +46,7 @@ }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for this template simulation (default: false)" } }, diff --git a/specification/_json_spec/indices.split.json b/specification/_json_spec/indices.split.json index 3af07f1410..c14e5ce38b 100644 --- a/specification/_json_spec/indices.split.json +++ b/specification/_json_spec/indices.split.json @@ -31,6 +31,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -40,11 +41,13 @@ }, "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." } }, "body": { - "description": "The configuration for the target index (`settings` and `aliases`)" + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": true } } } diff --git a/specification/_json_spec/indices.update_aliases.json b/specification/_json_spec/indices.update_aliases.json index 4c65242537..5e810b1a3b 100644 --- a/specification/_json_spec/indices.update_aliases.json +++ b/specification/_json_spec/indices.update_aliases.json @@ -21,6 +21,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Request timeout" }, "master_timeout": { diff --git a/specification/_json_spec/indices.validate_query.json b/specification/_json_spec/indices.validate_query.json index 09f067a434..33eda568f8 100644 --- a/specification/_json_spec/indices.validate_query.json +++ b/specification/_json_spec/indices.validate_query.json @@ -31,14 +31,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": { @@ -57,12 +60,13 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "default_operator": { "type": "enum", - "options": ["AND", "OR"], - "default": "OR", + "options": ["and", "or"], + "default": "or", "description": "The default operator for query string query (AND or OR)" }, "df": { @@ -71,19 +75,23 @@ }, "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" } }, "body": { - "description": "The query definition specified with the Query DSL" + "description": "The query definition specified with the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/inference.chat_completion_unified.json b/specification/_json_spec/inference.chat_completion_unified.json index 6caf2db748..d3971b4bab 100644 --- a/specification/_json_spec/inference.chat_completion_unified.json +++ b/specification/_json_spec/inference.chat_completion_unified.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.completion.json b/specification/_json_spec/inference.completion.json index cb4f1f98a6..d561dcbb41 100644 --- a/specification/_json_spec/inference.completion.json +++ b/specification/_json_spec/inference.completion.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.delete.json b/specification/_json_spec/inference.delete.json index 057aed6cd6..bb9f8e9405 100644 --- a/specification/_json_spec/inference.delete.json +++ b/specification/_json_spec/inference.delete.json @@ -40,10 +40,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/specification/_json_spec/inference.inference.json b/specification/_json_spec/inference.inference.json index 1ada118f0e..c3091a90c5 100644 --- a/specification/_json_spec/inference.inference.json +++ b/specification/_json_spec/inference.inference.json @@ -39,7 +39,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.put.json b/specification/_json_spec/inference.put.json index 4416edabfe..0c7b0c8180 100644 --- a/specification/_json_spec/inference.put.json +++ b/specification/_json_spec/inference.put.json @@ -39,7 +39,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_ai21.json b/specification/_json_spec/inference.put_ai21.json index 7e7f757975..eb3bdcc85b 100644 --- a/specification/_json_spec/inference.put_ai21.json +++ b/specification/_json_spec/inference.put_ai21.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_alibabacloud.json b/specification/_json_spec/inference.put_alibabacloud.json index 2640f47b3c..9bcd55823a 100644 --- a/specification/_json_spec/inference.put_alibabacloud.json +++ b/specification/_json_spec/inference.put_alibabacloud.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_amazonbedrock.json b/specification/_json_spec/inference.put_amazonbedrock.json index c313ccba1e..4bfe9c25d1 100644 --- a/specification/_json_spec/inference.put_amazonbedrock.json +++ b/specification/_json_spec/inference.put_amazonbedrock.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_amazonsagemaker.json b/specification/_json_spec/inference.put_amazonsagemaker.json index 415c230f3e..c310b2733c 100644 --- a/specification/_json_spec/inference.put_amazonsagemaker.json +++ b/specification/_json_spec/inference.put_amazonsagemaker.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_anthropic.json b/specification/_json_spec/inference.put_anthropic.json index 6f022c9489..36b1e7155d 100644 --- a/specification/_json_spec/inference.put_anthropic.json +++ b/specification/_json_spec/inference.put_anthropic.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_azureaistudio.json b/specification/_json_spec/inference.put_azureaistudio.json index e0b2ebb496..0ea47bedf6 100644 --- a/specification/_json_spec/inference.put_azureaistudio.json +++ b/specification/_json_spec/inference.put_azureaistudio.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_azureopenai.json b/specification/_json_spec/inference.put_azureopenai.json index c2d02e513c..6ad290a351 100644 --- a/specification/_json_spec/inference.put_azureopenai.json +++ b/specification/_json_spec/inference.put_azureopenai.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_cohere.json b/specification/_json_spec/inference.put_cohere.json index 153bf2b787..4165723a84 100644 --- a/specification/_json_spec/inference.put_cohere.json +++ b/specification/_json_spec/inference.put_cohere.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_contextualai.json b/specification/_json_spec/inference.put_contextualai.json index 983ce42738..fe58b762db 100644 --- a/specification/_json_spec/inference.put_contextualai.json +++ b/specification/_json_spec/inference.put_contextualai.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_custom.json b/specification/_json_spec/inference.put_custom.json index d14089cf12..e39884796a 100644 --- a/specification/_json_spec/inference.put_custom.json +++ b/specification/_json_spec/inference.put_custom.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_deepseek.json b/specification/_json_spec/inference.put_deepseek.json index 96da2c9312..675dff0cca 100644 --- a/specification/_json_spec/inference.put_deepseek.json +++ b/specification/_json_spec/inference.put_deepseek.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_elasticsearch.json b/specification/_json_spec/inference.put_elasticsearch.json index adae4e6883..5c9e37858c 100644 --- a/specification/_json_spec/inference.put_elasticsearch.json +++ b/specification/_json_spec/inference.put_elasticsearch.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_elser.json b/specification/_json_spec/inference.put_elser.json index 6697278a44..d4c912f2ba 100644 --- a/specification/_json_spec/inference.put_elser.json +++ b/specification/_json_spec/inference.put_elser.json @@ -33,7 +33,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_googleaistudio.json b/specification/_json_spec/inference.put_googleaistudio.json index dce5d98c16..279ff013b5 100644 --- a/specification/_json_spec/inference.put_googleaistudio.json +++ b/specification/_json_spec/inference.put_googleaistudio.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_googlevertexai.json b/specification/_json_spec/inference.put_googlevertexai.json index 6dd400f4d1..264e8d89a8 100644 --- a/specification/_json_spec/inference.put_googlevertexai.json +++ b/specification/_json_spec/inference.put_googlevertexai.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_hugging_face.json b/specification/_json_spec/inference.put_hugging_face.json index c0fa9aa65a..b22c98b329 100644 --- a/specification/_json_spec/inference.put_hugging_face.json +++ b/specification/_json_spec/inference.put_hugging_face.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_jinaai.json b/specification/_json_spec/inference.put_jinaai.json index 5d4e8e2719..5b54c3d5ba 100644 --- a/specification/_json_spec/inference.put_jinaai.json +++ b/specification/_json_spec/inference.put_jinaai.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_llama.json b/specification/_json_spec/inference.put_llama.json index b03aabed90..690df60098 100644 --- a/specification/_json_spec/inference.put_llama.json +++ b/specification/_json_spec/inference.put_llama.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_mistral.json b/specification/_json_spec/inference.put_mistral.json index 2738bf4a90..0596d6bc03 100644 --- a/specification/_json_spec/inference.put_mistral.json +++ b/specification/_json_spec/inference.put_mistral.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_openai.json b/specification/_json_spec/inference.put_openai.json index 85f14dd206..3861f82710 100644 --- a/specification/_json_spec/inference.put_openai.json +++ b/specification/_json_spec/inference.put_openai.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_voyageai.json b/specification/_json_spec/inference.put_voyageai.json index 5abef56d73..d556fa8d7d 100644 --- a/specification/_json_spec/inference.put_voyageai.json +++ b/specification/_json_spec/inference.put_voyageai.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_watsonx.json b/specification/_json_spec/inference.put_watsonx.json index 80f9a01ae8..9e70688706 100644 --- a/specification/_json_spec/inference.put_watsonx.json +++ b/specification/_json_spec/inference.put_watsonx.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.rerank.json b/specification/_json_spec/inference.rerank.json index d8b4473538..b5d09ca773 100644 --- a/specification/_json_spec/inference.rerank.json +++ b/specification/_json_spec/inference.rerank.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.sparse_embedding.json b/specification/_json_spec/inference.sparse_embedding.json index 379fa34706..c7e1d526df 100644 --- a/specification/_json_spec/inference.sparse_embedding.json +++ b/specification/_json_spec/inference.sparse_embedding.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.stream_completion.json b/specification/_json_spec/inference.stream_completion.json index 2e0e61b89a..5771390829 100644 --- a/specification/_json_spec/inference.stream_completion.json +++ b/specification/_json_spec/inference.stream_completion.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.text_embedding.json b/specification/_json_spec/inference.text_embedding.json index c066e12f58..5f4c4d8e5f 100644 --- a/specification/_json_spec/inference.text_embedding.json +++ b/specification/_json_spec/inference.text_embedding.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.update.json b/specification/_json_spec/inference.update.json index 2772c50e89..be8280491e 100644 --- a/specification/_json_spec/inference.update.json +++ b/specification/_json_spec/inference.update.json @@ -39,7 +39,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/ingest.delete_geoip_database.json b/specification/_json_spec/ingest.delete_geoip_database.json index 87dc0d0003..de18d8dd5b 100644 --- a/specification/_json_spec/ingest.delete_geoip_database.json +++ b/specification/_json_spec/ingest.delete_geoip_database.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ingest.delete_ip_location_database.json b/specification/_json_spec/ingest.delete_ip_location_database.json index 11bf93abe3..61b7d2cc16 100644 --- a/specification/_json_spec/ingest.delete_ip_location_database.json +++ b/specification/_json_spec/ingest.delete_ip_location_database.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ingest.delete_pipeline.json b/specification/_json_spec/ingest.delete_pipeline.json index f057bbe673..0f9a3e99bb 100644 --- a/specification/_json_spec/ingest.delete_pipeline.json +++ b/specification/_json_spec/ingest.delete_pipeline.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ingest.get_pipeline.json b/specification/_json_spec/ingest.get_pipeline.json index c767ea891a..52867860c2 100644 --- a/specification/_json_spec/ingest.get_pipeline.json +++ b/specification/_json_spec/ingest.get_pipeline.json @@ -30,6 +30,7 @@ "params": { "summary": { "type": "boolean", + "default": false, "description": "Return pipelines without their definitions (default: false)" }, "master_timeout": { diff --git a/specification/_json_spec/ingest.put_geoip_database.json b/specification/_json_spec/ingest.put_geoip_database.json index c11993f5fd..62a3d322f7 100644 --- a/specification/_json_spec/ingest.put_geoip_database.json +++ b/specification/_json_spec/ingest.put_geoip_database.json @@ -32,6 +32,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/ingest.put_ip_location_database.json b/specification/_json_spec/ingest.put_ip_location_database.json index 185af68287..dde223dcac 100644 --- a/specification/_json_spec/ingest.put_ip_location_database.json +++ b/specification/_json_spec/ingest.put_ip_location_database.json @@ -32,6 +32,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/ingest.put_pipeline.json b/specification/_json_spec/ingest.put_pipeline.json index 8135a60fe2..ef9143971b 100644 --- a/specification/_json_spec/ingest.put_pipeline.json +++ b/specification/_json_spec/ingest.put_pipeline.json @@ -36,6 +36,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/knn_search.json b/specification/_json_spec/knn_search.json index f0278c8907..7c2cb30773 100644 --- a/specification/_json_spec/knn_search.json +++ b/specification/_json_spec/knn_search.json @@ -35,7 +35,8 @@ } }, "body": { - "description": "The search definition" + "description": "The search definition", + "required": true } } } diff --git a/specification/_json_spec/license.delete.json b/specification/_json_spec/license.delete.json index 430837870c..71d2804016 100644 --- a/specification/_json_spec/license.delete.json +++ b/specification/_json_spec/license.delete.json @@ -25,6 +25,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/specification/_json_spec/license.get.json b/specification/_json_spec/license.get.json index ef61a7e4cd..b34d5548ed 100644 --- a/specification/_json_spec/license.get.json +++ b/specification/_json_spec/license.get.json @@ -20,12 +20,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/specification/_json_spec/license.post.json b/specification/_json_spec/license.post.json index 419f012163..9f98571e92 100644 --- a/specification/_json_spec/license.post.json +++ b/specification/_json_spec/license.post.json @@ -21,6 +21,7 @@ "params": { "acknowledge": { "type": "boolean", + "default": false, "description": "whether the user has acknowledged acknowledge messages (default: false)" }, "master_timeout": { @@ -30,11 +31,13 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } }, "body": { - "description": "licenses to be installed" + "description": "licenses to be installed", + "required": false } } } diff --git a/specification/_json_spec/license.post_start_basic.json b/specification/_json_spec/license.post_start_basic.json index 39a22f5e6b..6e7bc37e01 100644 --- a/specification/_json_spec/license.post_start_basic.json +++ b/specification/_json_spec/license.post_start_basic.json @@ -29,6 +29,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/specification/_json_spec/mget.json b/specification/_json_spec/mget.json index e1015e1065..d7dd2b0e9a 100644 --- a/specification/_json_spec/mget.json +++ b/specification/_json_spec/mget.json @@ -37,6 +37,7 @@ }, "stored_fields": { "type": "list", + "default": "false", "description": "A comma-separated list of stored fields to return in the response" }, "preference": { @@ -45,10 +46,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/specification/_json_spec/ml.close_job.json b/specification/_json_spec/ml.close_job.json index 9bb6332b7c..821b1e54e1 100644 --- a/specification/_json_spec/ml.close_job.json +++ b/specification/_json_spec/ml.close_job.json @@ -27,14 +27,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/specification/_json_spec/ml.delete_data_frame_analytics.json b/specification/_json_spec/ml.delete_data_frame_analytics.json index 43120968b9..af205b1065 100644 --- a/specification/_json_spec/ml.delete_data_frame_analytics.json +++ b/specification/_json_spec/ml.delete_data_frame_analytics.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Controls the time to wait until a job is deleted. Defaults to 1 minute" } } diff --git a/specification/_json_spec/ml.delete_expired_data.json b/specification/_json_spec/ml.delete_expired_data.json index adafb23f16..14f9893849 100644 --- a/specification/_json_spec/ml.delete_expired_data.json +++ b/specification/_json_spec/ml.delete_expired_data.json @@ -35,11 +35,13 @@ }, "timeout": { "type": "time", + "default": "8h", "description": "How long can the underlying delete processes run until they are canceled" } }, "body": { - "description": "deleting expired data parameters" + "description": "deleting expired data parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.delete_forecast.json b/specification/_json_spec/ml.delete_forecast.json index 820b370c27..4f4d03e7f7 100644 --- a/specification/_json_spec/ml.delete_forecast.json +++ b/specification/_json_spec/ml.delete_forecast.json @@ -40,10 +40,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/specification/_json_spec/ml.flush_job.json b/specification/_json_spec/ml.flush_job.json index 60d8c81fa1..61be07dd82 100644 --- a/specification/_json_spec/ml.flush_job.json +++ b/specification/_json_spec/ml.flush_job.json @@ -47,7 +47,8 @@ } }, "body": { - "description": "Flush parameters" + "description": "Flush parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.forecast.json b/specification/_json_spec/ml.forecast.json index ab562e094e..dc99c2956a 100644 --- a/specification/_json_spec/ml.forecast.json +++ b/specification/_json_spec/ml.forecast.json @@ -27,14 +27,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/specification/_json_spec/ml.get_buckets.json b/specification/_json_spec/ml.get_buckets.json index 54a35823c1..68e4655b41 100644 --- a/specification/_json_spec/ml.get_buckets.json +++ b/specification/_json_spec/ml.get_buckets.json @@ -41,43 +41,53 @@ "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" } }, "body": { - "description": "Bucket selection details if not provided in URI" + "description": "Bucket selection details if not provided in URI", + "required": false } } } diff --git a/specification/_json_spec/ml.get_calendar_events.json b/specification/_json_spec/ml.get_calendar_events.json index e51e68d117..2757b7653d 100644 --- a/specification/_json_spec/ml.get_calendar_events.json +++ b/specification/_json_spec/ml.get_calendar_events.json @@ -38,10 +38,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/specification/_json_spec/ml.get_calendars.json b/specification/_json_spec/ml.get_calendars.json index c011b1b8ee..50afc723b0 100644 --- a/specification/_json_spec/ml.get_calendars.json +++ b/specification/_json_spec/ml.get_calendars.json @@ -31,15 +31,18 @@ "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" } }, "body": { - "description": "The from and size parameters optionally sent in the body" + "description": "The from and size parameters optionally sent in the body", + "required": false } } } diff --git a/specification/_json_spec/ml.get_categories.json b/specification/_json_spec/ml.get_categories.json index cb3b9acb81..169f133a40 100644 --- a/specification/_json_spec/ml.get_categories.json +++ b/specification/_json_spec/ml.get_categories.json @@ -41,10 +41,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": { @@ -53,7 +55,8 @@ } }, "body": { - "description": "Category selection details if not provided in URI" + "description": "Category selection details if not provided in URI", + "required": false } } } diff --git a/specification/_json_spec/ml.get_filters.json b/specification/_json_spec/ml.get_filters.json index e3656211e8..089026f476 100644 --- a/specification/_json_spec/ml.get_filters.json +++ b/specification/_json_spec/ml.get_filters.json @@ -30,10 +30,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/specification/_json_spec/ml.get_influencers.json b/specification/_json_spec/ml.get_influencers.json index b3b2cb53d5..d794aae6d9 100644 --- a/specification/_json_spec/ml.get_influencers.json +++ b/specification/_json_spec/ml.get_influencers.json @@ -27,26 +27,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": { @@ -55,11 +61,13 @@ }, "desc": { "type": "boolean", + "default": false, "description": "whether the results should be sorted in decending order" } }, "body": { - "description": "Influencer selection criteria" + "description": "Influencer selection criteria", + "required": false } } } diff --git a/specification/_json_spec/ml.get_job_stats.json b/specification/_json_spec/ml.get_job_stats.json index f45d9cb9f7..22c6f04db8 100644 --- a/specification/_json_spec/ml.get_job_stats.json +++ b/specification/_json_spec/ml.get_job_stats.json @@ -30,6 +30,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/specification/_json_spec/ml.get_jobs.json b/specification/_json_spec/ml.get_jobs.json index 2ad5df0f9b..0b2528684a 100644 --- a/specification/_json_spec/ml.get_jobs.json +++ b/specification/_json_spec/ml.get_jobs.json @@ -30,6 +30,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/specification/_json_spec/ml.get_memory_stats.json b/specification/_json_spec/ml.get_memory_stats.json index 08e88e89ac..835d9a9bf3 100644 --- a/specification/_json_spec/ml.get_memory_stats.json +++ b/specification/_json_spec/ml.get_memory_stats.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ml.get_model_snapshots.json b/specification/_json_spec/ml.get_model_snapshots.json index d3677709e2..be83c8ce84 100644 --- a/specification/_json_spec/ml.get_model_snapshots.json +++ b/specification/_json_spec/ml.get_model_snapshots.json @@ -41,10 +41,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": { @@ -61,11 +63,13 @@ }, "desc": { "type": "boolean", + "default": false, "description": "True if the results should be sorted in descending order" } }, "body": { - "description": "Model snapshot selection criteria" + "description": "Model snapshot selection criteria", + "required": false } } } diff --git a/specification/_json_spec/ml.get_overall_buckets.json b/specification/_json_spec/ml.get_overall_buckets.json index e427ae2bde..79917afa60 100644 --- a/specification/_json_spec/ml.get_overall_buckets.json +++ b/specification/_json_spec/ml.get_overall_buckets.json @@ -27,6 +27,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": { @@ -39,6 +40,7 @@ }, "exclude_interim": { "type": "boolean", + "default": false, "description": "If true overall buckets that include interim buckets will be excluded" }, "start": { @@ -51,11 +53,13 @@ }, "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)" } }, "body": { - "description": "Overall bucket selection details if not provided in URI" + "description": "Overall bucket selection details if not provided in URI", + "required": false } } } diff --git a/specification/_json_spec/ml.get_records.json b/specification/_json_spec/ml.get_records.json index cb083c6375..9d4dde88ef 100644 --- a/specification/_json_spec/ml.get_records.json +++ b/specification/_json_spec/ml.get_records.json @@ -27,39 +27,48 @@ "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" } }, "body": { - "description": "Record selection criteria" + "description": "Record selection criteria", + "required": false } } } diff --git a/specification/_json_spec/ml.put_datafeed.json b/specification/_json_spec/ml.put_datafeed.json index 4e9a600653..3446c9bf33 100644 --- a/specification/_json_spec/ml.put_datafeed.json +++ b/specification/_json_spec/ml.put_datafeed.json @@ -31,19 +31,23 @@ "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": { "type": "enum", "options": ["open", "closed", "hidden", "none", "all"], + "default": "open", "description": "Whether source index expressions should get expanded to open or closed indices (default: open)" } } diff --git a/specification/_json_spec/ml.put_job.json b/specification/_json_spec/ml.put_job.json index 0d91668ed1..a8754e6fc4 100644 --- a/specification/_json_spec/ml.put_job.json +++ b/specification/_json_spec/ml.put_job.json @@ -27,19 +27,23 @@ "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": { "type": "enum", "options": ["open", "closed", "hidden", "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/specification/_json_spec/ml.put_trained_model_alias.json b/specification/_json_spec/ml.put_trained_model_alias.json index d27748fbf1..dfeb1324aa 100644 --- a/specification/_json_spec/ml.put_trained_model_alias.json +++ b/specification/_json_spec/ml.put_trained_model_alias.json @@ -31,6 +31,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/specification/_json_spec/ml.revert_model_snapshot.json b/specification/_json_spec/ml.revert_model_snapshot.json index dc4ebbd221..9c3f75d54d 100644 --- a/specification/_json_spec/ml.revert_model_snapshot.json +++ b/specification/_json_spec/ml.revert_model_snapshot.json @@ -31,11 +31,13 @@ "params": { "delete_intervening_results": { "type": "boolean", + "default": false, "description": "Should we reset the results back to the time of the snapshot?" } }, "body": { - "description": "Reversion options" + "description": "Reversion options", + "required": false } } } diff --git a/specification/_json_spec/ml.set_upgrade_mode.json b/specification/_json_spec/ml.set_upgrade_mode.json index c61f944be0..f6a57b744a 100644 --- a/specification/_json_spec/ml.set_upgrade_mode.json +++ b/specification/_json_spec/ml.set_upgrade_mode.json @@ -20,10 +20,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/specification/_json_spec/ml.start_data_frame_analytics.json b/specification/_json_spec/ml.start_data_frame_analytics.json index 51691d753d..5f9b4a3fcf 100644 --- a/specification/_json_spec/ml.start_data_frame_analytics.json +++ b/specification/_json_spec/ml.start_data_frame_analytics.json @@ -27,11 +27,13 @@ "params": { "timeout": { "type": "time", + "default": "20s", "description": "Controls the time to wait until the task has started. Defaults to 20 seconds" } }, "body": { - "description": "The start data frame analytics parameters" + "description": "The start data frame analytics parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.start_datafeed.json b/specification/_json_spec/ml.start_datafeed.json index 4d0b07ddf2..0dc8a49343 100644 --- a/specification/_json_spec/ml.start_datafeed.json +++ b/specification/_json_spec/ml.start_datafeed.json @@ -35,11 +35,13 @@ }, "timeout": { "type": "time", + "default": "20s", "description": "Controls the time to wait until a datafeed has started. Default to 20 seconds" } }, "body": { - "description": "The start datafeed parameters" + "description": "The start datafeed parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.stop_data_frame_analytics.json b/specification/_json_spec/ml.stop_data_frame_analytics.json index 21d470ec10..4f8a60218e 100644 --- a/specification/_json_spec/ml.stop_data_frame_analytics.json +++ b/specification/_json_spec/ml.stop_data_frame_analytics.json @@ -27,19 +27,23 @@ "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" } }, "body": { - "description": "The stop data frame analytics parameters" + "description": "The stop data frame analytics parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.stop_datafeed.json b/specification/_json_spec/ml.stop_datafeed.json index 80dca45888..372ecb47a4 100644 --- a/specification/_json_spec/ml.stop_datafeed.json +++ b/specification/_json_spec/ml.stop_datafeed.json @@ -27,14 +27,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/specification/_json_spec/ml.stop_trained_model_deployment.json b/specification/_json_spec/ml.stop_trained_model_deployment.json index ecc6dc1628..2b0dffcfd1 100644 --- a/specification/_json_spec/ml.stop_trained_model_deployment.json +++ b/specification/_json_spec/ml.stop_trained_model_deployment.json @@ -28,15 +28,18 @@ "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" } }, "body": { - "description": "The stop deployment parameters" + "description": "The stop deployment parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.update_datafeed.json b/specification/_json_spec/ml.update_datafeed.json index 9cb9af0287..35bb5ebd3f 100644 --- a/specification/_json_spec/ml.update_datafeed.json +++ b/specification/_json_spec/ml.update_datafeed.json @@ -31,19 +31,23 @@ "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": { "type": "enum", "options": ["open", "closed", "hidden", "none", "all"], + "default": "open", "description": "Whether source index expressions should get expanded to open or closed indices (default: open)" } } diff --git a/specification/_json_spec/ml.update_trained_model_deployment.json b/specification/_json_spec/ml.update_trained_model_deployment.json index 94476779a1..ddc41f2c77 100644 --- a/specification/_json_spec/ml.update_trained_model_deployment.json +++ b/specification/_json_spec/ml.update_trained_model_deployment.json @@ -27,6 +27,7 @@ "params": { "number_of_allocations": { "type": "int", + "default": 1, "description": "Update the model deployment to this number of allocations." } }, diff --git a/specification/_json_spec/ml.upgrade_job_snapshot.json b/specification/_json_spec/ml.upgrade_job_snapshot.json index afc1b3a1e1..141af75e3d 100644 --- a/specification/_json_spec/ml.upgrade_job_snapshot.json +++ b/specification/_json_spec/ml.upgrade_job_snapshot.json @@ -30,10 +30,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/specification/_json_spec/msearch.json b/specification/_json_spec/msearch.json index 4c96ce0476..a18360b843 100644 --- a/specification/_json_spec/msearch.json +++ b/specification/_json_spec/msearch.json @@ -35,7 +35,7 @@ "description": "Search operation type" }, "max_concurrent_searches": { - "type": "number", + "type": "int", "description": "Controls the maximum number of concurrent searches the multi search api will execute" }, "typed_keys": { @@ -43,11 +43,11 @@ "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response" }, "pre_filter_shard_size": { - "type": "number", + "type": "long", "description": "A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint." }, "max_concurrent_shard_requests": { - "type": "number", + "type": "int", "description": "The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", "default": 5 }, @@ -59,7 +59,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", @@ -67,12 +67,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/specification/_json_spec/msearch_template.json b/specification/_json_spec/msearch_template.json index bfe6cd4a3d..18133d29b3 100644 --- a/specification/_json_spec/msearch_template.json +++ b/specification/_json_spec/msearch_template.json @@ -36,10 +36,11 @@ }, "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": { - "type": "number", + "type": "long", "description": "Controls the maximum number of concurrent searches the multi search api will execute" }, "rest_total_hits_as_int": { @@ -50,7 +51,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 }, "project_routing": { "type": "string", diff --git a/specification/_json_spec/mtermvectors.json b/specification/_json_spec/mtermvectors.json index 71dd82501e..cd0654c3b4 100644 --- a/specification/_json_spec/mtermvectors.json +++ b/specification/_json_spec/mtermvectors.json @@ -72,10 +72,11 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specifies if requests are real-time as opposed to near-real-time (default: true)." }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/nodes.hot_threads.json b/specification/_json_spec/nodes.hot_threads.json index bdeb980094..f998d43e79 100644 --- a/specification/_json_spec/nodes.hot_threads.json +++ b/specification/_json_spec/nodes.hot_threads.json @@ -30,23 +30,28 @@ "params": { "interval": { "type": "time", + "default": "500ms", "description": "The interval for the second sampling of threads" }, "snapshots": { - "type": "number", + "type": "long", + "default": 10, "description": "Number of samples of thread stacktrace (default: 10)" }, "threads": { - "type": "number", + "type": "long", + "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": { "type": "enum", "options": ["cpu", "wait", "block", "mem"], + "default": "cpu", "description": "The type to sample (default: cpu)" }, "sort": { @@ -56,6 +61,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/nodes.info.json b/specification/_json_spec/nodes.info.json index fcad9d29bf..5ddcbe79a5 100644 --- a/specification/_json_spec/nodes.info.json +++ b/specification/_json_spec/nodes.info.json @@ -82,10 +82,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/specification/_json_spec/nodes.reload_secure_settings.json b/specification/_json_spec/nodes.reload_secure_settings.json index 75701aaed7..9c11e4cd43 100644 --- a/specification/_json_spec/nodes.reload_secure_settings.json +++ b/specification/_json_spec/nodes.reload_secure_settings.json @@ -31,6 +31,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/nodes.stats.json b/specification/_json_spec/nodes.stats.json index c100f4f3f4..25367ca8c9 100644 --- a/specification/_json_spec/nodes.stats.json +++ b/specification/_json_spec/nodes.stats.json @@ -208,6 +208,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "include_segment_file_sizes": { diff --git a/specification/_json_spec/nodes.usage.json b/specification/_json_spec/nodes.usage.json index 670a120e9c..f749aab32a 100644 --- a/specification/_json_spec/nodes.usage.json +++ b/specification/_json_spec/nodes.usage.json @@ -56,6 +56,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/open_point_in_time.json b/specification/_json_spec/open_point_in_time.json index 144355dfbd..a3b93615a9 100644 --- a/specification/_json_spec/open_point_in_time.json +++ b/specification/_json_spec/open_point_in_time.json @@ -35,6 +35,7 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "expand_wildcards": { @@ -50,10 +51,11 @@ }, "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": { - "type": "number", + "type": "int", "description": "The number of concurrent shard requests per node executed concurrently when opening this point-in-time. This value should be used to limit the impact of opening the point-in-time on the cluster", "default": 5 }, @@ -63,7 +65,8 @@ } }, "body": { - "description": "An index_filter specified with the Query DSL" + "description": "An index_filter specified with the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/project.tags.json b/specification/_json_spec/project.tags.json index 290c755903..5647ab285a 100644 --- a/specification/_json_spec/project.tags.json +++ b/specification/_json_spec/project.tags.json @@ -1,7 +1,7 @@ { "project.tags": { "documentation": { - "url": "", + "url": null, "description": "Return tags defined for the project" }, "stability": "experimental", diff --git a/specification/_json_spec/put_script.json b/specification/_json_spec/put_script.json index ecc7feadba..469a4d809b 100644 --- a/specification/_json_spec/put_script.json +++ b/specification/_json_spec/put_script.json @@ -41,6 +41,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/specification/_json_spec/rank_eval.json b/specification/_json_spec/rank_eval.json index 13ea43fa97..56c912f562 100644 --- a/specification/_json_spec/rank_eval.json +++ b/specification/_json_spec/rank_eval.json @@ -31,10 +31,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/specification/_json_spec/reindex.json b/specification/_json_spec/reindex.json index 678ba92bf9..655002dc37 100644 --- a/specification/_json_spec/reindex.json +++ b/specification/_json_spec/reindex.json @@ -21,6 +21,7 @@ "params": { "refresh": { "type": "boolean", + "default": false, "description": "Should the affected indexes be refreshed?" }, "timeout": { @@ -30,6 +31,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": { @@ -39,7 +41,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": { @@ -53,7 +55,7 @@ "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`." }, "max_docs": { - "type": "number", + "type": "int", "description": "Maximum number of documents to process (default: all documents)" }, "require_alias": { diff --git a/specification/_json_spec/render_search_template.json b/specification/_json_spec/render_search_template.json index 575727bc04..6db006051e 100644 --- a/specification/_json_spec/render_search_template.json +++ b/specification/_json_spec/render_search_template.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The search definition template and its params" + "description": "The search definition template and its params", + "required": true } } } diff --git a/specification/_json_spec/rollup.stop_job.json b/specification/_json_spec/rollup.stop_job.json index c414699da5..6ac3e019b3 100644 --- a/specification/_json_spec/rollup.stop_job.json +++ b/specification/_json_spec/rollup.stop_job.json @@ -26,10 +26,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/specification/_json_spec/scripts_painless_execute.json b/specification/_json_spec/scripts_painless_execute.json index e5afbbea00..f096b50fb1 100644 --- a/specification/_json_spec/scripts_painless_execute.json +++ b/specification/_json_spec/scripts_painless_execute.json @@ -20,7 +20,8 @@ }, "params": {}, "body": { - "description": "The script to execute" + "description": "The script to execute", + "required": true } } } diff --git a/specification/_json_spec/scroll.json b/specification/_json_spec/scroll.json index 437a4be460..177901e371 100644 --- a/specification/_json_spec/scroll.json +++ b/specification/_json_spec/scroll.json @@ -36,6 +36,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": { @@ -49,7 +50,8 @@ } }, "body": { - "description": "The scroll ID if not passed by URL or query parameter." + "description": "The scroll ID if not passed by URL or query parameter.", + "required": false } } } diff --git a/specification/_json_spec/search.json b/specification/_json_spec/search.json index 662a6e7452..89985d7dd3 100644 --- a/specification/_json_spec/search.json +++ b/specification/_json_spec/search.json @@ -35,17 +35,18 @@ }, "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", - "options": ["AND", "OR"], - "default": "OR", + "options": ["and", "or"], + "default": "or", "description": "The default operator for query string query (AND or OR)" }, "df": { @@ -54,6 +55,7 @@ }, "explain": { "type": "boolean", + "default": false, "description": "Specify whether to return detailed information about score computation as part of a hit" }, "stored_fields": { @@ -65,7 +67,8 @@ "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit" }, "from": { - "type": "number", + "type": "int", + "default": 0, "description": "Starting offset (default: 0)" }, "force_synthetic_source": { @@ -76,14 +79,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": { @@ -94,6 +100,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": { @@ -122,7 +129,8 @@ "description": "Search operation type" }, "size": { - "type": "number", + "type": "int", + "default": 10, "description": "Number of hits to return (default: 10)" }, "sort": { @@ -131,6 +139,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": { @@ -143,10 +152,12 @@ }, "_source_exclude_vectors": { "type": "boolean", + "default": false, "description": "Whether vectors should be excluded from _source" }, "terminate_after": { - "type": "number", + "type": "long", + "default": 0, "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early." }, "stats": { @@ -164,7 +175,7 @@ "description": "Specify suggest mode" }, "suggest_size": { - "type": "number", + "type": "long", "description": "How many suggestions to return in response" }, "suggest_text": { @@ -177,10 +188,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": { @@ -190,10 +203,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": { @@ -205,17 +220,17 @@ "description": "Specify if request cache should be used for this request or not, defaults to index level setting" }, "batched_reduce_size": { - "type": "number", + "type": "long", "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", "default": 512 }, "max_concurrent_shard_requests": { - "type": "number", + "type": "int", "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", "default": 5 }, "pre_filter_shard_size": { - "type": "number", + "type": "long", "description": "A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint." }, "rest_total_hits_as_int": { @@ -230,7 +245,8 @@ } }, "body": { - "description": "The search definition using the Query DSL" + "description": "The search definition using the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/search_application.list.json b/specification/_json_spec/search_application.list.json index e78624c9a3..69a89807fc 100644 --- a/specification/_json_spec/search_application.list.json +++ b/specification/_json_spec/search_application.list.json @@ -24,6 +24,7 @@ }, "from": { "type": "int", + "default": 0, "description": "Starting offset (default: 0)" }, "size": { diff --git a/specification/_json_spec/search_application.put.json b/specification/_json_spec/search_application.put.json index 4c30fc45ad..88eae1747e 100644 --- a/specification/_json_spec/search_application.put.json +++ b/specification/_json_spec/search_application.put.json @@ -27,6 +27,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/specification/_json_spec/search_mvt.json b/specification/_json_spec/search_mvt.json index 6e84738fa2..8703762ba1 100644 --- a/specification/_json_spec/search_mvt.json +++ b/specification/_json_spec/search_mvt.json @@ -79,6 +79,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/specification/_json_spec/search_shards.json b/specification/_json_spec/search_shards.json index d6ff71c665..5ad4ed3b5d 100644 --- a/specification/_json_spec/search_shards.json +++ b/specification/_json_spec/search_shards.json @@ -38,14 +38,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/specification/_json_spec/search_template.json b/specification/_json_spec/search_template.json index 496fe7c9e9..6730e75548 100644 --- a/specification/_json_spec/search_template.json +++ b/specification/_json_spec/search_template.json @@ -31,14 +31,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": { @@ -66,14 +69,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": { @@ -84,7 +90,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 }, "project_routing": { "type": "string", diff --git a/specification/_json_spec/searchable_snapshots.clear_cache.json b/specification/_json_spec/searchable_snapshots.clear_cache.json index 41ecbb2844..6c644a27cf 100644 --- a/specification/_json_spec/searchable_snapshots.clear_cache.json +++ b/specification/_json_spec/searchable_snapshots.clear_cache.json @@ -38,7 +38,7 @@ }, "expand_wildcards": { "type": "enum", - "options": ["open", "closed", "none", "all"], + "options": ["open", "closed", "hidden", "none", "all"], "default": "open", "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both." } diff --git a/specification/_json_spec/searchable_snapshots.mount.json b/specification/_json_spec/searchable_snapshots.mount.json index 64fb277781..1a0aca4bd1 100644 --- a/specification/_json_spec/searchable_snapshots.mount.json +++ b/specification/_json_spec/searchable_snapshots.mount.json @@ -42,7 +42,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/specification/_json_spec/security.disable_user_profile.json b/specification/_json_spec/security.disable_user_profile.json index af02229f7c..58656de37d 100644 --- a/specification/_json_spec/security.disable_user_profile.json +++ b/specification/_json_spec/security.disable_user_profile.json @@ -27,6 +27,7 @@ "refresh": { "type": "enum", "options": ["true", "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/specification/_json_spec/security.enable_user_profile.json b/specification/_json_spec/security.enable_user_profile.json index 057c770a84..0017748d32 100644 --- a/specification/_json_spec/security.enable_user_profile.json +++ b/specification/_json_spec/security.enable_user_profile.json @@ -27,6 +27,7 @@ "refresh": { "type": "enum", "options": ["true", "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/specification/_json_spec/security.grant_api_key.json b/specification/_json_spec/security.grant_api_key.json index b8f06f8a01..158dacaeab 100644 --- a/specification/_json_spec/security.grant_api_key.json +++ b/specification/_json_spec/security.grant_api_key.json @@ -22,6 +22,7 @@ "refresh": { "type": "enum", "options": ["true", "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/specification/_json_spec/security.put_user.json b/specification/_json_spec/security.put_user.json index 5a7107e64f..b3151c36e8 100644 --- a/specification/_json_spec/security.put_user.json +++ b/specification/_json_spec/security.put_user.json @@ -28,6 +28,7 @@ "refresh": { "type": "enum", "options": ["true", "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/specification/_json_spec/security.update_user_profile_data.json b/specification/_json_spec/security.update_user_profile_data.json index 0395beec9d..398c9c6605 100644 --- a/specification/_json_spec/security.update_user_profile_data.json +++ b/specification/_json_spec/security.update_user_profile_data.json @@ -26,16 +26,17 @@ }, "params": { "if_seq_no": { - "type": "number", + "type": "long", "description": "only perform the update operation if the last operation that has changed the document has the specified sequence number" }, "if_primary_term": { - "type": "number", + "type": "long", "description": "only perform the update operation if the last operation that has changed the document has the specified primary term" }, "refresh": { "type": "enum", "options": ["true", "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/specification/_json_spec/shutdown.delete_node.json b/specification/_json_spec/shutdown.delete_node.json index 2a562165e5..bba125b182 100644 --- a/specification/_json_spec/shutdown.delete_node.json +++ b/specification/_json_spec/shutdown.delete_node.json @@ -32,6 +32,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/shutdown.put_node.json b/specification/_json_spec/shutdown.put_node.json index 9252c446e2..78292e3c78 100644 --- a/specification/_json_spec/shutdown.put_node.json +++ b/specification/_json_spec/shutdown.put_node.json @@ -32,6 +32,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/slm.delete_lifecycle.json b/specification/_json_spec/slm.delete_lifecycle.json index ccaf6221b3..5766645ba4 100644 --- a/specification/_json_spec/slm.delete_lifecycle.json +++ b/specification/_json_spec/slm.delete_lifecycle.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.execute_lifecycle.json b/specification/_json_spec/slm.execute_lifecycle.json index 9cfb1ae961..4c97208c15 100644 --- a/specification/_json_spec/slm.execute_lifecycle.json +++ b/specification/_json_spec/slm.execute_lifecycle.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.execute_retention.json b/specification/_json_spec/slm.execute_retention.json index 8221c7a197..5acc3f5b32 100644 --- a/specification/_json_spec/slm.execute_retention.json +++ b/specification/_json_spec/slm.execute_retention.json @@ -25,6 +25,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.get_lifecycle.json b/specification/_json_spec/slm.get_lifecycle.json index bab5b713a4..f2218aa357 100644 --- a/specification/_json_spec/slm.get_lifecycle.json +++ b/specification/_json_spec/slm.get_lifecycle.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.get_stats.json b/specification/_json_spec/slm.get_stats.json index 6a34108b6d..9cd90507da 100644 --- a/specification/_json_spec/slm.get_stats.json +++ b/specification/_json_spec/slm.get_stats.json @@ -25,6 +25,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.get_status.json b/specification/_json_spec/slm.get_status.json index daf47b45c4..d1f6958400 100644 --- a/specification/_json_spec/slm.get_status.json +++ b/specification/_json_spec/slm.get_status.json @@ -25,6 +25,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.put_lifecycle.json b/specification/_json_spec/slm.put_lifecycle.json index c3d2114251..5c6d6e5d18 100644 --- a/specification/_json_spec/slm.put_lifecycle.json +++ b/specification/_json_spec/slm.put_lifecycle.json @@ -32,11 +32,13 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, "body": { - "description": "The snapshot lifecycle policy definition to register" + "description": "The snapshot lifecycle policy definition to register", + "required": true } } } diff --git a/specification/_json_spec/slm.start.json b/specification/_json_spec/slm.start.json index b134589253..5d0ef6cacc 100644 --- a/specification/_json_spec/slm.start.json +++ b/specification/_json_spec/slm.start.json @@ -25,6 +25,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/specification/_json_spec/slm.stop.json b/specification/_json_spec/slm.stop.json index cc7f36635a..0b540f8e34 100644 --- a/specification/_json_spec/slm.stop.json +++ b/specification/_json_spec/slm.stop.json @@ -25,6 +25,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/specification/_json_spec/snapshot.cleanup_repository.json b/specification/_json_spec/snapshot.cleanup_repository.json index 86bc30373d..dc66a39c70 100644 --- a/specification/_json_spec/snapshot.cleanup_repository.json +++ b/specification/_json_spec/snapshot.cleanup_repository.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/snapshot.create_repository.json b/specification/_json_spec/snapshot.create_repository.json index 187b978850..81af556670 100644 --- a/specification/_json_spec/snapshot.create_repository.json +++ b/specification/_json_spec/snapshot.create_repository.json @@ -32,10 +32,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/specification/_json_spec/snapshot.delete_repository.json b/specification/_json_spec/snapshot.delete_repository.json index aeb6360a03..5bee4f933d 100644 --- a/specification/_json_spec/snapshot.delete_repository.json +++ b/specification/_json_spec/snapshot.delete_repository.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/snapshot.get.json b/specification/_json_spec/snapshot.get.json index 9e3c11f1b2..b14bc9afff 100644 --- a/specification/_json_spec/snapshot.get.json +++ b/specification/_json_spec/snapshot.get.json @@ -35,18 +35,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": { @@ -64,7 +68,8 @@ "description": "Allows setting a sort order for the result. Defaults to start_time" }, "size": { - "type": "integer", + "type": "int", + "default": 0, "description": "Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit." }, "order": { @@ -82,7 +87,8 @@ "description": "Offset identifier to start pagination from as returned by the 'next' field in the response body." }, "offset": { - "type": "integer", + "type": "int", + "default": 0, "description": "Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0" }, "slm_policy_filter": { @@ -91,6 +97,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" }, "state": { diff --git a/specification/_json_spec/snapshot.get_repository.json b/specification/_json_spec/snapshot.get_repository.json index 670c91cc86..2c436e545a 100644 --- a/specification/_json_spec/snapshot.get_repository.json +++ b/specification/_json_spec/snapshot.get_repository.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/specification/_json_spec/snapshot.repository_analyze.json b/specification/_json_spec/snapshot.repository_analyze.json index d3aa6e2529..da1758cf91 100644 --- a/specification/_json_spec/snapshot.repository_analyze.json +++ b/specification/_json_spec/snapshot.repository_analyze.json @@ -25,51 +25,62 @@ }, "params": { "blob_count": { - "type": "number", + "type": "int", + "default": 100, "description": "Number of blobs to create during the test. Defaults to 100." }, "concurrency": { - "type": "number", + "type": "int", + "default": 10, "description": "Number of operations to run concurrently during the test. Defaults to 10." }, "register_operation_count": { - "type": "number", + "type": "int", + "default": 10, "description": "The minimum number of linearizable register operations to perform in total. Defaults to 10." }, "read_node_count": { - "type": "number", + "type": "int", + "default": 10, "description": "Number of nodes on which to read a blob after writing. Defaults to 10." }, "early_read_node_count": { - "type": "number", + "type": "int", + "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": { - "type": "number", + "type": "int", "description": "Seed for the random number generator used to create the test workload. Defaults to a random value." }, "rare_action_probability": { - "type": "number", + "type": "double", + "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/specification/_json_spec/snapshot.repository_verify_integrity.json b/specification/_json_spec/snapshot.repository_verify_integrity.json index 3774e0372b..b3eae64af0 100644 --- a/specification/_json_spec/snapshot.repository_verify_integrity.json +++ b/specification/_json_spec/snapshot.repository_verify_integrity.json @@ -25,35 +25,43 @@ }, "params": { "meta_thread_pool_concurrency": { - "type": "number", + "type": "int", + "default": 0, "description": "Number of threads to use for reading metadata" }, "blob_thread_pool_concurrency": { - "type": "number", + "type": "int", + "default": 1, "description": "Number of threads to use for reading blob contents" }, "snapshot_verification_concurrency": { - "type": "number", + "type": "int", + "default": 0, "description": "Number of snapshots to verify concurrently" }, "index_verification_concurrency": { - "type": "number", + "type": "int", + "default": 0, "description": "Number of indices to verify concurrently" }, "index_snapshot_verification_concurrency": { - "type": "number", + "type": "int", + "default": 1, "description": "Number of snapshots to verify concurrently within each index" }, "max_failed_shard_snapshots": { - "type": "number", + "type": "int", + "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/specification/_json_spec/snapshot.status.json b/specification/_json_spec/snapshot.status.json index a1ffc026ab..d7b617ea6f 100644 --- a/specification/_json_spec/snapshot.status.json +++ b/specification/_json_spec/snapshot.status.json @@ -49,6 +49,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/specification/_json_spec/snapshot.verify_repository.json b/specification/_json_spec/snapshot.verify_repository.json index f4b320a680..5155bd0b7a 100644 --- a/specification/_json_spec/snapshot.verify_repository.json +++ b/specification/_json_spec/snapshot.verify_repository.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/streams.logs_disable.json b/specification/_json_spec/streams.logs_disable.json index 8ac525142a..c88c044076 100644 --- a/specification/_json_spec/streams.logs_disable.json +++ b/specification/_json_spec/streams.logs_disable.json @@ -21,6 +21,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/specification/_json_spec/streams.logs_enable.json b/specification/_json_spec/streams.logs_enable.json index 7438879c65..f366ba7e4b 100644 --- a/specification/_json_spec/streams.logs_enable.json +++ b/specification/_json_spec/streams.logs_enable.json @@ -21,6 +21,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/specification/_json_spec/streams.status.json b/specification/_json_spec/streams.status.json index 7e931205cb..bacdc09eb6 100644 --- a/specification/_json_spec/streams.status.json +++ b/specification/_json_spec/streams.status.json @@ -21,6 +21,7 @@ "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/specification/_json_spec/synonyms.delete_synonym_rule.json b/specification/_json_spec/synonyms.delete_synonym_rule.json index c924f6beb9..a3de21355f 100644 --- a/specification/_json_spec/synonyms.delete_synonym_rule.json +++ b/specification/_json_spec/synonyms.delete_synonym_rule.json @@ -31,6 +31,7 @@ "params": { "refresh": { "type": "boolean", + "default": true, "description": "Refresh search analyzers to update synonyms" } } diff --git a/specification/_json_spec/synonyms.put_synonym.json b/specification/_json_spec/synonyms.put_synonym.json index 3b2083fa98..ccf4501887 100644 --- a/specification/_json_spec/synonyms.put_synonym.json +++ b/specification/_json_spec/synonyms.put_synonym.json @@ -27,6 +27,7 @@ "params": { "refresh": { "type": "boolean", + "default": true, "description": "Refresh search analyzers to update synonyms" } }, diff --git a/specification/_json_spec/synonyms.put_synonym_rule.json b/specification/_json_spec/synonyms.put_synonym_rule.json index 63d20ae15e..104f239171 100644 --- a/specification/_json_spec/synonyms.put_synonym_rule.json +++ b/specification/_json_spec/synonyms.put_synonym_rule.json @@ -31,6 +31,7 @@ "params": { "refresh": { "type": "boolean", + "default": true, "description": "Refresh search analyzers to update synonyms" } }, diff --git a/specification/_json_spec/tasks.cancel.json b/specification/_json_spec/tasks.cancel.json index 76bb5b2727..96ad580d6b 100644 --- a/specification/_json_spec/tasks.cancel.json +++ b/specification/_json_spec/tasks.cancel.json @@ -42,6 +42,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/specification/_json_spec/tasks.get.json b/specification/_json_spec/tasks.get.json index 31e92f0d2c..a90f45f833 100644 --- a/specification/_json_spec/tasks.get.json +++ b/specification/_json_spec/tasks.get.json @@ -26,10 +26,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/specification/_json_spec/tasks.list.json b/specification/_json_spec/tasks.list.json index 1744eb14b7..ee78def8c7 100644 --- a/specification/_json_spec/tasks.list.json +++ b/specification/_json_spec/tasks.list.json @@ -28,6 +28,7 @@ }, "detailed": { "type": "boolean", + "default": false, "description": "Return detailed task information (default: false)" }, "parent_task_id": { @@ -36,6 +37,7 @@ }, "wait_for_completion": { "type": "boolean", + "default": false, "description": "Wait for the matching tasks to complete (default: false)" }, "group_by": { @@ -46,6 +48,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/terms_enum.json b/specification/_json_spec/terms_enum.json index 97be2472db..a405909af2 100644 --- a/specification/_json_spec/terms_enum.json +++ b/specification/_json_spec/terms_enum.json @@ -26,7 +26,8 @@ }, "params": {}, "body": { - "description": "field name, string which is the prefix expected in matching terms, timeout and size for max number of results" + "description": "field name, string which is the prefix expected in matching terms, timeout and size for max number of results", + "required": true } } } diff --git a/specification/_json_spec/termvectors.json b/specification/_json_spec/termvectors.json index 4bf0734045..8037e04099 100644 --- a/specification/_json_spec/termvectors.json +++ b/specification/_json_spec/termvectors.json @@ -78,10 +78,11 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specifies if request is real-time as opposed to near-real-time (default: true)." }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/text_structure.find_field_structure.json b/specification/_json_spec/text_structure.find_field_structure.json index 9a131dfc17..f4ffbc6728 100644 --- a/specification/_json_spec/text_structure.find_field_structure.json +++ b/specification/_json_spec/text_structure.find_field_structure.json @@ -65,6 +65,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/specification/_json_spec/text_structure.find_message_structure.json b/specification/_json_spec/text_structure.find_message_structure.json index 54a69d0d8a..824415ec08 100644 --- a/specification/_json_spec/text_structure.find_message_structure.json +++ b/specification/_json_spec/text_structure.find_message_structure.json @@ -51,6 +51,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/specification/_json_spec/text_structure.find_structure.json b/specification/_json_spec/text_structure.find_structure.json index 0bf79a9458..1d6c137a5d 100644 --- a/specification/_json_spec/text_structure.find_structure.json +++ b/specification/_json_spec/text_structure.find_structure.json @@ -69,6 +69,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/specification/_json_spec/text_structure.test_grok_pattern.json b/specification/_json_spec/text_structure.test_grok_pattern.json index c8ee70313d..811c20004b 100644 --- a/specification/_json_spec/text_structure.test_grok_pattern.json +++ b/specification/_json_spec/text_structure.test_grok_pattern.json @@ -21,6 +21,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/specification/_json_spec/transform.delete_transform.json b/specification/_json_spec/transform.delete_transform.json index ac7fade471..1ab585f616 100644 --- a/specification/_json_spec/transform.delete_transform.json +++ b/specification/_json_spec/transform.delete_transform.json @@ -26,14 +26,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/specification/_json_spec/transform.get_transform.json b/specification/_json_spec/transform.get_transform.json index c6f9adbc71..b9791d415b 100644 --- a/specification/_json_spec/transform.get_transform.json +++ b/specification/_json_spec/transform.get_transform.json @@ -30,14 +30,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/specification/_json_spec/transform.get_transform_stats.json b/specification/_json_spec/transform.get_transform_stats.json index 83e6b5146f..8985eecfef 100644 --- a/specification/_json_spec/transform.get_transform_stats.json +++ b/specification/_json_spec/transform.get_transform_stats.json @@ -25,11 +25,13 @@ }, "params": { "from": { - "type": "number", + "type": "long", + "default": 0, "description": "skips a number of transform stats, defaults to 0" }, "size": { - "type": "number", + "type": "long", + "default": 100, "description": "specifies a max number of transform stats to get, defaults to 100" }, "timeout": { @@ -38,6 +40,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/specification/_json_spec/transform.preview_transform.json b/specification/_json_spec/transform.preview_transform.json index f624b2f746..70f1c9cc32 100644 --- a/specification/_json_spec/transform.preview_transform.json +++ b/specification/_json_spec/transform.preview_transform.json @@ -31,6 +31,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait for the preview" } }, diff --git a/specification/_json_spec/transform.put_transform.json b/specification/_json_spec/transform.put_transform.json index 7e9ca901cc..178ae3791b 100644 --- a/specification/_json_spec/transform.put_transform.json +++ b/specification/_json_spec/transform.put_transform.json @@ -27,10 +27,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/specification/_json_spec/transform.reset_transform.json b/specification/_json_spec/transform.reset_transform.json index ab5baf3fbb..dedc512e12 100644 --- a/specification/_json_spec/transform.reset_transform.json +++ b/specification/_json_spec/transform.reset_transform.json @@ -26,10 +26,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/specification/_json_spec/transform.schedule_now_transform.json b/specification/_json_spec/transform.schedule_now_transform.json index 77bcb04923..803a8af112 100644 --- a/specification/_json_spec/transform.schedule_now_transform.json +++ b/specification/_json_spec/transform.schedule_now_transform.json @@ -28,6 +28,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait for the scheduling to take place" } } diff --git a/specification/_json_spec/transform.set_upgrade_mode.json b/specification/_json_spec/transform.set_upgrade_mode.json index 16f2c2000e..d34690ffb1 100644 --- a/specification/_json_spec/transform.set_upgrade_mode.json +++ b/specification/_json_spec/transform.set_upgrade_mode.json @@ -20,10 +20,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/specification/_json_spec/transform.start_transform.json b/specification/_json_spec/transform.start_transform.json index a7759fe7fb..986f9bb223 100644 --- a/specification/_json_spec/transform.start_transform.json +++ b/specification/_json_spec/transform.start_transform.json @@ -30,6 +30,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait for the transform to start" } } diff --git a/specification/_json_spec/transform.stop_transform.json b/specification/_json_spec/transform.stop_transform.json index 768ee7c0d1..bede6777a5 100644 --- a/specification/_json_spec/transform.stop_transform.json +++ b/specification/_json_spec/transform.stop_transform.json @@ -26,22 +26,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/specification/_json_spec/transform.update_transform.json b/specification/_json_spec/transform.update_transform.json index ce427bec73..2ff351cd53 100644 --- a/specification/_json_spec/transform.update_transform.json +++ b/specification/_json_spec/transform.update_transform.json @@ -32,6 +32,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait for the update" } }, diff --git a/specification/_json_spec/transform.upgrade_transforms.json b/specification/_json_spec/transform.upgrade_transforms.json index e53ddd4271..949d9ba508 100644 --- a/specification/_json_spec/transform.upgrade_transforms.json +++ b/specification/_json_spec/transform.upgrade_transforms.json @@ -21,10 +21,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/specification/_json_spec/update.json b/specification/_json_spec/update.json index 28960ea947..7fd6785106 100644 --- a/specification/_json_spec/update.json +++ b/specification/_json_spec/update.json @@ -31,10 +31,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": { @@ -47,15 +49,18 @@ }, "lang": { "type": "string", + "default": "painless", "description": "The script language (default: painless)" }, "refresh": { "type": "enum", "options": ["true", "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", + "type": "int", + "default": 0, "description": "Specify how many times should the operation be retried when a conflict occurs (default: 0)" }, "routing": { @@ -64,22 +69,25 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "if_seq_no": { - "type": "number", + "type": "long", "description": "only perform the update operation if the last operation that has changed the document has the specified sequence number" }, "if_primary_term": { - "type": "number", + "type": "long", "description": "only perform the update operation if the last operation that has changed the document has the specified primary term" }, "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/specification/_json_spec/update_by_query.json b/specification/_json_spec/update_by_query.json index 226e59606c..325feca2b1 100644 --- a/specification/_json_spec/update_by_query.json +++ b/specification/_json_spec/update_by_query.json @@ -31,12 +31,13 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "default_operator": { "type": "enum", - "options": ["AND", "OR"], - "default": "OR", + "options": ["and", "or"], + "default": "or", "description": "The default operator for query string query (AND or OR)" }, "df": { @@ -44,15 +45,18 @@ "description": "The field to use as default where no field prefix is given in the query string" }, "from": { - "type": "number", + "type": "long", + "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": { @@ -69,6 +73,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": { @@ -89,6 +94,7 @@ }, "scroll": { "type": "time", + "default": "5m", "description": "Specify how long a consistent view of the index should be maintained for scrolled search" }, "search_type": { @@ -101,7 +107,7 @@ "description": "Explicit timeout for each search request. Defaults to no timeout." }, "max_docs": { - "type": "number", + "type": "long", "description": "Maximum number of documents to process (default: all documents)" }, "sort": { @@ -109,7 +115,7 @@ "description": "A comma-separated list of : pairs" }, "terminate_after": { - "type": "number", + "type": "long", "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early." }, "stats": { @@ -130,6 +136,7 @@ }, "refresh": { "type": "boolean", + "default": false, "description": "Should the affected indexes be refreshed?" }, "timeout": { @@ -139,11 +146,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, + "type": "long", + "default": 1000, "description": "Size on the scroll request powering the update by query" }, "wait_for_completion": { @@ -153,7 +161,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": { @@ -163,7 +171,8 @@ } }, "body": { - "description": "The search definition using the Query DSL" + "description": "The search definition using the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/update_by_query_rethrottle.json b/specification/_json_spec/update_by_query_rethrottle.json index 2095c26864..db0d092456 100644 --- a/specification/_json_spec/update_by_query_rethrottle.json +++ b/specification/_json_spec/update_by_query_rethrottle.json @@ -27,6 +27,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/specification/_json_spec/watcher.execute_watch.json b/specification/_json_spec/watcher.execute_watch.json index 35d4b695e6..2dd77afe37 100644 --- a/specification/_json_spec/watcher.execute_watch.json +++ b/specification/_json_spec/watcher.execute_watch.json @@ -31,6 +31,7 @@ "params": { "debug": { "type": "boolean", + "default": false, "description": "indicates whether the watch should execute in debug mode" } }, diff --git a/specification/_json_spec/watcher.put_watch.json b/specification/_json_spec/watcher.put_watch.json index c9c5489c1d..aab3cebcbf 100644 --- a/specification/_json_spec/watcher.put_watch.json +++ b/specification/_json_spec/watcher.put_watch.json @@ -27,18 +27,19 @@ "params": { "active": { "type": "boolean", + "default": true, "description": "Specify whether the watch is in/active by default" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "if_seq_no": { - "type": "number", + "type": "long", "description": "only update the watch if the last operation that has changed the watch has the specified sequence number" }, "if_primary_term": { - "type": "number", + "type": "long", "description": "only update the watch if the last operation that has changed the watch has the specified primary term" } }, diff --git a/specification/_json_spec/watcher.stats.json b/specification/_json_spec/watcher.stats.json index 034dd70254..335ffd3cc4 100644 --- a/specification/_json_spec/watcher.stats.json +++ b/specification/_json_spec/watcher.stats.json @@ -46,6 +46,7 @@ }, "emit_stacktraces": { "type": "boolean", + "default": false, "description": "Emits stack traces of currently running watches" } }