From e1fc16c9fe3fb74a097b974de51105d3f2d58abd Mon Sep 17 00:00:00 2001 From: pquentin <42327+pquentin@users.noreply.github.com> Date: Sat, 11 Oct 2025 04:07:01 +0000 Subject: [PATCH] Update rest-api-spec --- output/schema/validation-errors.json | 13 +++++++++- .../_internal.delete_desired_balance.json | 1 + .../_internal.delete_desired_nodes.json | 1 + .../_internal.get_desired_balance.json | 1 + .../_internal.prevalidate_node_removal.json | 1 + .../_json_spec/async_search.status.json | 1 + .../_json_spec/async_search.submit.json | 1 + ...autoscaling.delete_autoscaling_policy.json | 2 ++ .../autoscaling.get_autoscaling_capacity.json | 1 + .../autoscaling.get_autoscaling_policy.json | 1 + .../autoscaling.put_autoscaling_policy.json | 2 ++ specification/_json_spec/bulk.json | 7 +++++ specification/_json_spec/cat.allocation.json | 2 ++ .../_json_spec/cat.component_templates.json | 2 ++ specification/_json_spec/cat.indices.json | 1 + specification/_json_spec/cat.master.json | 2 ++ .../cat.ml_data_frame_analytics.json | 2 ++ .../_json_spec/cat.ml_datafeeds.json | 2 ++ specification/_json_spec/cat.ml_jobs.json | 2 ++ specification/_json_spec/cat.nodeattrs.json | 2 ++ specification/_json_spec/cat.nodes.json | 3 +++ .../_json_spec/cat.pending_tasks.json | 2 ++ specification/_json_spec/cat.plugins.json | 2 ++ specification/_json_spec/cat.recovery.json | 1 + .../_json_spec/cat.repositories.json | 1 + specification/_json_spec/cat.segments.json | 26 +++++++++++++++++++ specification/_json_spec/cat.shards.json | 1 + specification/_json_spec/cat.snapshots.json | 2 ++ specification/_json_spec/cat.tasks.json | 1 + specification/_json_spec/cat.templates.json | 2 ++ specification/_json_spec/cat.thread_pool.json | 2 ++ specification/_json_spec/cat.transforms.json | 4 +++ .../ccr.delete_auto_follow_pattern.json | 1 + specification/_json_spec/ccr.follow.json | 1 + specification/_json_spec/ccr.follow_info.json | 1 + .../_json_spec/ccr.follow_stats.json | 1 + .../_json_spec/ccr.forget_follower.json | 1 + .../ccr.get_auto_follow_pattern.json | 1 + .../ccr.pause_auto_follow_pattern.json | 1 + .../_json_spec/ccr.pause_follow.json | 1 + .../ccr.put_auto_follow_pattern.json | 1 + .../ccr.resume_auto_follow_pattern.json | 1 + .../_json_spec/ccr.resume_follow.json | 1 + specification/_json_spec/ccr.stats.json | 2 ++ specification/_json_spec/ccr.unfollow.json | 1 + .../cluster.allocation_explain.json | 3 +++ .../cluster.delete_component_template.json | 2 ++ ...uster.delete_voting_config_exclusions.json | 4 +-- .../cluster.exists_component_template.json | 2 ++ .../cluster.get_component_template.json | 4 +++ .../_json_spec/cluster.get_settings.json | 3 +++ specification/_json_spec/cluster.health.json | 6 +++++ .../_json_spec/cluster.pending_tasks.json | 2 ++ ...cluster.post_voting_config_exclusions.json | 4 +-- .../cluster.put_component_template.json | 1 + .../_json_spec/cluster.put_settings.json | 2 ++ specification/_json_spec/cluster.reroute.json | 6 +++++ specification/_json_spec/cluster.state.json | 5 ++++ specification/_json_spec/cluster.stats.json | 1 + specification/_json_spec/count.json | 5 ++++ specification/_json_spec/create.json | 6 +++++ ...angling_indices.delete_dangling_index.json | 1 + ...angling_indices.import_dangling_index.json | 1 + specification/_json_spec/delete.json | 3 +++ specification/_json_spec/delete_by_query.json | 11 ++++++-- specification/_json_spec/delete_script.json | 2 ++ .../_json_spec/enrich.delete_policy.json | 1 + .../_json_spec/enrich.execute_policy.json | 1 + .../_json_spec/enrich.get_policy.json | 1 + .../_json_spec/enrich.put_policy.json | 1 + specification/_json_spec/enrich.stats.json | 1 + specification/_json_spec/eql.search.json | 2 ++ .../_json_spec/esql.async_query.json | 2 +- .../_json_spec/esql.async_query_stop.json | 7 +++++ specification/_json_spec/esql.query.json | 2 +- specification/_json_spec/exists.json | 2 ++ specification/_json_spec/exists_source.json | 2 ++ specification/_json_spec/explain.json | 2 ++ .../_json_spec/features.get_features.json | 1 + .../_json_spec/features.reset_features.json | 1 + specification/_json_spec/field_caps.json | 2 ++ .../_json_spec/fleet.global_checkpoints.json | 4 +-- specification/_json_spec/get.json | 2 ++ specification/_json_spec/get_script.json | 1 + specification/_json_spec/get_source.json | 2 ++ .../_json_spec/ilm.delete_lifecycle.json | 2 ++ .../_json_spec/ilm.explain_lifecycle.json | 1 + .../_json_spec/ilm.get_lifecycle.json | 2 ++ .../_json_spec/ilm.migrate_to_data_tiers.json | 2 ++ .../_json_spec/ilm.put_lifecycle.json | 2 ++ specification/_json_spec/ilm.start.json | 2 ++ specification/_json_spec/ilm.stop.json | 2 ++ specification/_json_spec/index.json | 6 +++++ .../_json_spec/indices.add_block.json | 4 +++ .../_json_spec/indices.clear_cache.json | 2 ++ specification/_json_spec/indices.clone.json | 3 +++ specification/_json_spec/indices.close.json | 5 ++++ specification/_json_spec/indices.create.json | 3 +++ .../indices.create_data_stream.json | 2 ++ specification/_json_spec/indices.delete.json | 4 +++ .../_json_spec/indices.delete_alias.json | 2 ++ .../indices.delete_data_lifecycle.json | 1 + .../indices.delete_data_stream.json | 1 + .../indices.delete_data_stream_options.json | 1 + .../indices.delete_index_template.json | 2 ++ .../_json_spec/indices.delete_template.json | 2 ++ .../_json_spec/indices.disk_usage.json | 4 +++ specification/_json_spec/indices.exists.json | 4 +++ .../_json_spec/indices.exists_alias.json | 6 +++-- .../indices.exists_index_template.json | 3 +++ .../_json_spec/indices.exists_template.json | 3 +++ .../indices.explain_data_lifecycle.json | 1 + .../_json_spec/indices.field_usage_stats.json | 1 + specification/_json_spec/indices.flush.json | 4 +++ specification/_json_spec/indices.get.json | 5 ++++ .../_json_spec/indices.get_alias.json | 6 +++-- .../indices.get_data_lifecycle.json | 2 ++ .../_json_spec/indices.get_data_stream.json | 3 +++ .../indices.get_data_stream_options.json | 1 + .../indices.get_data_stream_settings.json | 1 + .../_json_spec/indices.get_field_mapping.json | 3 +++ .../indices.get_index_template.json | 4 +++ .../_json_spec/indices.get_mapping.json | 8 ++++-- .../_json_spec/indices.get_settings.json | 5 ++++ .../_json_spec/indices.get_template.json | 3 +++ .../indices.migrate_to_data_stream.json | 2 ++ specification/_json_spec/indices.open.json | 5 ++++ .../indices.promote_data_stream.json | 1 + .../_json_spec/indices.put_alias.json | 2 ++ .../indices.put_data_lifecycle.json | 2 ++ .../indices.put_data_stream_options.json | 2 ++ .../indices.put_data_stream_settings.json | 2 ++ .../indices.put_index_template.json | 3 ++- .../_json_spec/indices.put_mapping.json | 4 +++ .../_json_spec/indices.put_settings.json | 7 +++++ .../_json_spec/indices.put_template.json | 1 + specification/_json_spec/indices.refresh.json | 2 ++ .../_json_spec/indices.remove_block.json | 4 +++ .../_json_spec/indices.resolve_cluster.json | 3 +++ .../_json_spec/indices.rollover.json | 6 ++++- .../_json_spec/indices.segments.json | 2 ++ .../_json_spec/indices.shard_stores.json | 1 + specification/_json_spec/indices.shrink.json | 3 +++ .../indices.simulate_index_template.json | 4 ++- .../_json_spec/indices.simulate_template.json | 4 ++- specification/_json_spec/indices.split.json | 3 +++ .../_json_spec/indices.update_aliases.json | 2 ++ .../_json_spec/indices.validate_query.json | 7 +++++ .../_json_spec/inference.delete.json | 2 ++ .../ingest.delete_geoip_database.json | 2 ++ .../ingest.delete_ip_location_database.json | 2 ++ .../_json_spec/ingest.delete_pipeline.json | 2 ++ .../_json_spec/ingest.get_pipeline.json | 2 ++ .../_json_spec/ingest.put_geoip_database.json | 2 ++ .../ingest.put_ip_location_database.json | 2 ++ .../_json_spec/ingest.put_pipeline.json | 2 ++ specification/_json_spec/license.delete.json | 2 ++ specification/_json_spec/license.get.json | 6 +++-- specification/_json_spec/license.post.json | 3 +++ .../_json_spec/license.post_start_basic.json | 2 ++ .../_json_spec/license.post_start_trial.json | 1 + specification/_json_spec/mget.json | 3 +++ specification/_json_spec/ml.close_job.json | 3 +++ .../ml.delete_data_frame_analytics.json | 1 + .../_json_spec/ml.delete_expired_data.json | 1 + .../_json_spec/ml.delete_forecast.json | 2 ++ specification/_json_spec/ml.forecast.json | 3 +++ specification/_json_spec/ml.get_buckets.json | 9 +++++++ .../_json_spec/ml.get_calendar_events.json | 2 ++ .../_json_spec/ml.get_calendars.json | 2 ++ .../_json_spec/ml.get_categories.json | 2 ++ specification/_json_spec/ml.get_filters.json | 2 ++ .../_json_spec/ml.get_influencers.json | 7 +++++ .../_json_spec/ml.get_job_stats.json | 1 + specification/_json_spec/ml.get_jobs.json | 1 + .../_json_spec/ml.get_memory_stats.json | 2 ++ .../_json_spec/ml.get_model_snapshots.json | 3 +++ .../_json_spec/ml.get_overall_buckets.json | 3 +++ specification/_json_spec/ml.get_records.json | 8 ++++++ specification/_json_spec/ml.put_datafeed.json | 4 +++ specification/_json_spec/ml.put_job.json | 4 +++ .../ml.put_trained_model_alias.json | 1 + .../_json_spec/ml.revert_model_snapshot.json | 1 + .../_json_spec/ml.set_upgrade_mode.json | 2 ++ .../ml.start_data_frame_analytics.json | 1 + .../_json_spec/ml.start_datafeed.json | 1 + .../ml.stop_data_frame_analytics.json | 3 +++ .../_json_spec/ml.stop_datafeed.json | 3 +++ .../ml.stop_trained_model_deployment.json | 2 ++ .../_json_spec/ml.update_datafeed.json | 4 +++ .../ml.update_trained_model_deployment.json | 1 + .../_json_spec/ml.upgrade_job_snapshot.json | 2 ++ specification/_json_spec/msearch.json | 8 +++--- .../_json_spec/msearch_template.json | 1 + specification/_json_spec/mtermvectors.json | 1 + .../_json_spec/nodes.hot_threads.json | 6 +++++ specification/_json_spec/nodes.info.json | 2 ++ .../nodes.reload_secure_settings.json | 1 + specification/_json_spec/nodes.stats.json | 1 + specification/_json_spec/nodes.usage.json | 1 + .../_json_spec/open_point_in_time.json | 2 ++ .../_json_spec/profiling.status.json | 1 + specification/_json_spec/put_script.json | 2 ++ specification/_json_spec/rank_eval.json | 2 ++ specification/_json_spec/reindex.json | 4 ++- specification/_json_spec/rollup.stop_job.json | 2 ++ specification/_json_spec/scroll.json | 1 + specification/_json_spec/search.json | 16 +++++++++++- .../_json_spec/search_application.list.json | 1 + .../_json_spec/search_application.put.json | 1 + specification/_json_spec/search_mvt.json | 1 + specification/_json_spec/search_shards.json | 4 +++ specification/_json_spec/search_template.json | 6 +++++ .../searchable_snapshots.clear_cache.json | 2 +- .../searchable_snapshots.mount.json | 3 ++- .../security.disable_user_profile.json | 1 + .../security.enable_user_profile.json | 1 + .../_json_spec/security.get_settings.json | 1 + .../_json_spec/security.grant_api_key.json | 1 + .../_json_spec/security.put_user.json | 1 + .../_json_spec/security.update_settings.json | 1 + .../security.update_user_profile_data.json | 1 + .../_json_spec/shutdown.delete_node.json | 2 ++ .../_json_spec/shutdown.get_node.json | 1 + .../_json_spec/shutdown.put_node.json | 2 ++ .../_json_spec/slm.delete_lifecycle.json | 2 ++ .../_json_spec/slm.execute_lifecycle.json | 2 ++ .../_json_spec/slm.execute_retention.json | 2 ++ .../_json_spec/slm.get_lifecycle.json | 2 ++ specification/_json_spec/slm.get_stats.json | 2 ++ specification/_json_spec/slm.get_status.json | 2 ++ .../_json_spec/slm.put_lifecycle.json | 2 ++ specification/_json_spec/slm.start.json | 2 ++ specification/_json_spec/slm.stop.json | 2 ++ .../snapshot.cleanup_repository.json | 2 ++ specification/_json_spec/snapshot.clone.json | 1 + specification/_json_spec/snapshot.create.json | 1 + .../snapshot.create_repository.json | 3 +++ specification/_json_spec/snapshot.delete.json | 1 + .../snapshot.delete_repository.json | 2 ++ specification/_json_spec/snapshot.get.json | 8 ++++++ .../_json_spec/snapshot.get_repository.json | 2 ++ .../snapshot.repository_analyze.json | 11 ++++++++ .../snapshot.repository_verify_integrity.json | 8 ++++++ .../_json_spec/snapshot.restore.json | 1 + specification/_json_spec/snapshot.status.json | 2 ++ .../snapshot.verify_repository.json | 2 ++ .../_json_spec/streams.logs_disable.json | 2 ++ .../_json_spec/streams.logs_enable.json | 2 ++ specification/_json_spec/streams.status.json | 1 + .../synonyms.delete_synonym_rule.json | 1 + .../_json_spec/synonyms.put_synonym.json | 1 + .../_json_spec/synonyms.put_synonym_rule.json | 1 + specification/_json_spec/tasks.cancel.json | 1 + specification/_json_spec/tasks.get.json | 2 ++ specification/_json_spec/tasks.list.json | 3 +++ specification/_json_spec/termvectors.json | 1 + .../text_structure.find_field_structure.json | 1 + ...text_structure.find_message_structure.json | 1 + .../text_structure.find_structure.json | 1 + .../text_structure.test_grok_pattern.json | 1 + .../transform.delete_transform.json | 3 +++ .../_json_spec/transform.get_transform.json | 3 +++ .../transform.get_transform_stats.json | 3 +++ .../transform.preview_transform.json | 1 + .../_json_spec/transform.put_transform.json | 2 ++ .../_json_spec/transform.reset_transform.json | 2 ++ .../transform.schedule_now_transform.json | 1 + .../transform.set_upgrade_mode.json | 2 ++ .../_json_spec/transform.start_transform.json | 1 + .../_json_spec/transform.stop_transform.json | 5 ++++ .../transform.update_transform.json | 1 + .../transform.upgrade_transforms.json | 2 ++ specification/_json_spec/update.json | 8 ++++++ specification/_json_spec/update_by_query.json | 12 +++++++-- .../update_by_query_rethrottle.json | 1 + .../_json_spec/watcher.execute_watch.json | 1 + .../_json_spec/watcher.get_settings.json | 1 + .../_json_spec/watcher.put_watch.json | 1 + specification/_json_spec/watcher.start.json | 1 + specification/_json_spec/watcher.stats.json | 1 + specification/_json_spec/watcher.stop.json | 1 + .../_json_spec/watcher.update_settings.json | 1 + specification/_json_spec/xpack.usage.json | 1 + 284 files changed, 708 insertions(+), 32 deletions(-) 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.delete_desired_balance.json b/specification/_json_spec/_internal.delete_desired_balance.json index 4b5034a3ae..5a917cce51 100644 --- a/specification/_json_spec/_internal.delete_desired_balance.json +++ b/specification/_json_spec/_internal.delete_desired_balance.json @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for connection to master node" } } diff --git a/specification/_json_spec/_internal.delete_desired_nodes.json b/specification/_json_spec/_internal.delete_desired_nodes.json index 32d4707fe0..f1d561d132 100644 --- a/specification/_json_spec/_internal.delete_desired_nodes.json +++ b/specification/_json_spec/_internal.delete_desired_nodes.json @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for connection to master node" }, "timeout": { diff --git a/specification/_json_spec/_internal.get_desired_balance.json b/specification/_json_spec/_internal.get_desired_balance.json index f73a5cad89..70c4ce6a59 100644 --- a/specification/_json_spec/_internal.get_desired_balance.json +++ b/specification/_json_spec/_internal.get_desired_balance.json @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for connection to master node" } } diff --git a/specification/_json_spec/_internal.prevalidate_node_removal.json b/specification/_json_spec/_internal.prevalidate_node_removal.json index 4cd5741bd9..9320c6508e 100644 --- a/specification/_json_spec/_internal.prevalidate_node_removal.json +++ b/specification/_json_spec/_internal.prevalidate_node_removal.json @@ -32,6 +32,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { 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 d0d3a7c58b..5d335c611b 100644 --- a/specification/_json_spec/async_search.submit.json +++ b/specification/_json_spec/async_search.submit.json @@ -51,6 +51,7 @@ }, "request_cache": { "type": "boolean", + "default": true, "description": "Specify if request cache should be used for this request or not, defaults to true" }, "analyzer": { diff --git a/specification/_json_spec/autoscaling.delete_autoscaling_policy.json b/specification/_json_spec/autoscaling.delete_autoscaling_policy.json index ab137105a1..20183fcfc9 100644 --- a/specification/_json_spec/autoscaling.delete_autoscaling_policy.json +++ b/specification/_json_spec/autoscaling.delete_autoscaling_policy.json @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/specification/_json_spec/autoscaling.get_autoscaling_capacity.json b/specification/_json_spec/autoscaling.get_autoscaling_capacity.json index e90a60277c..0d6844476b 100644 --- a/specification/_json_spec/autoscaling.get_autoscaling_capacity.json +++ b/specification/_json_spec/autoscaling.get_autoscaling_capacity.json @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" } } diff --git a/specification/_json_spec/autoscaling.get_autoscaling_policy.json b/specification/_json_spec/autoscaling.get_autoscaling_policy.json index 9e23ed7a19..b3380cc855 100644 --- a/specification/_json_spec/autoscaling.get_autoscaling_policy.json +++ b/specification/_json_spec/autoscaling.get_autoscaling_policy.json @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" } } diff --git a/specification/_json_spec/autoscaling.put_autoscaling_policy.json b/specification/_json_spec/autoscaling.put_autoscaling_policy.json index f121a0bd68..48ecc2294e 100644 --- a/specification/_json_spec/autoscaling.put_autoscaling_policy.json +++ b/specification/_json_spec/autoscaling.put_autoscaling_policy.json @@ -27,10 +27,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" }, "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 fa1f591b63..0f41072b13 100644 --- a/specification/_json_spec/cat.allocation.json +++ b/specification/_json_spec/cat.allocation.json @@ -45,10 +45,12 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { diff --git a/specification/_json_spec/cat.component_templates.json b/specification/_json_spec/cat.component_templates.json index a4964a0bc9..a0726ba991 100644 --- a/specification/_json_spec/cat.component_templates.json +++ b/specification/_json_spec/cat.component_templates.json @@ -35,10 +35,12 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { diff --git a/specification/_json_spec/cat.indices.json b/specification/_json_spec/cat.indices.json index aa849dc1ea..9cb526b086 100644 --- a/specification/_json_spec/cat.indices.json +++ b/specification/_json_spec/cat.indices.json @@ -40,6 +40,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { diff --git a/specification/_json_spec/cat.master.json b/specification/_json_spec/cat.master.json index 9531b4795f..d57a92fab8 100644 --- a/specification/_json_spec/cat.master.json +++ b/specification/_json_spec/cat.master.json @@ -25,10 +25,12 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { 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 2d44dccdc5..0bd62a78d9 100644 --- a/specification/_json_spec/cat.nodeattrs.json +++ b/specification/_json_spec/cat.nodeattrs.json @@ -25,10 +25,12 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { diff --git a/specification/_json_spec/cat.nodes.json b/specification/_json_spec/cat.nodes.json index aa49f8cfa3..4e687f2e4e 100644 --- a/specification/_json_spec/cat.nodes.json +++ b/specification/_json_spec/cat.nodes.json @@ -30,14 +30,17 @@ }, "full_id": { "type": "boolean", + "default": false, "description": "Return the full node ID instead of the shortened version (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 bd9553e4d5..8db95f12b2 100644 --- a/specification/_json_spec/cat.pending_tasks.json +++ b/specification/_json_spec/cat.pending_tasks.json @@ -25,10 +25,12 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { diff --git a/specification/_json_spec/cat.plugins.json b/specification/_json_spec/cat.plugins.json index a7a364be49..77d44dd75a 100644 --- a/specification/_json_spec/cat.plugins.json +++ b/specification/_json_spec/cat.plugins.json @@ -25,10 +25,12 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { 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.repositories.json b/specification/_json_spec/cat.repositories.json index 0baddddacf..7a86196778 100644 --- a/specification/_json_spec/cat.repositories.json +++ b/specification/_json_spec/cat.repositories.json @@ -30,6 +30,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { diff --git a/specification/_json_spec/cat.segments.json b/specification/_json_spec/cat.segments.json index ff0945c44c..d33bb93cd4 100644 --- a/specification/_json_spec/cat.segments.json +++ b/specification/_json_spec/cat.segments.json @@ -35,10 +35,12 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "bytes": { @@ -48,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": { @@ -68,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.shards.json b/specification/_json_spec/cat.shards.json index 1d2d8de13c..e753db39f3 100644 --- a/specification/_json_spec/cat.shards.json +++ b/specification/_json_spec/cat.shards.json @@ -40,6 +40,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { diff --git a/specification/_json_spec/cat.snapshots.json b/specification/_json_spec/cat.snapshots.json index 4054e1dd58..9733a93bf0 100644 --- a/specification/_json_spec/cat.snapshots.json +++ b/specification/_json_spec/cat.snapshots.json @@ -40,10 +40,12 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 d6e33f81e0..fc69b211b2 100644 --- a/specification/_json_spec/cat.templates.json +++ b/specification/_json_spec/cat.templates.json @@ -35,10 +35,12 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { diff --git a/specification/_json_spec/cat.thread_pool.json b/specification/_json_spec/cat.thread_pool.json index 32db2c83a7..4b72a21f2c 100644 --- a/specification/_json_spec/cat.thread_pool.json +++ b/specification/_json_spec/cat.thread_pool.json @@ -40,10 +40,12 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { 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.delete_auto_follow_pattern.json b/specification/_json_spec/ccr.delete_auto_follow_pattern.json index 8dda34ec9d..3de651d098 100644 --- a/specification/_json_spec/ccr.delete_auto_follow_pattern.json +++ b/specification/_json_spec/ccr.delete_auto_follow_pattern.json @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/ccr.follow.json b/specification/_json_spec/ccr.follow.json index c1db76f7e5..6d0bb46e2d 100644 --- a/specification/_json_spec/ccr.follow.json +++ b/specification/_json_spec/ccr.follow.json @@ -32,6 +32,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } }, diff --git a/specification/_json_spec/ccr.follow_info.json b/specification/_json_spec/ccr.follow_info.json index cda715a166..dcff396a56 100644 --- a/specification/_json_spec/ccr.follow_info.json +++ b/specification/_json_spec/ccr.follow_info.json @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } 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.get_auto_follow_pattern.json b/specification/_json_spec/ccr.get_auto_follow_pattern.json index ccb09070f6..8fcdec0433 100644 --- a/specification/_json_spec/ccr.get_auto_follow_pattern.json +++ b/specification/_json_spec/ccr.get_auto_follow_pattern.json @@ -30,6 +30,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/ccr.pause_auto_follow_pattern.json b/specification/_json_spec/ccr.pause_auto_follow_pattern.json index 1deffa7cf6..91f14ead8f 100644 --- a/specification/_json_spec/ccr.pause_auto_follow_pattern.json +++ b/specification/_json_spec/ccr.pause_auto_follow_pattern.json @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/ccr.pause_follow.json b/specification/_json_spec/ccr.pause_follow.json index 3f83512ae2..083a95dcfb 100644 --- a/specification/_json_spec/ccr.pause_follow.json +++ b/specification/_json_spec/ccr.pause_follow.json @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/ccr.put_auto_follow_pattern.json b/specification/_json_spec/ccr.put_auto_follow_pattern.json index 2f8654b2f2..e5b74db6ca 100644 --- a/specification/_json_spec/ccr.put_auto_follow_pattern.json +++ b/specification/_json_spec/ccr.put_auto_follow_pattern.json @@ -27,6 +27,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } }, diff --git a/specification/_json_spec/ccr.resume_auto_follow_pattern.json b/specification/_json_spec/ccr.resume_auto_follow_pattern.json index 1dfca73d27..1ad685ae45 100644 --- a/specification/_json_spec/ccr.resume_auto_follow_pattern.json +++ b/specification/_json_spec/ccr.resume_auto_follow_pattern.json @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/ccr.resume_follow.json b/specification/_json_spec/ccr.resume_follow.json index 896f914ad9..5562d25e70 100644 --- a/specification/_json_spec/ccr.resume_follow.json +++ b/specification/_json_spec/ccr.resume_follow.json @@ -27,6 +27,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } }, diff --git a/specification/_json_spec/ccr.stats.json b/specification/_json_spec/ccr.stats.json index 3b6f8b4112..70993a4f5d 100644 --- a/specification/_json_spec/ccr.stats.json +++ b/specification/_json_spec/ccr.stats.json @@ -20,10 +20,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/ccr.unfollow.json b/specification/_json_spec/ccr.unfollow.json index 54667dc3c1..11d2907e55 100644 --- a/specification/_json_spec/ccr.unfollow.json +++ b/specification/_json_spec/ccr.unfollow.json @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/cluster.allocation_explain.json b/specification/_json_spec/cluster.allocation_explain.json index f38db8f95a..1c39bf9874 100644 --- a/specification/_json_spec/cluster.allocation_explain.json +++ b/specification/_json_spec/cluster.allocation_explain.json @@ -21,14 +21,17 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for connection to master node" }, "include_yes_decisions": { "type": "boolean", + "default": false, "description": "Return 'YES' decisions in explanation (default: false)" }, "include_disk_info": { "type": "boolean", + "default": false, "description": "Return information about disk usage and shard sizes (default: false)" } }, diff --git a/specification/_json_spec/cluster.delete_component_template.json b/specification/_json_spec/cluster.delete_component_template.json index 375a834cb6..19c84afb0c 100644 --- a/specification/_json_spec/cluster.delete_component_template.json +++ b/specification/_json_spec/cluster.delete_component_template.json @@ -26,10 +26,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/cluster.delete_voting_config_exclusions.json b/specification/_json_spec/cluster.delete_voting_config_exclusions.json index ef52e7dbab..582f16658a 100644 --- a/specification/_json_spec/cluster.delete_voting_config_exclusions.json +++ b/specification/_json_spec/cluster.delete_voting_config_exclusions.json @@ -25,8 +25,8 @@ }, "master_timeout": { "type": "time", - "description": "Timeout for submitting request to master", - "default": "30s" + "default": "30s", + "description": "Timeout for submitting request to master" } } } diff --git a/specification/_json_spec/cluster.exists_component_template.json b/specification/_json_spec/cluster.exists_component_template.json index 3c7c82a2e5..0ce28f607f 100644 --- a/specification/_json_spec/cluster.exists_component_template.json +++ b/specification/_json_spec/cluster.exists_component_template.json @@ -26,11 +26,13 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" }, "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 645f064e8f..8c18bfc80f 100644 --- a/specification/_json_spec/cluster.get_component_template.json +++ b/specification/_json_spec/cluster.get_component_template.json @@ -30,19 +30,23 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" }, "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 8a19d75e60..363a0780ff 100644 --- a/specification/_json_spec/cluster.get_settings.json +++ b/specification/_json_spec/cluster.get_settings.json @@ -20,14 +20,17 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" }, "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 9d9a40a4c0..55c9036715 100644 --- a/specification/_json_spec/cluster.health.json +++ b/specification/_json_spec/cluster.health.json @@ -42,18 +42,22 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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": { @@ -67,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 5777b9ba8c..27b20916cc 100644 --- a/specification/_json_spec/cluster.pending_tasks.json +++ b/specification/_json_spec/cluster.pending_tasks.json @@ -20,10 +20,12 @@ "params": { "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/cluster.post_voting_config_exclusions.json b/specification/_json_spec/cluster.post_voting_config_exclusions.json index aa99da4b42..971a326cfd 100644 --- a/specification/_json_spec/cluster.post_voting_config_exclusions.json +++ b/specification/_json_spec/cluster.post_voting_config_exclusions.json @@ -33,8 +33,8 @@ }, "master_timeout": { "type": "time", - "description": "Timeout for submitting request to master", - "default": "30s" + "default": "30s", + "description": "Timeout for submitting request to master" } } } diff --git a/specification/_json_spec/cluster.put_component_template.json b/specification/_json_spec/cluster.put_component_template.json index cbacc81c0b..18b6b39d26 100644 --- a/specification/_json_spec/cluster.put_component_template.json +++ b/specification/_json_spec/cluster.put_component_template.json @@ -37,6 +37,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, diff --git a/specification/_json_spec/cluster.put_settings.json b/specification/_json_spec/cluster.put_settings.json index 6d4203f61b..69246ee29c 100644 --- a/specification/_json_spec/cluster.put_settings.json +++ b/specification/_json_spec/cluster.put_settings.json @@ -25,10 +25,12 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 e62c472a97..18bd6459b9 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,14 +46,17 @@ "master_node", "version" ], + "default": "all", "description": "Limit the information returned to the specified metrics. Defaults to all but metadata" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/cluster.state.json b/specification/_json_spec/cluster.state.json index 09b1eb230b..d41a1cb200 100644 --- a/specification/_json_spec/cluster.state.json +++ b/specification/_json_spec/cluster.state.json @@ -64,14 +64,17 @@ "params": { "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "wait_for_metadata_version": { @@ -84,10 +87,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 a398aec6ae..e6911e8b9e 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": { @@ -69,6 +72,7 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "default_operator": { @@ -83,6 +87,7 @@ }, "lenient": { "type": "boolean", + "default": false, "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" }, "terminate_after": { diff --git a/specification/_json_spec/create.json b/specification/_json_spec/create.json index f98a9fe960..913c4e0f88 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,6 +46,7 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "version": { @@ -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/dangling_indices.delete_dangling_index.json b/specification/_json_spec/dangling_indices.delete_dangling_index.json index 542cd83662..7613cd4906 100644 --- a/specification/_json_spec/dangling_indices.delete_dangling_index.json +++ b/specification/_json_spec/dangling_indices.delete_dangling_index.json @@ -34,6 +34,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/dangling_indices.import_dangling_index.json b/specification/_json_spec/dangling_indices.import_dangling_index.json index d1a49946e3..dbc5e0e4df 100644 --- a/specification/_json_spec/dangling_indices.import_dangling_index.json +++ b/specification/_json_spec/dangling_indices.import_dangling_index.json @@ -34,6 +34,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/delete.json b/specification/_json_spec/delete.json index cde2086bba..42e6a5210e 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,6 +45,7 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "if_seq_no": { diff --git a/specification/_json_spec/delete_by_query.json b/specification/_json_spec/delete_by_query.json index 19c6469800..8f31179187 100644 --- a/specification/_json_spec/delete_by_query.json +++ b/specification/_json_spec/delete_by_query.json @@ -31,6 +31,7 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "default_operator": { @@ -45,14 +46,17 @@ }, "from": { "type": "number", + "default": 0, "description": "Starting offset (default: 0)" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "conflicts": { @@ -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": { @@ -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, + "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 59c8b4fd70..e0fb1095c5 100644 --- a/specification/_json_spec/delete_script.json +++ b/specification/_json_spec/delete_script.json @@ -26,10 +26,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/enrich.delete_policy.json b/specification/_json_spec/enrich.delete_policy.json index a331209dd8..f83178ac7a 100644 --- a/specification/_json_spec/enrich.delete_policy.json +++ b/specification/_json_spec/enrich.delete_policy.json @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" } } diff --git a/specification/_json_spec/enrich.execute_policy.json b/specification/_json_spec/enrich.execute_policy.json index 65e9031dc6..3c8689d819 100644 --- a/specification/_json_spec/enrich.execute_policy.json +++ b/specification/_json_spec/enrich.execute_policy.json @@ -31,6 +31,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" } } diff --git a/specification/_json_spec/enrich.get_policy.json b/specification/_json_spec/enrich.get_policy.json index 4e5997c3be..eb32a1b774 100644 --- a/specification/_json_spec/enrich.get_policy.json +++ b/specification/_json_spec/enrich.get_policy.json @@ -30,6 +30,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" } } diff --git a/specification/_json_spec/enrich.put_policy.json b/specification/_json_spec/enrich.put_policy.json index cef8dfc1df..b87c6968e5 100644 --- a/specification/_json_spec/enrich.put_policy.json +++ b/specification/_json_spec/enrich.put_policy.json @@ -31,6 +31,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" } } diff --git a/specification/_json_spec/enrich.stats.json b/specification/_json_spec/enrich.stats.json index 6424e6e5ab..d3dc7c68cc 100644 --- a/specification/_json_spec/enrich.stats.json +++ b/specification/_json_spec/enrich.stats.json @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" } } diff --git a/specification/_json_spec/eql.search.json b/specification/_json_spec/eql.search.json index 4aa0c77ea7..edd1f3185d 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..0ec195bb2b 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": { diff --git a/specification/_json_spec/exists_source.json b/specification/_json_spec/exists_source.json index 0ed14905a8..aa8d8f0c7c 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": { diff --git a/specification/_json_spec/explain.json b/specification/_json_spec/explain.json index e3e4cc2151..e2612abbe1 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": { @@ -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": { diff --git a/specification/_json_spec/features.get_features.json b/specification/_json_spec/features.get_features.json index 85eaf8a479..7cf84a910d 100644 --- a/specification/_json_spec/features.get_features.json +++ b/specification/_json_spec/features.get_features.json @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/features.reset_features.json b/specification/_json_spec/features.reset_features.json index 5d4b519bcb..d48ce9da7c 100644 --- a/specification/_json_spec/features.reset_features.json +++ b/specification/_json_spec/features.reset_features.json @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/field_caps.json b/specification/_json_spec/field_caps.json index 51d6924021..ea06e8dd92 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": { 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/get.json b/specification/_json_spec/get.json index d887e18b01..fc35256b32 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": { diff --git a/specification/_json_spec/get_script.json b/specification/_json_spec/get_script.json index c61327e37d..5eeb5eb50c 100644 --- a/specification/_json_spec/get_script.json +++ b/specification/_json_spec/get_script.json @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/get_source.json b/specification/_json_spec/get_source.json index 0c57cf7a09..32589e71db 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": { diff --git a/specification/_json_spec/ilm.delete_lifecycle.json b/specification/_json_spec/ilm.delete_lifecycle.json index 48b8a4e81c..6dd11a2665 100644 --- a/specification/_json_spec/ilm.delete_lifecycle.json +++ b/specification/_json_spec/ilm.delete_lifecycle.json @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ilm.explain_lifecycle.json b/specification/_json_spec/ilm.explain_lifecycle.json index 0dcebd2a4e..51b434ff98 100644 --- a/specification/_json_spec/ilm.explain_lifecycle.json +++ b/specification/_json_spec/ilm.explain_lifecycle.json @@ -34,6 +34,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/ilm.get_lifecycle.json b/specification/_json_spec/ilm.get_lifecycle.json index ff5ca14803..fdb4775d85 100644 --- a/specification/_json_spec/ilm.get_lifecycle.json +++ b/specification/_json_spec/ilm.get_lifecycle.json @@ -30,10 +30,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 4613002ebc..beb0dcb9a0 100644 --- a/specification/_json_spec/ilm.migrate_to_data_tiers.json +++ b/specification/_json_spec/ilm.migrate_to_data_tiers.json @@ -21,10 +21,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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.put_lifecycle.json b/specification/_json_spec/ilm.put_lifecycle.json index 4bdd1942c7..663c16d3a9 100644 --- a/specification/_json_spec/ilm.put_lifecycle.json +++ b/specification/_json_spec/ilm.put_lifecycle.json @@ -27,10 +27,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/ilm.start.json b/specification/_json_spec/ilm.start.json index bf1fceb2cb..4c28c02ca8 100644 --- a/specification/_json_spec/ilm.start.json +++ b/specification/_json_spec/ilm.start.json @@ -20,10 +20,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 ffb3427484..289c3d12b6 100644 --- a/specification/_json_spec/ilm.stop.json +++ b/specification/_json_spec/ilm.stop.json @@ -20,10 +20,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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..5cce11aec1 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,6 +61,7 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "version": { @@ -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 dfbb82f848..36cedbc06d 100644 --- a/specification/_json_spec/indices.add_block.json +++ b/specification/_json_spec/indices.add_block.json @@ -30,18 +30,22 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "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.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 196995c491..8c7ee1b8aa 100644 --- a/specification/_json_spec/indices.clone.json +++ b/specification/_json_spec/indices.clone.json @@ -31,14 +31,17 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for on the cloned index before the operation returns." } }, diff --git a/specification/_json_spec/indices.close.json b/specification/_json_spec/indices.close.json index ed1ccbd6a2..ed9ec0f28b 100644 --- a/specification/_json_spec/indices.close.json +++ b/specification/_json_spec/indices.close.json @@ -26,18 +26,22 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "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": { @@ -48,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 4aa518fce6..c584c3e650 100644 --- a/specification/_json_spec/indices.create.json +++ b/specification/_json_spec/indices.create.json @@ -27,14 +27,17 @@ "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": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, diff --git a/specification/_json_spec/indices.create_data_stream.json b/specification/_json_spec/indices.create_data_stream.json index 603268931a..592e30dcb4 100644 --- a/specification/_json_spec/indices.create_data_stream.json +++ b/specification/_json_spec/indices.create_data_stream.json @@ -26,10 +26,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for acknowledging the cluster state update" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.delete.json b/specification/_json_spec/indices.delete.json index e0746dbf8e..f63ca2ad35 100644 --- a/specification/_json_spec/indices.delete.json +++ b/specification/_json_spec/indices.delete.json @@ -26,18 +26,22 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "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 279c8133dc..82d875f4ac 100644 --- a/specification/_json_spec/indices.delete_alias.json +++ b/specification/_json_spec/indices.delete_alias.json @@ -44,10 +44,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.delete_data_lifecycle.json b/specification/_json_spec/indices.delete_data_lifecycle.json index 91a3ba13e0..3cc331f44a 100644 --- a/specification/_json_spec/indices.delete_data_lifecycle.json +++ b/specification/_json_spec/indices.delete_data_lifecycle.json @@ -36,6 +36,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.delete_data_stream.json b/specification/_json_spec/indices.delete_data_stream.json index fcec9e52c5..84e95876ec 100644 --- a/specification/_json_spec/indices.delete_data_stream.json +++ b/specification/_json_spec/indices.delete_data_stream.json @@ -32,6 +32,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.delete_data_stream_options.json b/specification/_json_spec/indices.delete_data_stream_options.json index 11615587b8..3ec19540d1 100644 --- a/specification/_json_spec/indices.delete_data_stream_options.json +++ b/specification/_json_spec/indices.delete_data_stream_options.json @@ -36,6 +36,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.delete_index_template.json b/specification/_json_spec/indices.delete_index_template.json index 350d6677ff..c8d8ced179 100644 --- a/specification/_json_spec/indices.delete_index_template.json +++ b/specification/_json_spec/indices.delete_index_template.json @@ -26,10 +26,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.delete_template.json b/specification/_json_spec/indices.delete_template.json index aba74d6be4..d047052d89 100644 --- a/specification/_json_spec/indices.delete_template.json +++ b/specification/_json_spec/indices.delete_template.json @@ -26,10 +26,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } 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 10ff1ee6ed..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": { @@ -54,8 +56,8 @@ }, "master_timeout": { "type": "time", - "description": "Timeout for waiting for new cluster state in case it is blocked", - "default": "30s" + "default": "30s", + "description": "Timeout for waiting for new cluster state in case it is blocked" } } } diff --git a/specification/_json_spec/indices.exists_index_template.json b/specification/_json_spec/indices.exists_index_template.json index cb1088eacb..177943b923 100644 --- a/specification/_json_spec/indices.exists_index_template.json +++ b/specification/_json_spec/indices.exists_index_template.json @@ -26,14 +26,17 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 a03b1c58fe..f4a859c8ab 100644 --- a/specification/_json_spec/indices.exists_template.json +++ b/specification/_json_spec/indices.exists_template.json @@ -26,15 +26,18 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" }, "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.explain_data_lifecycle.json b/specification/_json_spec/indices.explain_data_lifecycle.json index 467b42e9cf..cf0aa2a2a5 100644 --- a/specification/_json_spec/indices.explain_data_lifecycle.json +++ b/specification/_json_spec/indices.explain_data_lifecycle.json @@ -30,6 +30,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } 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.get.json b/specification/_json_spec/indices.get.json index f7c982f536..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": { @@ -59,6 +63,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.get_alias.json b/specification/_json_spec/indices.get_alias.json index 6a2982099f..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": { @@ -68,8 +70,8 @@ }, "master_timeout": { "type": "time", - "description": "Timeout for waiting for new cluster state in case it is blocked", - "default": "30s" + "default": "30s", + "description": "Timeout for waiting for new cluster state in case it is blocked" } } } diff --git a/specification/_json_spec/indices.get_data_lifecycle.json b/specification/_json_spec/indices.get_data_lifecycle.json index 38c1ecb0df..fb8d4fb73c 100644 --- a/specification/_json_spec/indices.get_data_lifecycle.json +++ b/specification/_json_spec/indices.get_data_lifecycle.json @@ -32,10 +32,12 @@ }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for the data stream (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.get_data_stream.json b/specification/_json_spec/indices.get_data_stream.json index d119620147..646e5844ef 100644 --- a/specification/_json_spec/indices.get_data_stream.json +++ b/specification/_json_spec/indices.get_data_stream.json @@ -36,14 +36,17 @@ }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for the data stream (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "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_data_stream_options.json b/specification/_json_spec/indices.get_data_stream_options.json index 0a259cdde7..a94c7e6e3d 100644 --- a/specification/_json_spec/indices.get_data_stream_options.json +++ b/specification/_json_spec/indices.get_data_stream_options.json @@ -32,6 +32,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.get_data_stream_settings.json b/specification/_json_spec/indices.get_data_stream_settings.json index fe0a5deb83..7a1c25fe7e 100644 --- a/specification/_json_spec/indices.get_data_stream_settings.json +++ b/specification/_json_spec/indices.get_data_stream_settings.json @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Period to wait for a connection to the master node" } } 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 cd6f748b37..1c7b97c2ed 100644 --- a/specification/_json_spec/indices.get_index_template.json +++ b/specification/_json_spec/indices.get_index_template.json @@ -30,19 +30,23 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" }, "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 da48a33b5a..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": { @@ -44,12 +46,14 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" }, "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 7abd292450..22d07c3521 100644 --- a/specification/_json_spec/indices.get_settings.json +++ b/specification/_json_spec/indices.get_settings.json @@ -54,14 +54,17 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "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": { @@ -72,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 ffde2b851a..d30a3be0ab 100644 --- a/specification/_json_spec/indices.get_template.json +++ b/specification/_json_spec/indices.get_template.json @@ -30,15 +30,18 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" }, "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 2bab238947..1bc53824a0 100644 --- a/specification/_json_spec/indices.migrate_to_data_stream.json +++ b/specification/_json_spec/indices.migrate_to_data_stream.json @@ -26,10 +26,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for acknowledging the cluster state update" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.open.json b/specification/_json_spec/indices.open.json index 5d4a11d0b6..5c27090e05 100644 --- a/specification/_json_spec/indices.open.json +++ b/specification/_json_spec/indices.open.json @@ -26,18 +26,22 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "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": { @@ -48,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.promote_data_stream.json b/specification/_json_spec/indices.promote_data_stream.json index af5e889ee7..48b4a1d397 100644 --- a/specification/_json_spec/indices.promote_data_stream.json +++ b/specification/_json_spec/indices.promote_data_stream.json @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.put_alias.json b/specification/_json_spec/indices.put_alias.json index 4b730b7944..6c0f3b73e2 100644 --- a/specification/_json_spec/indices.put_alias.json +++ b/specification/_json_spec/indices.put_alias.json @@ -45,10 +45,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, diff --git a/specification/_json_spec/indices.put_data_lifecycle.json b/specification/_json_spec/indices.put_data_lifecycle.json index 16b0aa703c..bd973f3845 100644 --- a/specification/_json_spec/indices.put_data_lifecycle.json +++ b/specification/_json_spec/indices.put_data_lifecycle.json @@ -33,10 +33,12 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, diff --git a/specification/_json_spec/indices.put_data_stream_options.json b/specification/_json_spec/indices.put_data_stream_options.json index c281ff870c..5ba8532135 100644 --- a/specification/_json_spec/indices.put_data_stream_options.json +++ b/specification/_json_spec/indices.put_data_stream_options.json @@ -33,10 +33,12 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, diff --git a/specification/_json_spec/indices.put_data_stream_settings.json b/specification/_json_spec/indices.put_data_stream_settings.json index 5ca923ee83..5ef9932506 100644 --- a/specification/_json_spec/indices.put_data_stream_settings.json +++ b/specification/_json_spec/indices.put_data_stream_settings.json @@ -31,10 +31,12 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Period to wait for a response" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Period to wait for a connection to the master node" } }, diff --git a/specification/_json_spec/indices.put_index_template.json b/specification/_json_spec/indices.put_index_template.json index 96f7e48caa..810ad7b02b 100644 --- a/specification/_json_spec/indices.put_index_template.json +++ b/specification/_json_spec/indices.put_index_template.json @@ -33,10 +33,11 @@ "cause": { "type": "string", "description": "User defined reason for creating/updating the index template", - "default": false + "default": "api" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, diff --git a/specification/_json_spec/indices.put_mapping.json b/specification/_json_spec/indices.put_mapping.json index 4059c16c26..3ce04268d8 100644 --- a/specification/_json_spec/indices.put_mapping.json +++ b/specification/_json_spec/indices.put_mapping.json @@ -27,18 +27,22 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "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 68144b8c4d..60b1e83f76 100644 --- a/specification/_json_spec/indices.put_settings.json +++ b/specification/_json_spec/indices.put_settings.json @@ -31,26 +31,32 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "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": { @@ -61,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 0c31e8e8c1..8caf083184 100644 --- a/specification/_json_spec/indices.put_template.json +++ b/specification/_json_spec/indices.put_template.json @@ -41,6 +41,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, 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 a3b69b7745..39fc1f3181 100644 --- a/specification/_json_spec/indices.remove_block.json +++ b/specification/_json_spec/indices.remove_block.json @@ -30,18 +30,22 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "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 03966b9377..d3669ef462 100644 --- a/specification/_json_spec/indices.rollover.json +++ b/specification/_json_spec/indices.rollover.json @@ -41,23 +41,27 @@ "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": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns." }, "lazy": { "type": "boolean", - "default": "false", + "default": false, "description": "If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams." } }, diff --git a/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 f846aacd49..c7204ceed7 100644 --- a/specification/_json_spec/indices.shrink.json +++ b/specification/_json_spec/indices.shrink.json @@ -31,14 +31,17 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." } }, diff --git a/specification/_json_spec/indices.simulate_index_template.json b/specification/_json_spec/indices.simulate_index_template.json index 39ccd9d54b..30860558e1 100644 --- a/specification/_json_spec/indices.simulate_index_template.json +++ b/specification/_json_spec/indices.simulate_index_template.json @@ -33,14 +33,16 @@ "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", + "default": "30s", "description": "Specify timeout for connection to master" }, "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 fde68f9f38..ef163a3694 100644 --- a/specification/_json_spec/indices.simulate_template.json +++ b/specification/_json_spec/indices.simulate_template.json @@ -37,14 +37,16 @@ "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", + "default": "30s", "description": "Specify timeout for connection to master" }, "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 5a62d98983..014829248d 100644 --- a/specification/_json_spec/indices.split.json +++ b/specification/_json_spec/indices.split.json @@ -31,14 +31,17 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." } }, diff --git a/specification/_json_spec/indices.update_aliases.json b/specification/_json_spec/indices.update_aliases.json index 36612249ed..5e810b1a3b 100644 --- a/specification/_json_spec/indices.update_aliases.json +++ b/specification/_json_spec/indices.update_aliases.json @@ -21,10 +21,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Request timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, diff --git a/specification/_json_spec/indices.validate_query.json b/specification/_json_spec/indices.validate_query.json index 09f067a434..4e5248b76c 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,6 +60,7 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "default_operator": { @@ -71,14 +75,17 @@ }, "lenient": { "type": "boolean", + "default": false, "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" }, "rewrite": { "type": "boolean", + "default": false, "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed." }, "all_shards": { "type": "boolean", + "default": false, "description": "Execute validation on all shards instead of one random shard per index" } }, diff --git a/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/ingest.delete_geoip_database.json b/specification/_json_spec/ingest.delete_geoip_database.json index 938b0bab13..de18d8dd5b 100644 --- a/specification/_json_spec/ingest.delete_geoip_database.json +++ b/specification/_json_spec/ingest.delete_geoip_database.json @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 be1ae314b2..61b7d2cc16 100644 --- a/specification/_json_spec/ingest.delete_ip_location_database.json +++ b/specification/_json_spec/ingest.delete_ip_location_database.json @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 ddd70143d1..0f9a3e99bb 100644 --- a/specification/_json_spec/ingest.delete_pipeline.json +++ b/specification/_json_spec/ingest.delete_pipeline.json @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 e454bd7ee4..52867860c2 100644 --- a/specification/_json_spec/ingest.get_pipeline.json +++ b/specification/_json_spec/ingest.get_pipeline.json @@ -30,10 +30,12 @@ "params": { "summary": { "type": "boolean", + "default": false, "description": "Return pipelines without their definitions (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/ingest.put_geoip_database.json b/specification/_json_spec/ingest.put_geoip_database.json index 3889946bee..62a3d322f7 100644 --- a/specification/_json_spec/ingest.put_geoip_database.json +++ b/specification/_json_spec/ingest.put_geoip_database.json @@ -27,10 +27,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 634cf4c3a8..dde223dcac 100644 --- a/specification/_json_spec/ingest.put_ip_location_database.json +++ b/specification/_json_spec/ingest.put_ip_location_database.json @@ -27,10 +27,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 0693256469..ef9143971b 100644 --- a/specification/_json_spec/ingest.put_pipeline.json +++ b/specification/_json_spec/ingest.put_pipeline.json @@ -31,10 +31,12 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/license.delete.json b/specification/_json_spec/license.delete.json index b908e987ce..71d2804016 100644 --- a/specification/_json_spec/license.delete.json +++ b/specification/_json_spec/license.delete.json @@ -20,10 +20,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" }, "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 66e39bfaf1..d048e9e42d 100644 --- a/specification/_json_spec/license.post.json +++ b/specification/_json_spec/license.post.json @@ -21,14 +21,17 @@ "params": { "acknowledge": { "type": "boolean", + "default": false, "description": "whether the user has acknowledged acknowledge messages (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } }, diff --git a/specification/_json_spec/license.post_start_basic.json b/specification/_json_spec/license.post_start_basic.json index b4baa5e5ff..6e7bc37e01 100644 --- a/specification/_json_spec/license.post_start_basic.json +++ b/specification/_json_spec/license.post_start_basic.json @@ -24,10 +24,12 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/specification/_json_spec/license.post_start_trial.json b/specification/_json_spec/license.post_start_trial.json index fe3580ad1a..91bb6e1b80 100644 --- a/specification/_json_spec/license.post_start_trial.json +++ b/specification/_json_spec/license.post_start_trial.json @@ -28,6 +28,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" } } 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..a940beccfc 100644 --- a/specification/_json_spec/ml.delete_expired_data.json +++ b/specification/_json_spec/ml.delete_expired_data.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "8h", "description": "How long can the underlying delete processes run until they are canceled" } }, 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.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..9658e2b82a 100644 --- a/specification/_json_spec/ml.get_buckets.json +++ b/specification/_json_spec/ml.get_buckets.json @@ -41,38 +41,47 @@ "params": { "expand": { "type": "boolean", + "default": false, "description": "Include anomaly records" }, "exclude_interim": { "type": "boolean", + "default": false, "description": "Exclude interim results" }, "from": { "type": "int", + "default": 0, "description": "skips a number of buckets" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of buckets to get" }, "start": { "type": "string", + "default": "-1", "description": "Start time filter for buckets" }, "end": { "type": "string", + "default": "-1", "description": "End time filter for buckets" }, "anomaly_score": { "type": "double", + "default": 0, "description": "Filter for the most anomalous buckets" }, "sort": { "type": "string", + "default": "timestamp", "description": "Sort buckets by a particular field" }, "desc": { "type": "boolean", + "default": false, "description": "Set the sort direction" } }, diff --git a/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..90f5de5165 100644 --- a/specification/_json_spec/ml.get_calendars.json +++ b/specification/_json_spec/ml.get_calendars.json @@ -31,10 +31,12 @@ "params": { "from": { "type": "int", + "default": 0, "description": "skips a number of calendars" }, "size": { "type": "int", + "default": 10000, "description": "specifies a max number of calendars to get" } }, diff --git a/specification/_json_spec/ml.get_categories.json b/specification/_json_spec/ml.get_categories.json index cb3b9acb81..5d31f3d99d 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": { 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..84aab83733 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,6 +61,7 @@ }, "desc": { "type": "boolean", + "default": false, "description": "whether the results should be sorted in decending order" } }, 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 a3260c8ca0..835d9a9bf3 100644 --- a/specification/_json_spec/ml.get_memory_stats.json +++ b/specification/_json_spec/ml.get_memory_stats.json @@ -30,10 +30,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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..bb4a781cd6 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,6 +63,7 @@ }, "desc": { "type": "boolean", + "default": false, "description": "True if the results should be sorted in descending order" } }, diff --git a/specification/_json_spec/ml.get_overall_buckets.json b/specification/_json_spec/ml.get_overall_buckets.json index e427ae2bde..5c013a1098 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,6 +53,7 @@ }, "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)" } }, diff --git a/specification/_json_spec/ml.get_records.json b/specification/_json_spec/ml.get_records.json index cb083c6375..e5a5c6ece2 100644 --- a/specification/_json_spec/ml.get_records.json +++ b/specification/_json_spec/ml.get_records.json @@ -27,34 +27,42 @@ "params": { "exclude_interim": { "type": "boolean", + "default": false, "description": "Exclude interim results" }, "from": { "type": "int", + "default": 0, "description": "skips a number of records" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of records to get" }, "start": { "type": "string", + "default": "-1", "description": "Start time filter for records" }, "end": { "type": "string", + "default": "-1", "description": "End time filter for records" }, "record_score": { "type": "double", + "default": 0, "description": "Returns records with anomaly scores greater or equal than this value" }, "sort": { "type": "string", + "default": "record_score", "description": "Sort records by a particular field" }, "desc": { "type": "boolean", + "default": false, "description": "Set the sort direction" } }, diff --git a/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..ed9fcbcf84 100644 --- a/specification/_json_spec/ml.revert_model_snapshot.json +++ b/specification/_json_spec/ml.revert_model_snapshot.json @@ -31,6 +31,7 @@ "params": { "delete_intervening_results": { "type": "boolean", + "default": false, "description": "Should we reset the results back to the time of the snapshot?" } }, diff --git a/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..8be96d53bc 100644 --- a/specification/_json_spec/ml.start_data_frame_analytics.json +++ b/specification/_json_spec/ml.start_data_frame_analytics.json @@ -27,6 +27,7 @@ "params": { "timeout": { "type": "time", + "default": "20s", "description": "Controls the time to wait until the task has started. Defaults to 20 seconds" } }, diff --git a/specification/_json_spec/ml.start_datafeed.json b/specification/_json_spec/ml.start_datafeed.json index 4d0b07ddf2..e871b3e67b 100644 --- a/specification/_json_spec/ml.start_datafeed.json +++ b/specification/_json_spec/ml.start_datafeed.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "20s", "description": "Controls the time to wait until a datafeed has started. Default to 20 seconds" } }, diff --git a/specification/_json_spec/ml.stop_data_frame_analytics.json b/specification/_json_spec/ml.stop_data_frame_analytics.json index 21d470ec10..b80f54df01 100644 --- a/specification/_json_spec/ml.stop_data_frame_analytics.json +++ b/specification/_json_spec/ml.stop_data_frame_analytics.json @@ -27,14 +27,17 @@ "params": { "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)" }, "force": { "type": "boolean", + "default": false, "description": "True if the data frame analytics should be forcefully stopped" }, "timeout": { "type": "time", + "default": "20s", "description": "Controls the time to wait until the task has stopped. Defaults to 20 seconds" } }, diff --git a/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..5ff6b4a3a4 100644 --- a/specification/_json_spec/ml.stop_trained_model_deployment.json +++ b/specification/_json_spec/ml.stop_trained_model_deployment.json @@ -28,10 +28,12 @@ "params": { "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no deployments. (This includes `_all` string or when no deployments have been specified)" }, "force": { "type": "boolean", + "default": false, "description": "True if the deployment should be forcefully stopped" } }, diff --git a/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 2aaf0586e2..f3f75c911c 100644 --- a/specification/_json_spec/msearch.json +++ b/specification/_json_spec/msearch.json @@ -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 6e955f2583..a90541e8f0 100644 --- a/specification/_json_spec/msearch_template.json +++ b/specification/_json_spec/msearch_template.json @@ -36,6 +36,7 @@ }, "typed_keys": { "type": "boolean", + "default": false, "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response" }, "max_concurrent_searches": { diff --git a/specification/_json_spec/mtermvectors.json b/specification/_json_spec/mtermvectors.json index 71dd82501e..10b49beba1 100644 --- a/specification/_json_spec/mtermvectors.json +++ b/specification/_json_spec/mtermvectors.json @@ -72,6 +72,7 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specifies if requests are real-time as opposed to near-real-time (default: true)." }, "version": { diff --git a/specification/_json_spec/nodes.hot_threads.json b/specification/_json_spec/nodes.hot_threads.json index bdeb980094..e6295a5170 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", + "default": 10, "description": "Number of samples of thread stacktrace (default: 10)" }, "threads": { "type": "number", + "default": 3, "description": "Specify the number of threads to provide information for (default: 3)" }, "ignore_idle_threads": { "type": "boolean", + "default": true, "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)" }, "type": { "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 1b635bcd7c..7e920df74a 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,6 +51,7 @@ }, "allow_partial_search_results": { "type": "boolean", + "default": false, "description": "Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception. (default: false)" }, "max_concurrent_shard_requests": { diff --git a/specification/_json_spec/profiling.status.json b/specification/_json_spec/profiling.status.json index 1bdb52125f..68a76d9cfd 100644 --- a/specification/_json_spec/profiling.status.json +++ b/specification/_json_spec/profiling.status.json @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { diff --git a/specification/_json_spec/put_script.json b/specification/_json_spec/put_script.json index 4cd841281e..469a4d809b 100644 --- a/specification/_json_spec/put_script.json +++ b/specification/_json_spec/put_script.json @@ -41,10 +41,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "context": { 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..f24e7d66c9 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": { 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/scroll.json b/specification/_json_spec/scroll.json index 437a4be460..02bfd54055 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": { diff --git a/specification/_json_spec/search.json b/specification/_json_spec/search.json index 452fca3ba7..f6f8f0d738 100644 --- a/specification/_json_spec/search.json +++ b/specification/_json_spec/search.json @@ -35,12 +35,13 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", - "default": "true" + "default": true }, "default_operator": { "type": "enum", @@ -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": { @@ -66,6 +68,7 @@ }, "from": { "type": "number", + "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": { @@ -119,6 +126,7 @@ }, "size": { "type": "number", + "default": 10, "description": "Number of hits to return (default: 10)" }, "sort": { @@ -127,6 +135,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": { @@ -139,6 +148,7 @@ }, "terminate_after": { "type": "number", + "default": 0, "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early." }, "stats": { @@ -169,10 +179,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": { @@ -182,10 +194,12 @@ }, "typed_keys": { "type": "boolean", + "default": false, "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response" }, "version": { "type": "boolean", + "default": false, "description": "Specify whether to return document version as part of a hit" }, "seq_no_primary_term": { diff --git a/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 2c76555b05..dcc4b0afd1 100644 --- a/specification/_json_spec/search_mvt.json +++ b/specification/_json_spec/search_mvt.json @@ -75,6 +75,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 7f4bab9bf7..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": { @@ -56,6 +59,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/search_template.json b/specification/_json_spec/search_template.json index d203ccea8a..0841e8d015 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": { 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 818477d204..1a0aca4bd1 100644 --- a/specification/_json_spec/searchable_snapshots.mount.json +++ b/specification/_json_spec/searchable_snapshots.mount.json @@ -31,6 +31,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "wait_for_completion": { @@ -41,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.get_settings.json b/specification/_json_spec/security.get_settings.json index 193b47b6d5..1f46e9f79f 100644 --- a/specification/_json_spec/security.get_settings.json +++ b/specification/_json_spec/security.get_settings.json @@ -21,6 +21,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for connection to master" } } 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_settings.json b/specification/_json_spec/security.update_settings.json index 72fdf25bdb..bae094e2c8 100644 --- a/specification/_json_spec/security.update_settings.json +++ b/specification/_json_spec/security.update_settings.json @@ -21,6 +21,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for connection to master" }, "timeout": { diff --git a/specification/_json_spec/security.update_user_profile_data.json b/specification/_json_spec/security.update_user_profile_data.json index 0395beec9d..1d28f2dfb6 100644 --- a/specification/_json_spec/security.update_user_profile_data.json +++ b/specification/_json_spec/security.update_user_profile_data.json @@ -36,6 +36,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/shutdown.delete_node.json b/specification/_json_spec/shutdown.delete_node.json index 21a1b5ffbb..bba125b182 100644 --- a/specification/_json_spec/shutdown.delete_node.json +++ b/specification/_json_spec/shutdown.delete_node.json @@ -27,10 +27,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/shutdown.get_node.json b/specification/_json_spec/shutdown.get_node.json index 446f2a370e..82c82632e1 100644 --- a/specification/_json_spec/shutdown.get_node.json +++ b/specification/_json_spec/shutdown.get_node.json @@ -32,6 +32,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" } } diff --git a/specification/_json_spec/shutdown.put_node.json b/specification/_json_spec/shutdown.put_node.json index fd30ae1c4c..78292e3c78 100644 --- a/specification/_json_spec/shutdown.put_node.json +++ b/specification/_json_spec/shutdown.put_node.json @@ -27,10 +27,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 2f651f027e..5766645ba4 100644 --- a/specification/_json_spec/slm.delete_lifecycle.json +++ b/specification/_json_spec/slm.delete_lifecycle.json @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 59c58b90c8..4c97208c15 100644 --- a/specification/_json_spec/slm.execute_lifecycle.json +++ b/specification/_json_spec/slm.execute_lifecycle.json @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 44a1af3ec9..5acc3f5b32 100644 --- a/specification/_json_spec/slm.execute_retention.json +++ b/specification/_json_spec/slm.execute_retention.json @@ -20,10 +20,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 f9579daff4..f2218aa357 100644 --- a/specification/_json_spec/slm.get_lifecycle.json +++ b/specification/_json_spec/slm.get_lifecycle.json @@ -30,10 +30,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 898a3c8e03..9cd90507da 100644 --- a/specification/_json_spec/slm.get_stats.json +++ b/specification/_json_spec/slm.get_stats.json @@ -20,10 +20,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 9466510153..d1f6958400 100644 --- a/specification/_json_spec/slm.get_status.json +++ b/specification/_json_spec/slm.get_status.json @@ -20,10 +20,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 1df0f1f64c..a3972719de 100644 --- a/specification/_json_spec/slm.put_lifecycle.json +++ b/specification/_json_spec/slm.put_lifecycle.json @@ -27,10 +27,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/slm.start.json b/specification/_json_spec/slm.start.json index 42fcacc306..5d0ef6cacc 100644 --- a/specification/_json_spec/slm.start.json +++ b/specification/_json_spec/slm.start.json @@ -20,10 +20,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" }, "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 d20a46473e..0b540f8e34 100644 --- a/specification/_json_spec/slm.stop.json +++ b/specification/_json_spec/slm.stop.json @@ -20,10 +20,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" }, "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 34d032f469..dc66a39c70 100644 --- a/specification/_json_spec/snapshot.cleanup_repository.json +++ b/specification/_json_spec/snapshot.cleanup_repository.json @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/snapshot.clone.json b/specification/_json_spec/snapshot.clone.json index 7bf57eeb8c..5a4a65bb99 100644 --- a/specification/_json_spec/snapshot.clone.json +++ b/specification/_json_spec/snapshot.clone.json @@ -35,6 +35,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } }, diff --git a/specification/_json_spec/snapshot.create.json b/specification/_json_spec/snapshot.create.json index c80639c221..6c2c7bfbe4 100644 --- a/specification/_json_spec/snapshot.create.json +++ b/specification/_json_spec/snapshot.create.json @@ -31,6 +31,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "wait_for_completion": { diff --git a/specification/_json_spec/snapshot.create_repository.json b/specification/_json_spec/snapshot.create_repository.json index 1d234c1dda..81af556670 100644 --- a/specification/_json_spec/snapshot.create_repository.json +++ b/specification/_json_spec/snapshot.create_repository.json @@ -27,14 +27,17 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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.json b/specification/_json_spec/snapshot.delete.json index edff8bb28d..30de2cfa34 100644 --- a/specification/_json_spec/snapshot.delete.json +++ b/specification/_json_spec/snapshot.delete.json @@ -30,6 +30,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "wait_for_completion": { diff --git a/specification/_json_spec/snapshot.delete_repository.json b/specification/_json_spec/snapshot.delete_repository.json index b87d3d63f3..5bee4f933d 100644 --- a/specification/_json_spec/snapshot.delete_repository.json +++ b/specification/_json_spec/snapshot.delete_repository.json @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 fa07b7bf49..5c05a31e92 100644 --- a/specification/_json_spec/snapshot.get.json +++ b/specification/_json_spec/snapshot.get.json @@ -30,22 +30,27 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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,6 +69,7 @@ }, "size": { "type": "integer", + "default": 0, "description": "Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit." }, "order": { @@ -82,6 +88,7 @@ }, "offset": { "type": "integer", + "default": 0, "description": "Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0" }, "slm_policy_filter": { @@ -90,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 8afb9689a9..2c436e545a 100644 --- a/specification/_json_spec/snapshot.get_repository.json +++ b/specification/_json_spec/snapshot.get_repository.json @@ -30,10 +30,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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..5325d4ff6f 100644 --- a/specification/_json_spec/snapshot.repository_analyze.json +++ b/specification/_json_spec/snapshot.repository_analyze.json @@ -26,22 +26,27 @@ "params": { "blob_count": { "type": "number", + "default": 100, "description": "Number of blobs to create during the test. Defaults to 100." }, "concurrency": { "type": "number", + "default": 10, "description": "Number of operations to run concurrently during the test. Defaults to 10." }, "register_operation_count": { "type": "number", + "default": 10, "description": "The minimum number of linearizable register operations to perform in total. Defaults to 10." }, "read_node_count": { "type": "number", + "default": 10, "description": "Number of nodes on which to read a blob after writing. Defaults to 10." }, "early_read_node_count": { "type": "number", + "default": 2, "description": "Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the 'rare_action_probability' parameter is also relevant. Defaults to 2." }, "seed": { @@ -50,26 +55,32 @@ }, "rare_action_probability": { "type": "number", + "default": 0, "description": "Probability of taking a rare action such as an early read or an overwrite. Defaults to 0.02." }, "max_blob_size": { "type": "string", + "default": "10mb", "description": "Maximum size of a blob to create during the test, e.g '1gb' or '100mb'. Defaults to '10mb'." }, "max_total_data_size": { "type": "string", + "default": "1gb", "description": "Maximum total size of all blobs to create during the test, e.g '1tb' or '100gb'. Defaults to '1gb'." }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout. Defaults to '30s'." }, "detailed": { "type": "boolean", + "default": false, "description": "Whether to return detailed results or a summary. Defaults to 'false' so that only the summary is returned." }, "rarely_abort_writes": { "type": "boolean", + "default": true, "description": "Whether to rarely abort writes before they complete. Defaults to 'true'." } } diff --git a/specification/_json_spec/snapshot.repository_verify_integrity.json b/specification/_json_spec/snapshot.repository_verify_integrity.json index 3774e0372b..c8719a108c 100644 --- a/specification/_json_spec/snapshot.repository_verify_integrity.json +++ b/specification/_json_spec/snapshot.repository_verify_integrity.json @@ -26,34 +26,42 @@ "params": { "meta_thread_pool_concurrency": { "type": "number", + "default": 0, "description": "Number of threads to use for reading metadata" }, "blob_thread_pool_concurrency": { "type": "number", + "default": 1, "description": "Number of threads to use for reading blob contents" }, "snapshot_verification_concurrency": { "type": "number", + "default": 0, "description": "Number of snapshots to verify concurrently" }, "index_verification_concurrency": { "type": "number", + "default": 0, "description": "Number of indices to verify concurrently" }, "index_snapshot_verification_concurrency": { "type": "number", + "default": 1, "description": "Number of snapshots to verify concurrently within each index" }, "max_failed_shard_snapshots": { "type": "number", + "default": 10000, "description": "Maximum permitted number of failed shard snapshots" }, "verify_blob_contents": { "type": "boolean", + "default": false, "description": "Whether to verify the contents of individual blobs" }, "max_bytes_per_sec": { "type": "string", + "default": "10mb", "description": "Rate limit for individual blob verification" } } diff --git a/specification/_json_spec/snapshot.restore.json b/specification/_json_spec/snapshot.restore.json index e521ac00be..280df5a9d6 100644 --- a/specification/_json_spec/snapshot.restore.json +++ b/specification/_json_spec/snapshot.restore.json @@ -31,6 +31,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "wait_for_completion": { diff --git a/specification/_json_spec/snapshot.status.json b/specification/_json_spec/snapshot.status.json index 477317b76d..d7b617ea6f 100644 --- a/specification/_json_spec/snapshot.status.json +++ b/specification/_json_spec/snapshot.status.json @@ -44,10 +44,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 8da0e72cf7..5155bd0b7a 100644 --- a/specification/_json_spec/snapshot.verify_repository.json +++ b/specification/_json_spec/snapshot.verify_repository.json @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "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 1b540296b1..c88c044076 100644 --- a/specification/_json_spec/streams.logs_disable.json +++ b/specification/_json_spec/streams.logs_disable.json @@ -21,10 +21,12 @@ "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": { "type": "time", + "default": "30s", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." } } diff --git a/specification/_json_spec/streams.logs_enable.json b/specification/_json_spec/streams.logs_enable.json index b6ce3af45f..f366ba7e4b 100644 --- a/specification/_json_spec/streams.logs_enable.json +++ b/specification/_json_spec/streams.logs_enable.json @@ -21,10 +21,12 @@ "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": { "type": "time", + "default": "30s", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error." } } 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/termvectors.json b/specification/_json_spec/termvectors.json index 4bf0734045..1d7f82d5b7 100644 --- a/specification/_json_spec/termvectors.json +++ b/specification/_json_spec/termvectors.json @@ -78,6 +78,7 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specifies if request is real-time as opposed to near-real-time (default: true)." }, "version": { diff --git a/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..539639e89e 100644 --- a/specification/_json_spec/transform.get_transform_stats.json +++ b/specification/_json_spec/transform.get_transform_stats.json @@ -26,10 +26,12 @@ "params": { "from": { "type": "number", + "default": 0, "description": "skips a number of transform stats, defaults to 0" }, "size": { "type": "number", + "default": 100, "description": "specifies a max number of transform stats to get, defaults to 100" }, "timeout": { @@ -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..1b532cc0aa 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", + "default": 0, "description": "Specify how many times should the operation be retried when a conflict occurs (default: 0)" }, "routing": { @@ -64,6 +69,7 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "if_seq_no": { @@ -76,10 +82,12 @@ }, "require_alias": { "type": "boolean", + "default": false, "description": "When true, requires destination is an alias. Default is false" }, "include_source_on_error": { "type": "boolean", + "default": true, "description": "True or false if to include the document source in the error message in case of parsing errors. Defaults to true." } }, diff --git a/specification/_json_spec/update_by_query.json b/specification/_json_spec/update_by_query.json index 226e59606c..89a943ee11 100644 --- a/specification/_json_spec/update_by_query.json +++ b/specification/_json_spec/update_by_query.json @@ -31,6 +31,7 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "default_operator": { @@ -45,14 +46,17 @@ }, "from": { "type": "number", + "default": 0, "description": "Starting offset (default: 0)" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "conflicts": { @@ -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": { @@ -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, + "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": { 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.get_settings.json b/specification/_json_spec/watcher.get_settings.json index bb78f18e7c..8e68f9bc41 100644 --- a/specification/_json_spec/watcher.get_settings.json +++ b/specification/_json_spec/watcher.get_settings.json @@ -21,6 +21,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/watcher.put_watch.json b/specification/_json_spec/watcher.put_watch.json index c9c5489c1d..bed2703dba 100644 --- a/specification/_json_spec/watcher.put_watch.json +++ b/specification/_json_spec/watcher.put_watch.json @@ -27,6 +27,7 @@ "params": { "active": { "type": "boolean", + "default": true, "description": "Specify whether the watch is in/active by default" }, "version": { diff --git a/specification/_json_spec/watcher.start.json b/specification/_json_spec/watcher.start.json index 0f681724ec..3e85fb7ad0 100644 --- a/specification/_json_spec/watcher.start.json +++ b/specification/_json_spec/watcher.start.json @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } 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" } } diff --git a/specification/_json_spec/watcher.stop.json b/specification/_json_spec/watcher.stop.json index d9681656c1..b0c379ccf3 100644 --- a/specification/_json_spec/watcher.stop.json +++ b/specification/_json_spec/watcher.stop.json @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/watcher.update_settings.json b/specification/_json_spec/watcher.update_settings.json index bccd0cc9ec..f23ac7ccf4 100644 --- a/specification/_json_spec/watcher.update_settings.json +++ b/specification/_json_spec/watcher.update_settings.json @@ -25,6 +25,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, diff --git a/specification/_json_spec/xpack.usage.json b/specification/_json_spec/xpack.usage.json index 48df8238d3..4fe4a77499 100644 --- a/specification/_json_spec/xpack.usage.json +++ b/specification/_json_spec/xpack.usage.json @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for watch write operation" } }