From 6db9c2841ef0560c2d54debc717cdef48ea2958e Mon Sep 17 00:00:00 2001 From: pquentin <42327+pquentin@users.noreply.github.com> Date: Sat, 11 Oct 2025 04:06:52 +0000 Subject: [PATCH] Update rest-api-spec --- output/schema/schema.json | 2 +- output/schema/validation-errors.json | 8 ++++-- .../_json_spec/async_search.status.json | 1 + .../_json_spec/async_search.submit.json | 4 ++- ...autoscaling.delete_autoscaling_policy.json | 1 + .../autoscaling.put_autoscaling_policy.json | 1 + specification/_json_spec/bulk.json | 11 ++++++-- specification/_json_spec/cat.allocation.json | 1 + .../_json_spec/cat.component_templates.json | 1 + specification/_json_spec/cat.master.json | 1 + .../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 | 1 + specification/_json_spec/cat.nodes.json | 2 ++ .../_json_spec/cat.pending_tasks.json | 1 + specification/_json_spec/cat.plugins.json | 1 + specification/_json_spec/cat.recovery.json | 1 + specification/_json_spec/cat.segments.json | 25 +++++++++++++++++++ specification/_json_spec/cat.snapshots.json | 1 + specification/_json_spec/cat.tasks.json | 1 + specification/_json_spec/cat.templates.json | 1 + specification/_json_spec/cat.thread_pool.json | 1 + specification/_json_spec/cat.transforms.json | 4 +++ .../_json_spec/ccr.follow_stats.json | 1 + .../_json_spec/ccr.forget_follower.json | 1 + specification/_json_spec/ccr.stats.json | 1 + specification/_json_spec/clear_scroll.json | 3 ++- .../_json_spec/close_point_in_time.json | 3 ++- .../cluster.allocation_explain.json | 5 +++- .../cluster.delete_component_template.json | 1 + .../cluster.exists_component_template.json | 1 + .../cluster.get_component_template.json | 3 +++ .../_json_spec/cluster.get_settings.json | 2 ++ specification/_json_spec/cluster.health.json | 5 ++++ .../_json_spec/cluster.pending_tasks.json | 1 + .../_json_spec/cluster.put_settings.json | 1 + specification/_json_spec/cluster.reroute.json | 8 +++++- specification/_json_spec/cluster.state.json | 4 +++ specification/_json_spec/cluster.stats.json | 1 + specification/_json_spec/count.json | 8 +++++- specification/_json_spec/create.json | 6 +++++ specification/_json_spec/delete.json | 3 +++ specification/_json_spec/delete_by_query.json | 11 ++++++-- specification/_json_spec/delete_script.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 | 5 +++- specification/_json_spec/field_caps.json | 5 +++- .../_json_spec/fleet.global_checkpoints.json | 4 +-- specification/_json_spec/fleet.search.json | 3 ++- specification/_json_spec/get.json | 2 ++ specification/_json_spec/get_source.json | 2 ++ specification/_json_spec/graph.explore.json | 3 ++- .../_json_spec/ilm.delete_lifecycle.json | 1 + .../_json_spec/ilm.get_lifecycle.json | 1 + .../_json_spec/ilm.migrate_to_data_tiers.json | 1 + .../_json_spec/ilm.move_to_step.json | 3 ++- .../_json_spec/ilm.put_lifecycle.json | 4 ++- specification/_json_spec/ilm.start.json | 1 + specification/_json_spec/ilm.stop.json | 1 + specification/_json_spec/index.json | 6 +++++ .../_json_spec/indices.add_block.json | 3 +++ specification/_json_spec/indices.analyze.json | 3 ++- .../_json_spec/indices.clear_cache.json | 2 ++ specification/_json_spec/indices.clone.json | 5 +++- specification/_json_spec/indices.close.json | 4 +++ specification/_json_spec/indices.create.json | 5 +++- .../indices.create_data_stream.json | 1 + specification/_json_spec/indices.delete.json | 3 +++ .../_json_spec/indices.delete_alias.json | 1 + .../indices.delete_index_template.json | 1 + .../_json_spec/indices.delete_template.json | 1 + .../_json_spec/indices.disk_usage.json | 4 +++ specification/_json_spec/indices.exists.json | 4 +++ .../_json_spec/indices.exists_alias.json | 2 ++ .../indices.exists_index_template.json | 2 ++ .../_json_spec/indices.exists_template.json | 2 ++ .../_json_spec/indices.field_usage_stats.json | 1 + specification/_json_spec/indices.flush.json | 4 +++ specification/_json_spec/indices.get.json | 4 +++ .../_json_spec/indices.get_alias.json | 2 ++ .../indices.get_data_lifecycle.json | 1 + .../_json_spec/indices.get_data_stream.json | 2 ++ .../_json_spec/indices.get_field_mapping.json | 3 +++ .../indices.get_index_template.json | 3 +++ .../_json_spec/indices.get_mapping.json | 3 +++ .../_json_spec/indices.get_settings.json | 4 +++ .../_json_spec/indices.get_template.json | 2 ++ .../indices.migrate_to_data_stream.json | 1 + specification/_json_spec/indices.open.json | 4 +++ .../_json_spec/indices.put_alias.json | 1 + .../indices.put_data_lifecycle.json | 4 ++- .../indices.put_data_stream_options.json | 4 ++- .../indices.put_data_stream_settings.json | 4 +-- .../indices.put_index_template.json | 2 +- .../_json_spec/indices.put_mapping.json | 3 +++ .../_json_spec/indices.put_settings.json | 6 +++++ specification/_json_spec/indices.refresh.json | 2 ++ .../_json_spec/indices.resolve_cluster.json | 3 +++ .../_json_spec/indices.rollover.json | 8 ++++-- .../_json_spec/indices.segments.json | 2 ++ .../_json_spec/indices.shard_stores.json | 1 + specification/_json_spec/indices.shrink.json | 5 +++- .../indices.simulate_index_template.json | 3 ++- .../_json_spec/indices.simulate_template.json | 3 ++- specification/_json_spec/indices.split.json | 5 +++- .../_json_spec/indices.unfreeze.json | 3 +++ .../_json_spec/indices.update_aliases.json | 1 + .../_json_spec/indices.validate_query.json | 10 +++++++- .../inference.chat_completion_unified.json | 3 ++- .../_json_spec/inference.completion.json | 3 ++- .../_json_spec/inference.delete.json | 2 ++ .../_json_spec/inference.inference.json | 3 ++- specification/_json_spec/inference.put.json | 3 ++- .../inference.put_alibabacloud.json | 3 ++- .../inference.put_amazonbedrock.json | 3 ++- .../inference.put_amazonsagemaker.json | 3 ++- .../_json_spec/inference.put_anthropic.json | 3 ++- .../inference.put_azureaistudio.json | 3 ++- .../_json_spec/inference.put_azureopenai.json | 3 ++- .../_json_spec/inference.put_cohere.json | 3 ++- .../_json_spec/inference.put_custom.json | 3 ++- .../_json_spec/inference.put_deepseek.json | 3 ++- .../inference.put_elasticsearch.json | 3 ++- .../_json_spec/inference.put_elser.json | 3 ++- .../inference.put_googleaistudio.json | 3 ++- .../inference.put_googlevertexai.json | 3 ++- .../inference.put_hugging_face.json | 3 ++- .../_json_spec/inference.put_jinaai.json | 3 ++- .../_json_spec/inference.put_mistral.json | 3 ++- .../_json_spec/inference.put_openai.json | 3 ++- .../_json_spec/inference.put_voyageai.json | 3 ++- .../_json_spec/inference.put_watsonx.json | 3 ++- .../_json_spec/inference.rerank.json | 3 ++- .../inference.sparse_embedding.json | 3 ++- .../inference.stream_completion.json | 3 ++- .../_json_spec/inference.text_embedding.json | 3 ++- .../_json_spec/inference.update.json | 3 ++- .../ingest.delete_geoip_database.json | 1 + .../ingest.delete_ip_location_database.json | 1 + .../_json_spec/ingest.delete_pipeline.json | 1 + .../_json_spec/ingest.get_pipeline.json | 1 + .../_json_spec/ingest.put_geoip_database.json | 1 + .../ingest.put_ip_location_database.json | 1 + .../_json_spec/ingest.put_pipeline.json | 1 + specification/_json_spec/knn_search.json | 3 ++- specification/_json_spec/license.delete.json | 1 + specification/_json_spec/license.get.json | 6 +++-- specification/_json_spec/license.post.json | 5 +++- .../_json_spec/license.post_start_basic.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 | 4 ++- .../_json_spec/ml.delete_forecast.json | 2 ++ specification/_json_spec/ml.flush_job.json | 3 ++- specification/_json_spec/ml.forecast.json | 3 +++ specification/_json_spec/ml.get_buckets.json | 12 ++++++++- .../_json_spec/ml.get_calendar_events.json | 2 ++ .../_json_spec/ml.get_calendars.json | 5 +++- .../_json_spec/ml.get_categories.json | 5 +++- specification/_json_spec/ml.get_filters.json | 2 ++ .../_json_spec/ml.get_influencers.json | 10 +++++++- .../_json_spec/ml.get_job_stats.json | 1 + specification/_json_spec/ml.get_jobs.json | 1 + .../_json_spec/ml.get_memory_stats.json | 1 + .../_json_spec/ml.get_model_snapshots.json | 6 ++++- .../_json_spec/ml.get_overall_buckets.json | 6 ++++- specification/_json_spec/ml.get_records.json | 11 +++++++- 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 | 4 ++- .../_json_spec/ml.set_upgrade_mode.json | 2 ++ .../ml.start_data_frame_analytics.json | 4 ++- .../_json_spec/ml.start_datafeed.json | 4 ++- .../ml.stop_data_frame_analytics.json | 6 ++++- .../_json_spec/ml.stop_datafeed.json | 3 +++ .../ml.stop_trained_model_deployment.json | 5 +++- .../_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 | 5 +++- specification/_json_spec/put_script.json | 1 + specification/_json_spec/rank_eval.json | 2 ++ specification/_json_spec/reindex.json | 4 ++- .../_json_spec/render_search_template.json | 3 ++- specification/_json_spec/rollup.stop_job.json | 2 ++ .../_json_spec/scripts_painless_execute.json | 3 ++- specification/_json_spec/scroll.json | 4 ++- specification/_json_spec/search.json | 19 ++++++++++++-- .../_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 | 3 +++ specification/_json_spec/search_template.json | 6 +++++ .../searchable_snapshots.clear_cache.json | 2 +- .../searchable_snapshots.mount.json | 2 +- .../security.disable_user_profile.json | 1 + .../security.enable_user_profile.json | 1 + .../_json_spec/security.grant_api_key.json | 1 + .../_json_spec/security.put_user.json | 1 + .../security.update_user_profile_data.json | 1 + .../_json_spec/shutdown.delete_node.json | 1 + .../_json_spec/shutdown.put_node.json | 1 + .../_json_spec/slm.delete_lifecycle.json | 1 + .../_json_spec/slm.execute_lifecycle.json | 1 + .../_json_spec/slm.execute_retention.json | 1 + .../_json_spec/slm.get_lifecycle.json | 1 + specification/_json_spec/slm.get_stats.json | 1 + specification/_json_spec/slm.get_status.json | 1 + .../_json_spec/slm.put_lifecycle.json | 4 ++- specification/_json_spec/slm.start.json | 1 + specification/_json_spec/slm.stop.json | 1 + .../snapshot.cleanup_repository.json | 1 + .../snapshot.create_repository.json | 2 ++ .../snapshot.delete_repository.json | 1 + specification/_json_spec/snapshot.get.json | 7 ++++++ .../_json_spec/snapshot.get_repository.json | 1 + .../snapshot.repository_analyze.json | 11 ++++++++ .../snapshot.repository_verify_integrity.json | 8 ++++++ specification/_json_spec/snapshot.status.json | 1 + .../snapshot.verify_repository.json | 1 + .../_json_spec/streams.logs_disable.json | 1 + .../_json_spec/streams.logs_enable.json | 1 + specification/_json_spec/streams.status.json | 8 +++++- specification/_json_spec/tasks.cancel.json | 1 + specification/_json_spec/tasks.get.json | 2 ++ specification/_json_spec/tasks.list.json | 3 +++ specification/_json_spec/terms_enum.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 | 15 ++++++++--- .../update_by_query_rethrottle.json | 1 + .../_json_spec/watcher.execute_watch.json | 1 + .../_json_spec/watcher.put_watch.json | 1 + specification/_json_spec/watcher.stats.json | 1 + 266 files changed, 693 insertions(+), 102 deletions(-) diff --git a/output/schema/schema.json b/output/schema/schema.json index 58d4a2df82..943c6c6c64 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -8318,7 +8318,7 @@ "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", "name": "indices.put_data_stream_options", "request": null, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index 2b5286b6e9..6dfa117230 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -1,8 +1,12 @@ { "endpointErrors": { - "streams.status": { + "cat.segments": { "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec" + "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": [] } diff --git a/specification/_json_spec/async_search.status.json b/specification/_json_spec/async_search.status.json index ce7e974ec1..dd0f095396 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 4505401512..bf40f9cf1d 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": { @@ -218,7 +219,8 @@ } }, "body": { - "description": "The search definition using the Query DSL" + "description": "The search definition using the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/autoscaling.delete_autoscaling_policy.json b/specification/_json_spec/autoscaling.delete_autoscaling_policy.json index a9fb4a6ee2..5aeef3b32d 100644 --- a/specification/_json_spec/autoscaling.delete_autoscaling_policy.json +++ b/specification/_json_spec/autoscaling.delete_autoscaling_policy.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/specification/_json_spec/autoscaling.put_autoscaling_policy.json b/specification/_json_spec/autoscaling.put_autoscaling_policy.json index f78413ec6d..eb4c74d4fa 100644 --- a/specification/_json_spec/autoscaling.put_autoscaling_policy.json +++ b/specification/_json_spec/autoscaling.put_autoscaling_policy.json @@ -32,6 +32,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } }, diff --git a/specification/_json_spec/bulk.json b/specification/_json_spec/bulk.json index e5a0fd4c8f..1020ff2a3f 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", - "description": "Sets require_alias for all incoming documents. Defaults to unset (false)" + "default": false, + "description": "If true, the request's actions must target an index alias. Defaults to false." }, "require_data_stream": { "type": "boolean", - "description": "When true, requires the destination to be a data stream (existing or to-be-created). Default is false" + "default": false, + "description": "If true, the request's actions must target a data stream (existing or to-be-created). Default to false" }, "list_executed_pipelines": { "type": "boolean", + "default": false, "description": "Sets list_executed_pipelines for all incoming documents. Defaults to unset (false)" }, "include_source_on_error": { "type": "boolean", + "default": true, "description": "True or false if to include the document source in the error message in case of parsing errors. Defaults to true." } }, diff --git a/specification/_json_spec/cat.allocation.json b/specification/_json_spec/cat.allocation.json index 548f38d2fb..82c84032de 100644 --- a/specification/_json_spec/cat.allocation.json +++ b/specification/_json_spec/cat.allocation.json @@ -45,6 +45,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/specification/_json_spec/cat.component_templates.json b/specification/_json_spec/cat.component_templates.json index 925920081b..d4a23db0f0 100644 --- a/specification/_json_spec/cat.component_templates.json +++ b/specification/_json_spec/cat.component_templates.json @@ -35,6 +35,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/specification/_json_spec/cat.master.json b/specification/_json_spec/cat.master.json index cb21cf2010..3c7d3ba86b 100644 --- a/specification/_json_spec/cat.master.json +++ b/specification/_json_spec/cat.master.json @@ -25,6 +25,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/specification/_json_spec/cat.ml_data_frame_analytics.json b/specification/_json_spec/cat.ml_data_frame_analytics.json index 278d88c807..caa652ffd5 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 83f7a801e0..6da2465e09 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 48f04244a4..4681e15e13 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 b2ebc6d85a..277e626828 100644 --- a/specification/_json_spec/cat.nodeattrs.json +++ b/specification/_json_spec/cat.nodeattrs.json @@ -25,6 +25,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/specification/_json_spec/cat.nodes.json b/specification/_json_spec/cat.nodes.json index d145cbe019..1a3b280462 100644 --- a/specification/_json_spec/cat.nodes.json +++ b/specification/_json_spec/cat.nodes.json @@ -30,6 +30,7 @@ }, "full_id": { "type": "boolean", + "default": false, "description": "Return the full node ID instead of the shortened version (default: false)" }, "master_timeout": { @@ -39,6 +40,7 @@ }, "h": { "type": "list", + "default": "ip,hp,rp,r,m,n,cpu,l", "description": "Comma-separated list of column names to display" }, "help": { diff --git a/specification/_json_spec/cat.pending_tasks.json b/specification/_json_spec/cat.pending_tasks.json index 59864b2f70..4a05af2dc8 100644 --- a/specification/_json_spec/cat.pending_tasks.json +++ b/specification/_json_spec/cat.pending_tasks.json @@ -25,6 +25,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/specification/_json_spec/cat.plugins.json b/specification/_json_spec/cat.plugins.json index 775439ddf9..19744e73a2 100644 --- a/specification/_json_spec/cat.plugins.json +++ b/specification/_json_spec/cat.plugins.json @@ -25,6 +25,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/specification/_json_spec/cat.recovery.json b/specification/_json_spec/cat.recovery.json index 2f8f621de3..589ad1bca0 100644 --- a/specification/_json_spec/cat.recovery.json +++ b/specification/_json_spec/cat.recovery.json @@ -50,6 +50,7 @@ }, "h": { "type": "list", + "default": "ip,hp,rp,r,m,n,cpu,l", "description": "Comma-separated list of column names to display" }, "help": { diff --git a/specification/_json_spec/cat.segments.json b/specification/_json_spec/cat.segments.json index f139903c87..18e3225d81 100644 --- a/specification/_json_spec/cat.segments.json +++ b/specification/_json_spec/cat.segments.json @@ -35,6 +35,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { @@ -49,6 +50,7 @@ }, "h": { "type": "list", + "default": "ip,hp,rp,r,m,n,cpu,l", "description": "Comma-separated list of column names to display" }, "help": { @@ -69,6 +71,29 @@ "type": "enum", "description": "The unit in which to display time values", "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] + }, + "ignore_unavailable": { + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed). Only allowed when providing an index expression." + }, + "ignore_throttled": { + "type": "boolean", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled. Only allowed when providing an index expression." + }, + "allow_no_indices": { + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). Only allowed when providing an index expression." + }, + "expand_wildcards": { + "type": "enum", + "options": ["open", "closed", "hidden", "none", "all"], + "default": "open", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both." + }, + "allow_closed": { + "type": "boolean", + "description": "If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour of throwing an exception if index pattern matches closed indices", + "default": false } } } diff --git a/specification/_json_spec/cat.snapshots.json b/specification/_json_spec/cat.snapshots.json index 66eb67fa31..9e7f0796fb 100644 --- a/specification/_json_spec/cat.snapshots.json +++ b/specification/_json_spec/cat.snapshots.json @@ -45,6 +45,7 @@ }, "h": { "type": "list", + "default": "ip,hp,rp,r,m,n,cpu,l", "description": "Comma-separated list of column names to display" }, "help": { diff --git a/specification/_json_spec/cat.tasks.json b/specification/_json_spec/cat.tasks.json index 099e18dfc2..a8eb2bff69 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 f4cabeaa20..466de472e2 100644 --- a/specification/_json_spec/cat.templates.json +++ b/specification/_json_spec/cat.templates.json @@ -35,6 +35,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/specification/_json_spec/cat.thread_pool.json b/specification/_json_spec/cat.thread_pool.json index eac207917e..40042f6f44 100644 --- a/specification/_json_spec/cat.thread_pool.json +++ b/specification/_json_spec/cat.thread_pool.json @@ -40,6 +40,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/specification/_json_spec/cat.transforms.json b/specification/_json_spec/cat.transforms.json index 079b177072..1e2f0365f4 100644 --- a/specification/_json_spec/cat.transforms.json +++ b/specification/_json_spec/cat.transforms.json @@ -30,14 +30,17 @@ "params": { "from": { "type": "int", + "default": 0, "description": "skips a number of transform configs, defaults to 0" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of transforms to get, defaults to 100" }, "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)" }, "format": { @@ -47,6 +50,7 @@ }, "h": { "type": "list", + "default": "changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state", "description": "Comma-separated list of column names to display" }, "help": { diff --git a/specification/_json_spec/ccr.follow_stats.json b/specification/_json_spec/ccr.follow_stats.json index ea67efad38..c1dfff1dff 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 fd8de79b7c..6366ce55fd 100644 --- a/specification/_json_spec/ccr.forget_follower.json +++ b/specification/_json_spec/ccr.forget_follower.json @@ -27,6 +27,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/ccr.stats.json b/specification/_json_spec/ccr.stats.json index 6660717b7e..fdba741056 100644 --- a/specification/_json_spec/ccr.stats.json +++ b/specification/_json_spec/ccr.stats.json @@ -20,6 +20,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/specification/_json_spec/clear_scroll.json b/specification/_json_spec/clear_scroll.json index ce19b19c00..65abe37643 100644 --- a/specification/_json_spec/clear_scroll.json +++ b/specification/_json_spec/clear_scroll.json @@ -35,7 +35,8 @@ }, "params": {}, "body": { - "description": "A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter" + "description": "A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter", + "required": false } } } diff --git a/specification/_json_spec/close_point_in_time.json b/specification/_json_spec/close_point_in_time.json index a93d7c435f..ab0b29fde7 100644 --- a/specification/_json_spec/close_point_in_time.json +++ b/specification/_json_spec/close_point_in_time.json @@ -20,7 +20,8 @@ }, "params": {}, "body": { - "description": "a point-in-time id to close" + "description": "a point-in-time id to close", + "required": true } } } diff --git a/specification/_json_spec/cluster.allocation_explain.json b/specification/_json_spec/cluster.allocation_explain.json index 0560e6e20e..4f0e5d6a59 100644 --- a/specification/_json_spec/cluster.allocation_explain.json +++ b/specification/_json_spec/cluster.allocation_explain.json @@ -26,15 +26,18 @@ }, "include_yes_decisions": { "type": "boolean", + "default": false, "description": "Return 'YES' decisions in explanation (default: false)" }, "include_disk_info": { "type": "boolean", + "default": false, "description": "Return information about disk usage and shard sizes (default: false)" } }, "body": { - "description": "The index, shard, and primary flag to explain. Empty means 'explain a randomly-chosen unassigned shard'" + "description": "The index, shard, and primary flag to explain. Empty means 'explain a randomly-chosen unassigned shard'", + "required": false } } } diff --git a/specification/_json_spec/cluster.delete_component_template.json b/specification/_json_spec/cluster.delete_component_template.json index 0e52711105..c650e0ef10 100644 --- a/specification/_json_spec/cluster.delete_component_template.json +++ b/specification/_json_spec/cluster.delete_component_template.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/specification/_json_spec/cluster.exists_component_template.json b/specification/_json_spec/cluster.exists_component_template.json index 178f13b4f3..0acac7b7cc 100644 --- a/specification/_json_spec/cluster.exists_component_template.json +++ b/specification/_json_spec/cluster.exists_component_template.json @@ -31,6 +31,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/specification/_json_spec/cluster.get_component_template.json b/specification/_json_spec/cluster.get_component_template.json index 5b7a2fdb5f..6297a622ab 100644 --- a/specification/_json_spec/cluster.get_component_template.json +++ b/specification/_json_spec/cluster.get_component_template.json @@ -35,14 +35,17 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all default configurations for the component template (default: false)" }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "settings_filter": { diff --git a/specification/_json_spec/cluster.get_settings.json b/specification/_json_spec/cluster.get_settings.json index b50588608f..26fb6d69f1 100644 --- a/specification/_json_spec/cluster.get_settings.json +++ b/specification/_json_spec/cluster.get_settings.json @@ -20,6 +20,7 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { @@ -29,6 +30,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "include_defaults": { diff --git a/specification/_json_spec/cluster.health.json b/specification/_json_spec/cluster.health.json index d75452cb4e..6b2ea60e1e 100644 --- a/specification/_json_spec/cluster.health.json +++ b/specification/_json_spec/cluster.health.json @@ -42,6 +42,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { @@ -51,10 +52,12 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "wait_for_active_shards": { "type": "string", + "default": "0", "description": "Wait until the specified number of shards is active" }, "wait_for_nodes": { @@ -68,10 +71,12 @@ }, "wait_for_no_relocating_shards": { "type": "boolean", + "default": false, "description": "Whether to wait until there are no relocating shards in the cluster" }, "wait_for_no_initializing_shards": { "type": "boolean", + "default": false, "description": "Whether to wait until there are no initializing shards in the cluster" }, "wait_for_status": { diff --git a/specification/_json_spec/cluster.pending_tasks.json b/specification/_json_spec/cluster.pending_tasks.json index 144c9a3cd6..b37db41c7b 100644 --- a/specification/_json_spec/cluster.pending_tasks.json +++ b/specification/_json_spec/cluster.pending_tasks.json @@ -20,6 +20,7 @@ "params": { "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { diff --git a/specification/_json_spec/cluster.put_settings.json b/specification/_json_spec/cluster.put_settings.json index f5588bb79e..bae15966b9 100644 --- a/specification/_json_spec/cluster.put_settings.json +++ b/specification/_json_spec/cluster.put_settings.json @@ -30,6 +30,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/cluster.reroute.json b/specification/_json_spec/cluster.reroute.json index 475be4e9b1..26314372c0 100644 --- a/specification/_json_spec/cluster.reroute.json +++ b/specification/_json_spec/cluster.reroute.json @@ -21,14 +21,17 @@ "params": { "dry_run": { "type": "boolean", + "default": false, "description": "Simulate the operation only and return the resulting state" }, "explain": { "type": "boolean", + "default": false, "description": "Return an explanation of why the commands can or cannot be executed" }, "retry_failed": { "type": "boolean", + "default": false, "description": "Retries allocation of shards that are blocked due to too many subsequent allocation failures" }, "metric": { @@ -43,6 +46,7 @@ "master_node", "version" ], + "default": "all", "description": "Limit the information returned to the specified metrics. Defaults to all but metadata" }, "master_timeout": { @@ -52,11 +56,13 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, "body": { - "description": "The definition of `commands` to perform (`move`, `cancel`, `allocate`)" + "description": "The definition of `commands` to perform (`move`, `cancel`, `allocate`)", + "required": false } } } diff --git a/specification/_json_spec/cluster.state.json b/specification/_json_spec/cluster.state.json index fb57cd5cd2..6cdf2d0b1e 100644 --- a/specification/_json_spec/cluster.state.json +++ b/specification/_json_spec/cluster.state.json @@ -64,6 +64,7 @@ "params": { "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { @@ -73,6 +74,7 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "wait_for_metadata_version": { @@ -85,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 2c5ac29d78..3b37a412c3 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 ecea90b69f..12c3255aba 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": { @@ -91,7 +96,8 @@ } }, "body": { - "description": "A query to restrict the results specified with the Query DSL (optional)" + "description": "A query to restrict the results specified with the Query DSL (optional)", + "required": false } } } diff --git a/specification/_json_spec/create.json b/specification/_json_spec/create.json index 2d078dcbdb..e6d498ed80 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/delete.json b/specification/_json_spec/delete.json index bd810d50c8..c814c33107 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 69d8254131..448509cd55 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 259ac2d027..06e7cdc819 100644 --- a/specification/_json_spec/delete_script.json +++ b/specification/_json_spec/delete_script.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/specification/_json_spec/eql.search.json b/specification/_json_spec/eql.search.json index 993bb6a9e2..898ff7108e 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 8b9d27d9e1..809d8dbd05 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 3730f49bd8..05f942f31f 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 77590d43b6..f52b578495 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 d598533ee0..66dd54b5a3 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 7a6c70974a..619837ea4f 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 e2e43e7ea6..f015b30317 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": { @@ -81,7 +83,8 @@ } }, "body": { - "description": "The query definition using the Query DSL" + "description": "The query definition using the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/field_caps.json b/specification/_json_spec/field_caps.json index 6267c5f225..83bf2369df 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": { @@ -67,7 +69,8 @@ } }, "body": { - "description": "An index filter specified with the Query DSL" + "description": "An index filter specified with the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/fleet.global_checkpoints.json b/specification/_json_spec/fleet.global_checkpoints.json index 5cdecb2637..da15c0548b 100644 --- a/specification/_json_spec/fleet.global_checkpoints.json +++ b/specification/_json_spec/fleet.global_checkpoints.json @@ -28,12 +28,12 @@ "wait_for_advance": { "type": "boolean", "description": "Whether to wait for the global checkpoint to advance past the specified current checkpoints", - "default": "false" + "default": false }, "wait_for_index": { "type": "boolean", "description": "Whether to wait for the target index to exist and all primary shards be active", - "default": "false" + "default": false }, "checkpoints": { "type": "list", diff --git a/specification/_json_spec/fleet.search.json b/specification/_json_spec/fleet.search.json index 682aed4388..7071111656 100644 --- a/specification/_json_spec/fleet.search.json +++ b/specification/_json_spec/fleet.search.json @@ -41,7 +41,8 @@ } }, "body": { - "description": "The search definition using the Query DSL" + "description": "The search definition using the Query DSL", + "required": true } } } diff --git a/specification/_json_spec/get.json b/specification/_json_spec/get.json index 09eec6f1f4..00163c2033 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_source.json b/specification/_json_spec/get_source.json index caac938891..cb84ce5216 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/graph.explore.json b/specification/_json_spec/graph.explore.json index c35fed6106..d2e603dc9f 100644 --- a/specification/_json_spec/graph.explore.json +++ b/specification/_json_spec/graph.explore.json @@ -35,7 +35,8 @@ } }, "body": { - "description": "Graph Query DSL" + "description": "Graph Query DSL", + "required": true } } } diff --git a/specification/_json_spec/ilm.delete_lifecycle.json b/specification/_json_spec/ilm.delete_lifecycle.json index 8c29946cd2..475f7b6ac2 100644 --- a/specification/_json_spec/ilm.delete_lifecycle.json +++ b/specification/_json_spec/ilm.delete_lifecycle.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ilm.get_lifecycle.json b/specification/_json_spec/ilm.get_lifecycle.json index 0b9bf496ac..a1a1197b45 100644 --- a/specification/_json_spec/ilm.get_lifecycle.json +++ b/specification/_json_spec/ilm.get_lifecycle.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ilm.migrate_to_data_tiers.json b/specification/_json_spec/ilm.migrate_to_data_tiers.json index bf03fdf455..dec1c1a60c 100644 --- a/specification/_json_spec/ilm.migrate_to_data_tiers.json +++ b/specification/_json_spec/ilm.migrate_to_data_tiers.json @@ -21,6 +21,7 @@ "params": { "dry_run": { "type": "boolean", + "default": false, "description": "If set to true it will simulate the migration, providing a way to retrieve the ILM policies and indices that need to be migrated. The default is false" } }, diff --git a/specification/_json_spec/ilm.move_to_step.json b/specification/_json_spec/ilm.move_to_step.json index 64737f0b00..7d84b8f6dc 100644 --- a/specification/_json_spec/ilm.move_to_step.json +++ b/specification/_json_spec/ilm.move_to_step.json @@ -26,7 +26,8 @@ }, "params": {}, "body": { - "description": "The new lifecycle step to move to" + "description": "The new lifecycle step to move to", + "required": true } } } diff --git a/specification/_json_spec/ilm.put_lifecycle.json b/specification/_json_spec/ilm.put_lifecycle.json index e4cca128e5..42e81a57f5 100644 --- a/specification/_json_spec/ilm.put_lifecycle.json +++ b/specification/_json_spec/ilm.put_lifecycle.json @@ -32,11 +32,13 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, "body": { - "description": "The lifecycle policy definition to register" + "description": "The lifecycle policy definition to register", + "required": true } } } diff --git a/specification/_json_spec/ilm.start.json b/specification/_json_spec/ilm.start.json index 9a298fc604..aac8753be1 100644 --- a/specification/_json_spec/ilm.start.json +++ b/specification/_json_spec/ilm.start.json @@ -25,6 +25,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ilm.stop.json b/specification/_json_spec/ilm.stop.json index a06bc799c1..03a426c6fe 100644 --- a/specification/_json_spec/ilm.stop.json +++ b/specification/_json_spec/ilm.stop.json @@ -25,6 +25,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/index.json b/specification/_json_spec/index.json index 29dec6ca0d..afaed09b28 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 4db39e2fa6..4f390cda79 100644 --- a/specification/_json_spec/indices.add_block.json +++ b/specification/_json_spec/indices.add_block.json @@ -30,6 +30,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -39,10 +40,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/specification/_json_spec/indices.analyze.json b/specification/_json_spec/indices.analyze.json index e36306f8c9..7b1afb019a 100644 --- a/specification/_json_spec/indices.analyze.json +++ b/specification/_json_spec/indices.analyze.json @@ -35,7 +35,8 @@ } }, "body": { - "description": "Define analyzer/tokenizer parameters and the text on which the analysis should be performed" + "description": "Define analyzer/tokenizer parameters and the text on which the analysis should be performed", + "required": true } } } diff --git a/specification/_json_spec/indices.clear_cache.json b/specification/_json_spec/indices.clear_cache.json index 25c017f8d0..c6fd538d61 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 0fea968cb2..526746006b 100644 --- a/specification/_json_spec/indices.clone.json +++ b/specification/_json_spec/indices.clone.json @@ -31,6 +31,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -40,11 +41,13 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for on the cloned index before the operation returns." } }, "body": { - "description": "The configuration for the target index (`settings` and `aliases`)" + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": false } } } diff --git a/specification/_json_spec/indices.close.json b/specification/_json_spec/indices.close.json index 9ab13ad428..3dba2b2787 100644 --- a/specification/_json_spec/indices.close.json +++ b/specification/_json_spec/indices.close.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -35,10 +36,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { @@ -49,6 +52,7 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of active shards to wait for before the operation returns." } } diff --git a/specification/_json_spec/indices.create.json b/specification/_json_spec/indices.create.json index 16cf15914a..340c111810 100644 --- a/specification/_json_spec/indices.create.json +++ b/specification/_json_spec/indices.create.json @@ -27,10 +27,12 @@ "params": { "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for before the operation returns." }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -40,7 +42,8 @@ } }, "body": { - "description": "The configuration for the index (`settings` and `mappings`)" + "description": "The configuration for the index (`settings` and `mappings`)", + "required": false } } } diff --git a/specification/_json_spec/indices.create_data_stream.json b/specification/_json_spec/indices.create_data_stream.json index 006eaca94f..2192d8d9b8 100644 --- a/specification/_json_spec/indices.create_data_stream.json +++ b/specification/_json_spec/indices.create_data_stream.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for acknowledging the cluster state update" }, "master_timeout": { diff --git a/specification/_json_spec/indices.delete.json b/specification/_json_spec/indices.delete.json index 2484b67a30..f62ae51eaa 100644 --- a/specification/_json_spec/indices.delete.json +++ b/specification/_json_spec/indices.delete.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -35,10 +36,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Ignore unavailable indexes (default: false)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Ignore if a wildcard expression resolves to no concrete indices (default: false)" }, "expand_wildcards": { diff --git a/specification/_json_spec/indices.delete_alias.json b/specification/_json_spec/indices.delete_alias.json index c19a65bbd9..8325952fbd 100644 --- a/specification/_json_spec/indices.delete_alias.json +++ b/specification/_json_spec/indices.delete_alias.json @@ -44,6 +44,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { diff --git a/specification/_json_spec/indices.delete_index_template.json b/specification/_json_spec/indices.delete_index_template.json index 6a87657485..25765f1982 100644 --- a/specification/_json_spec/indices.delete_index_template.json +++ b/specification/_json_spec/indices.delete_index_template.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/specification/_json_spec/indices.delete_template.json b/specification/_json_spec/indices.delete_template.json index 4e7b4240c4..b1f8cead36 100644 --- a/specification/_json_spec/indices.delete_template.json +++ b/specification/_json_spec/indices.delete_template.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/specification/_json_spec/indices.disk_usage.json b/specification/_json_spec/indices.disk_usage.json index 2c5a03acd4..470dd45595 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 7df041b88a..d5be4fd510 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 40e8b64658..f93b314161 100644 --- a/specification/_json_spec/indices.exists_alias.json +++ b/specification/_json_spec/indices.exists_alias.json @@ -40,10 +40,12 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/specification/_json_spec/indices.exists_index_template.json b/specification/_json_spec/indices.exists_index_template.json index da726aabd1..1f737a90c1 100644 --- a/specification/_json_spec/indices.exists_index_template.json +++ b/specification/_json_spec/indices.exists_index_template.json @@ -26,6 +26,7 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { @@ -35,6 +36,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/specification/_json_spec/indices.exists_template.json b/specification/_json_spec/indices.exists_template.json index 6c57eb1cbe..339c776a12 100644 --- a/specification/_json_spec/indices.exists_template.json +++ b/specification/_json_spec/indices.exists_template.json @@ -26,6 +26,7 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { @@ -35,6 +36,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/specification/_json_spec/indices.field_usage_stats.json b/specification/_json_spec/indices.field_usage_stats.json index 97814f6218..20add739c6 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 60f051acac..b135a0167f 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 ae2f5f4f7f..2064c173e3 100644 --- a/specification/_json_spec/indices.get.json +++ b/specification/_json_spec/indices.get.json @@ -26,14 +26,17 @@ "params": { "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Ignore unavailable indexes (default: false)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Ignore if a wildcard expression resolves to no concrete indices (default: false)" }, "expand_wildcards": { @@ -50,6 +53,7 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "include_defaults": { diff --git a/specification/_json_spec/indices.get_alias.json b/specification/_json_spec/indices.get_alias.json index 5a1471adeb..a814cdd48a 100644 --- a/specification/_json_spec/indices.get_alias.json +++ b/specification/_json_spec/indices.get_alias.json @@ -54,10 +54,12 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/specification/_json_spec/indices.get_data_lifecycle.json b/specification/_json_spec/indices.get_data_lifecycle.json index c84638464d..5c103d3c4b 100644 --- a/specification/_json_spec/indices.get_data_lifecycle.json +++ b/specification/_json_spec/indices.get_data_lifecycle.json @@ -32,6 +32,7 @@ }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for the data stream (default: false)" }, "master_timeout": { diff --git a/specification/_json_spec/indices.get_data_stream.json b/specification/_json_spec/indices.get_data_stream.json index 3a9094e970..bafc6b2796 100644 --- a/specification/_json_spec/indices.get_data_stream.json +++ b/specification/_json_spec/indices.get_data_stream.json @@ -36,6 +36,7 @@ }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for the data stream (default: false)" }, "master_timeout": { @@ -45,6 +46,7 @@ }, "verbose": { "type": "boolean", + "default": false, "description": "Whether the maximum timestamp for each data stream should be calculated and returned (default: false)" } } diff --git a/specification/_json_spec/indices.get_field_mapping.json b/specification/_json_spec/indices.get_field_mapping.json index dd0f5e3682..dd99474ae4 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 6a217ee9d9..91d8c67a23 100644 --- a/specification/_json_spec/indices.get_index_template.json +++ b/specification/_json_spec/indices.get_index_template.json @@ -30,6 +30,7 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { @@ -39,10 +40,12 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for the index template (default: false)" } } diff --git a/specification/_json_spec/indices.get_mapping.json b/specification/_json_spec/indices.get_mapping.json index 11f00a744b..00ffe33ef6 100644 --- a/specification/_json_spec/indices.get_mapping.json +++ b/specification/_json_spec/indices.get_mapping.json @@ -30,10 +30,12 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { @@ -49,6 +51,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)", "deprecated": { "version": "7.8.0", diff --git a/specification/_json_spec/indices.get_settings.json b/specification/_json_spec/indices.get_settings.json index ae91f7dbb9..f2a6638813 100644 --- a/specification/_json_spec/indices.get_settings.json +++ b/specification/_json_spec/indices.get_settings.json @@ -59,10 +59,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { @@ -73,10 +75,12 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "include_defaults": { diff --git a/specification/_json_spec/indices.get_template.json b/specification/_json_spec/indices.get_template.json index 25fbd33b14..89add1d8c3 100644 --- a/specification/_json_spec/indices.get_template.json +++ b/specification/_json_spec/indices.get_template.json @@ -30,6 +30,7 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { @@ -39,6 +40,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/specification/_json_spec/indices.migrate_to_data_stream.json b/specification/_json_spec/indices.migrate_to_data_stream.json index 4dce099f55..cb71ea89cd 100644 --- a/specification/_json_spec/indices.migrate_to_data_stream.json +++ b/specification/_json_spec/indices.migrate_to_data_stream.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for acknowledging the cluster state update" }, "master_timeout": { diff --git a/specification/_json_spec/indices.open.json b/specification/_json_spec/indices.open.json index feb80d9709..8ed4b074a3 100644 --- a/specification/_json_spec/indices.open.json +++ b/specification/_json_spec/indices.open.json @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -35,10 +36,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { @@ -49,6 +52,7 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of active shards to wait for before the operation returns." } } diff --git a/specification/_json_spec/indices.put_alias.json b/specification/_json_spec/indices.put_alias.json index 863e013b93..e5ffbfc2e5 100644 --- a/specification/_json_spec/indices.put_alias.json +++ b/specification/_json_spec/indices.put_alias.json @@ -45,6 +45,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { diff --git a/specification/_json_spec/indices.put_data_lifecycle.json b/specification/_json_spec/indices.put_data_lifecycle.json index e7be2ffd97..5e6026aa5d 100644 --- a/specification/_json_spec/indices.put_data_lifecycle.json +++ b/specification/_json_spec/indices.put_data_lifecycle.json @@ -33,6 +33,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { @@ -42,7 +43,8 @@ } }, "body": { - "description": "The data stream lifecycle configuration that consist of the data retention" + "description": "The data stream lifecycle configuration that consist of the data retention", + "required": true } } } diff --git a/specification/_json_spec/indices.put_data_stream_options.json b/specification/_json_spec/indices.put_data_stream_options.json index 6a6ee45930..db2c8364e4 100644 --- a/specification/_json_spec/indices.put_data_stream_options.json +++ b/specification/_json_spec/indices.put_data_stream_options.json @@ -33,6 +33,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { @@ -42,7 +43,8 @@ } }, "body": { - "description": "The data stream options configuration that consist of the failure store configuration" + "description": "The data stream options configuration that consist of the failure store configuration", + "required": true } } } diff --git a/specification/_json_spec/indices.put_data_stream_settings.json b/specification/_json_spec/indices.put_data_stream_settings.json index b037389592..4208afcbd8 100644 --- a/specification/_json_spec/indices.put_data_stream_settings.json +++ b/specification/_json_spec/indices.put_data_stream_settings.json @@ -31,8 +31,8 @@ }, "timeout": { "type": "time", - "description": "Period to wait for a response", - "default": "30s" + "default": "30s", + "description": "Period to wait for a response" }, "master_timeout": { "type": "time", diff --git a/specification/_json_spec/indices.put_index_template.json b/specification/_json_spec/indices.put_index_template.json index 7ca8ac3d70..d1d4ba1619 100644 --- a/specification/_json_spec/indices.put_index_template.json +++ b/specification/_json_spec/indices.put_index_template.json @@ -33,7 +33,7 @@ "cause": { "type": "string", "description": "User defined reason for creating/updating the index template", - "default": false + "default": "api" }, "master_timeout": { "type": "time", diff --git a/specification/_json_spec/indices.put_mapping.json b/specification/_json_spec/indices.put_mapping.json index aababfcdaa..557cc5ed69 100644 --- a/specification/_json_spec/indices.put_mapping.json +++ b/specification/_json_spec/indices.put_mapping.json @@ -27,6 +27,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -36,10 +37,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/specification/_json_spec/indices.put_settings.json b/specification/_json_spec/indices.put_settings.json index a3836f8a58..e9d6be4f72 100644 --- a/specification/_json_spec/indices.put_settings.json +++ b/specification/_json_spec/indices.put_settings.json @@ -36,22 +36,27 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "preserve_existing": { "type": "boolean", + "default": false, "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false`" }, "reopen": { "type": "boolean", + "default": false, "description": "Whether to close and reopen the index to apply non-dynamic settings. If set to `true` the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. The default is `false`" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": false, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { @@ -62,6 +67,7 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" } }, diff --git a/specification/_json_spec/indices.refresh.json b/specification/_json_spec/indices.refresh.json index 60b653e165..cd9af6c585 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.resolve_cluster.json b/specification/_json_spec/indices.resolve_cluster.json index 053cdbb224..366b100980 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 8ed96f8d2b..db9b100998 100644 --- a/specification/_json_spec/indices.rollover.json +++ b/specification/_json_spec/indices.rollover.json @@ -41,10 +41,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "dry_run": { "type": "boolean", + "default": false, "description": "If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false" }, "master_timeout": { @@ -54,16 +56,18 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns." }, "lazy": { "type": "boolean", - "default": "false", + "default": false, "description": "If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams." } }, "body": { - "description": "The conditions that needs to be met for executing rollover" + "description": "The conditions that needs to be met for executing rollover", + "required": false } } } diff --git a/specification/_json_spec/indices.segments.json b/specification/_json_spec/indices.segments.json index 16cea78cae..c164c00e1b 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 a6c3636e68..f3f45529df 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 8f67ce49ac..bfd849c413 100644 --- a/specification/_json_spec/indices.shrink.json +++ b/specification/_json_spec/indices.shrink.json @@ -31,6 +31,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -40,11 +41,13 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." } }, "body": { - "description": "The configuration for the target index (`settings` and `aliases`)" + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": true } } } diff --git a/specification/_json_spec/indices.simulate_index_template.json b/specification/_json_spec/indices.simulate_index_template.json index 7050871b99..7b03d1f98f 100644 --- a/specification/_json_spec/indices.simulate_index_template.json +++ b/specification/_json_spec/indices.simulate_index_template.json @@ -33,7 +33,7 @@ "cause": { "type": "string", "description": "User defined reason for dry-run creating the new template for simulation purposes", - "default": false + "default": "false" }, "master_timeout": { "type": "time", @@ -42,6 +42,7 @@ }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for this index template simulation (default: false)" } }, diff --git a/specification/_json_spec/indices.simulate_template.json b/specification/_json_spec/indices.simulate_template.json index c4b823990d..b6359f79b1 100644 --- a/specification/_json_spec/indices.simulate_template.json +++ b/specification/_json_spec/indices.simulate_template.json @@ -37,7 +37,7 @@ "cause": { "type": "string", "description": "User defined reason for dry-run creating the new template for simulation purposes", - "default": false + "default": "false" }, "master_timeout": { "type": "time", @@ -46,6 +46,7 @@ }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for this template simulation (default: false)" } }, diff --git a/specification/_json_spec/indices.split.json b/specification/_json_spec/indices.split.json index 88ba0f81c6..c03a2437b5 100644 --- a/specification/_json_spec/indices.split.json +++ b/specification/_json_spec/indices.split.json @@ -31,6 +31,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -40,11 +41,13 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." } }, "body": { - "description": "The configuration for the target index (`settings` and `aliases`)" + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": true } } } diff --git a/specification/_json_spec/indices.unfreeze.json b/specification/_json_spec/indices.unfreeze.json index c8e4c7ed0e..90d0f26fab 100644 --- a/specification/_json_spec/indices.unfreeze.json +++ b/specification/_json_spec/indices.unfreeze.json @@ -30,6 +30,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { @@ -39,10 +40,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/specification/_json_spec/indices.update_aliases.json b/specification/_json_spec/indices.update_aliases.json index d75dcfc014..0657ae900f 100644 --- a/specification/_json_spec/indices.update_aliases.json +++ b/specification/_json_spec/indices.update_aliases.json @@ -21,6 +21,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Request timeout" }, "master_timeout": { diff --git a/specification/_json_spec/indices.validate_query.json b/specification/_json_spec/indices.validate_query.json index dbc2bd4853..387c910509 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,19 +75,23 @@ }, "lenient": { "type": "boolean", + "default": false, "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" }, "rewrite": { "type": "boolean", + "default": false, "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed." }, "all_shards": { "type": "boolean", + "default": false, "description": "Execute validation on all shards instead of one random shard per index" } }, "body": { - "description": "The query definition specified with the Query DSL" + "description": "The query definition specified with the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/inference.chat_completion_unified.json b/specification/_json_spec/inference.chat_completion_unified.json index 0873c394f1..91c7c8d19d 100644 --- a/specification/_json_spec/inference.chat_completion_unified.json +++ b/specification/_json_spec/inference.chat_completion_unified.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.completion.json b/specification/_json_spec/inference.completion.json index 205ff7b5eb..6cbb9f172a 100644 --- a/specification/_json_spec/inference.completion.json +++ b/specification/_json_spec/inference.completion.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.delete.json b/specification/_json_spec/inference.delete.json index d6f87d18d8..81c922a000 100644 --- a/specification/_json_spec/inference.delete.json +++ b/specification/_json_spec/inference.delete.json @@ -40,10 +40,12 @@ "params": { "dry_run": { "type": "boolean", + "default": false, "description": "If true the endpoint will not be deleted and a list of ingest processors which reference this endpoint will be returned." }, "force": { "type": "boolean", + "default": false, "description": "If true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields)." } } diff --git a/specification/_json_spec/inference.inference.json b/specification/_json_spec/inference.inference.json index 112a7d8443..262b87d61d 100644 --- a/specification/_json_spec/inference.inference.json +++ b/specification/_json_spec/inference.inference.json @@ -39,7 +39,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.put.json b/specification/_json_spec/inference.put.json index 87859bfc16..12c8816077 100644 --- a/specification/_json_spec/inference.put.json +++ b/specification/_json_spec/inference.put.json @@ -39,7 +39,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_alibabacloud.json b/specification/_json_spec/inference.put_alibabacloud.json index 70c8a3c47d..24306a124f 100644 --- a/specification/_json_spec/inference.put_alibabacloud.json +++ b/specification/_json_spec/inference.put_alibabacloud.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_amazonbedrock.json b/specification/_json_spec/inference.put_amazonbedrock.json index 76ddd6484b..e730d6a4dd 100644 --- a/specification/_json_spec/inference.put_amazonbedrock.json +++ b/specification/_json_spec/inference.put_amazonbedrock.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_amazonsagemaker.json b/specification/_json_spec/inference.put_amazonsagemaker.json index 415c230f3e..c310b2733c 100644 --- a/specification/_json_spec/inference.put_amazonsagemaker.json +++ b/specification/_json_spec/inference.put_amazonsagemaker.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_anthropic.json b/specification/_json_spec/inference.put_anthropic.json index 232cd4d803..f57d219ae0 100644 --- a/specification/_json_spec/inference.put_anthropic.json +++ b/specification/_json_spec/inference.put_anthropic.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_azureaistudio.json b/specification/_json_spec/inference.put_azureaistudio.json index cb984bcbb9..045abbff7d 100644 --- a/specification/_json_spec/inference.put_azureaistudio.json +++ b/specification/_json_spec/inference.put_azureaistudio.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_azureopenai.json b/specification/_json_spec/inference.put_azureopenai.json index fe57c1f99d..cfb57794ec 100644 --- a/specification/_json_spec/inference.put_azureopenai.json +++ b/specification/_json_spec/inference.put_azureopenai.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_cohere.json b/specification/_json_spec/inference.put_cohere.json index 3497389ee2..0e788e355c 100644 --- a/specification/_json_spec/inference.put_cohere.json +++ b/specification/_json_spec/inference.put_cohere.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_custom.json b/specification/_json_spec/inference.put_custom.json index d14089cf12..e39884796a 100644 --- a/specification/_json_spec/inference.put_custom.json +++ b/specification/_json_spec/inference.put_custom.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_deepseek.json b/specification/_json_spec/inference.put_deepseek.json index 53882b0337..e00dffe75e 100644 --- a/specification/_json_spec/inference.put_deepseek.json +++ b/specification/_json_spec/inference.put_deepseek.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_elasticsearch.json b/specification/_json_spec/inference.put_elasticsearch.json index 4093ea3db7..c8e6d0c079 100644 --- a/specification/_json_spec/inference.put_elasticsearch.json +++ b/specification/_json_spec/inference.put_elasticsearch.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_elser.json b/specification/_json_spec/inference.put_elser.json index 4291509b9c..075af54a70 100644 --- a/specification/_json_spec/inference.put_elser.json +++ b/specification/_json_spec/inference.put_elser.json @@ -33,7 +33,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_googleaistudio.json b/specification/_json_spec/inference.put_googleaistudio.json index 8d9ce801fe..2686bb733b 100644 --- a/specification/_json_spec/inference.put_googleaistudio.json +++ b/specification/_json_spec/inference.put_googleaistudio.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_googlevertexai.json b/specification/_json_spec/inference.put_googlevertexai.json index da965c499a..8cec943da5 100644 --- a/specification/_json_spec/inference.put_googlevertexai.json +++ b/specification/_json_spec/inference.put_googlevertexai.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_hugging_face.json b/specification/_json_spec/inference.put_hugging_face.json index 972cc01d2b..befa772518 100644 --- a/specification/_json_spec/inference.put_hugging_face.json +++ b/specification/_json_spec/inference.put_hugging_face.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_jinaai.json b/specification/_json_spec/inference.put_jinaai.json index 81e099efe8..5db6c3f38b 100644 --- a/specification/_json_spec/inference.put_jinaai.json +++ b/specification/_json_spec/inference.put_jinaai.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_mistral.json b/specification/_json_spec/inference.put_mistral.json index 76ed0a80b8..2c51cd01cd 100644 --- a/specification/_json_spec/inference.put_mistral.json +++ b/specification/_json_spec/inference.put_mistral.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_openai.json b/specification/_json_spec/inference.put_openai.json index 43baf47bf8..b488493a4b 100644 --- a/specification/_json_spec/inference.put_openai.json +++ b/specification/_json_spec/inference.put_openai.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_voyageai.json b/specification/_json_spec/inference.put_voyageai.json index d165389ad9..f9a69a21af 100644 --- a/specification/_json_spec/inference.put_voyageai.json +++ b/specification/_json_spec/inference.put_voyageai.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_watsonx.json b/specification/_json_spec/inference.put_watsonx.json index 1b53940bb6..cfcbadec48 100644 --- a/specification/_json_spec/inference.put_watsonx.json +++ b/specification/_json_spec/inference.put_watsonx.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.rerank.json b/specification/_json_spec/inference.rerank.json index 583c713ea9..1447be36c9 100644 --- a/specification/_json_spec/inference.rerank.json +++ b/specification/_json_spec/inference.rerank.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.sparse_embedding.json b/specification/_json_spec/inference.sparse_embedding.json index a16b46adb0..fb81659b22 100644 --- a/specification/_json_spec/inference.sparse_embedding.json +++ b/specification/_json_spec/inference.sparse_embedding.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.stream_completion.json b/specification/_json_spec/inference.stream_completion.json index b62f81d70e..73c5f39b86 100644 --- a/specification/_json_spec/inference.stream_completion.json +++ b/specification/_json_spec/inference.stream_completion.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.text_embedding.json b/specification/_json_spec/inference.text_embedding.json index 2193d2c7a4..6ab0891a67 100644 --- a/specification/_json_spec/inference.text_embedding.json +++ b/specification/_json_spec/inference.text_embedding.json @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.update.json b/specification/_json_spec/inference.update.json index a00c216e40..b45001a3cd 100644 --- a/specification/_json_spec/inference.update.json +++ b/specification/_json_spec/inference.update.json @@ -39,7 +39,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/ingest.delete_geoip_database.json b/specification/_json_spec/ingest.delete_geoip_database.json index a000cf84c4..f153b9d55a 100644 --- a/specification/_json_spec/ingest.delete_geoip_database.json +++ b/specification/_json_spec/ingest.delete_geoip_database.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ingest.delete_ip_location_database.json b/specification/_json_spec/ingest.delete_ip_location_database.json index 7a29dcc37e..a50d0d793b 100644 --- a/specification/_json_spec/ingest.delete_ip_location_database.json +++ b/specification/_json_spec/ingest.delete_ip_location_database.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ingest.delete_pipeline.json b/specification/_json_spec/ingest.delete_pipeline.json index 6d169317ad..70eed7432b 100644 --- a/specification/_json_spec/ingest.delete_pipeline.json +++ b/specification/_json_spec/ingest.delete_pipeline.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ingest.get_pipeline.json b/specification/_json_spec/ingest.get_pipeline.json index a11eb06e2a..6f5db5f30b 100644 --- a/specification/_json_spec/ingest.get_pipeline.json +++ b/specification/_json_spec/ingest.get_pipeline.json @@ -30,6 +30,7 @@ "params": { "summary": { "type": "boolean", + "default": false, "description": "Return pipelines without their definitions (default: false)" }, "master_timeout": { diff --git a/specification/_json_spec/ingest.put_geoip_database.json b/specification/_json_spec/ingest.put_geoip_database.json index b174e4faf2..47c39f1809 100644 --- a/specification/_json_spec/ingest.put_geoip_database.json +++ b/specification/_json_spec/ingest.put_geoip_database.json @@ -32,6 +32,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/ingest.put_ip_location_database.json b/specification/_json_spec/ingest.put_ip_location_database.json index 30d2dee2d7..f86c26675f 100644 --- a/specification/_json_spec/ingest.put_ip_location_database.json +++ b/specification/_json_spec/ingest.put_ip_location_database.json @@ -32,6 +32,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/ingest.put_pipeline.json b/specification/_json_spec/ingest.put_pipeline.json index 2b8b1cd46e..bbceeb8133 100644 --- a/specification/_json_spec/ingest.put_pipeline.json +++ b/specification/_json_spec/ingest.put_pipeline.json @@ -36,6 +36,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/knn_search.json b/specification/_json_spec/knn_search.json index 23e4be09e1..57fd9773d7 100644 --- a/specification/_json_spec/knn_search.json +++ b/specification/_json_spec/knn_search.json @@ -35,7 +35,8 @@ } }, "body": { - "description": "The search definition" + "description": "The search definition", + "required": true } } } diff --git a/specification/_json_spec/license.delete.json b/specification/_json_spec/license.delete.json index fb22e23e0a..b57706c5f8 100644 --- a/specification/_json_spec/license.delete.json +++ b/specification/_json_spec/license.delete.json @@ -25,6 +25,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/specification/_json_spec/license.get.json b/specification/_json_spec/license.get.json index 3f0ecdb9d8..16891767c4 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 643ad1f712..58160b4c50 100644 --- a/specification/_json_spec/license.post.json +++ b/specification/_json_spec/license.post.json @@ -21,6 +21,7 @@ "params": { "acknowledge": { "type": "boolean", + "default": false, "description": "whether the user has acknowledged acknowledge messages (default: false)" }, "master_timeout": { @@ -30,11 +31,13 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } }, "body": { - "description": "licenses to be installed" + "description": "licenses to be installed", + "required": false } } } diff --git a/specification/_json_spec/license.post_start_basic.json b/specification/_json_spec/license.post_start_basic.json index e6a944e65a..8bfb04e6ce 100644 --- a/specification/_json_spec/license.post_start_basic.json +++ b/specification/_json_spec/license.post_start_basic.json @@ -29,6 +29,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/specification/_json_spec/mget.json b/specification/_json_spec/mget.json index 5bbbbc2dfe..53622b9a35 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 347a868671..c1c9488604 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 67942cb167..0bf54fe2cc 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 660a15514b..52e848a2e5 100644 --- a/specification/_json_spec/ml.delete_expired_data.json +++ b/specification/_json_spec/ml.delete_expired_data.json @@ -35,11 +35,13 @@ }, "timeout": { "type": "time", + "default": "8h", "description": "How long can the underlying delete processes run until they are canceled" } }, "body": { - "description": "deleting expired data parameters" + "description": "deleting expired data parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.delete_forecast.json b/specification/_json_spec/ml.delete_forecast.json index 9bea4e7f06..ad09bd1da4 100644 --- a/specification/_json_spec/ml.delete_forecast.json +++ b/specification/_json_spec/ml.delete_forecast.json @@ -40,10 +40,12 @@ "params": { "allow_no_forecasts": { "type": "boolean", + "default": true, "description": "Whether to ignore if `_all` matches no forecasts" }, "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds" } } diff --git a/specification/_json_spec/ml.flush_job.json b/specification/_json_spec/ml.flush_job.json index cef9024996..4b52e4a7cb 100644 --- a/specification/_json_spec/ml.flush_job.json +++ b/specification/_json_spec/ml.flush_job.json @@ -47,7 +47,8 @@ } }, "body": { - "description": "Flush parameters" + "description": "Flush parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.forecast.json b/specification/_json_spec/ml.forecast.json index d91735fa36..bdb4189b02 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 7723f5c2a7..f5b2fbd52f 100644 --- a/specification/_json_spec/ml.get_buckets.json +++ b/specification/_json_spec/ml.get_buckets.json @@ -41,43 +41,53 @@ "params": { "expand": { "type": "boolean", + "default": false, "description": "Include anomaly records" }, "exclude_interim": { "type": "boolean", + "default": false, "description": "Exclude interim results" }, "from": { "type": "int", + "default": 0, "description": "skips a number of buckets" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of buckets to get" }, "start": { "type": "string", + "default": "-1", "description": "Start time filter for buckets" }, "end": { "type": "string", + "default": "-1", "description": "End time filter for buckets" }, "anomaly_score": { "type": "double", + "default": 0, "description": "Filter for the most anomalous buckets" }, "sort": { "type": "string", + "default": "timestamp", "description": "Sort buckets by a particular field" }, "desc": { "type": "boolean", + "default": false, "description": "Set the sort direction" } }, "body": { - "description": "Bucket selection details if not provided in URI" + "description": "Bucket selection details if not provided in URI", + "required": false } } } diff --git a/specification/_json_spec/ml.get_calendar_events.json b/specification/_json_spec/ml.get_calendar_events.json index c8f354391e..59219a8466 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 683e4b5500..73602af953 100644 --- a/specification/_json_spec/ml.get_calendars.json +++ b/specification/_json_spec/ml.get_calendars.json @@ -31,15 +31,18 @@ "params": { "from": { "type": "int", + "default": 0, "description": "skips a number of calendars" }, "size": { "type": "int", + "default": 10000, "description": "specifies a max number of calendars to get" } }, "body": { - "description": "The from and size parameters optionally sent in the body" + "description": "The from and size parameters optionally sent in the body", + "required": false } } } diff --git a/specification/_json_spec/ml.get_categories.json b/specification/_json_spec/ml.get_categories.json index 4b08695222..b6728bdaac 100644 --- a/specification/_json_spec/ml.get_categories.json +++ b/specification/_json_spec/ml.get_categories.json @@ -41,10 +41,12 @@ "params": { "from": { "type": "int", + "default": 0, "description": "skips a number of categories" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of categories to get" }, "partition_field_value": { @@ -53,7 +55,8 @@ } }, "body": { - "description": "Category selection details if not provided in URI" + "description": "Category selection details if not provided in URI", + "required": false } } } diff --git a/specification/_json_spec/ml.get_filters.json b/specification/_json_spec/ml.get_filters.json index 25aa992e61..3ab409b0d9 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 6062ad48a1..a0750c3379 100644 --- a/specification/_json_spec/ml.get_influencers.json +++ b/specification/_json_spec/ml.get_influencers.json @@ -27,26 +27,32 @@ "params": { "exclude_interim": { "type": "boolean", + "default": false, "description": "Exclude interim results" }, "from": { "type": "int", + "default": 0, "description": "skips a number of influencers" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of influencers to get" }, "start": { "type": "string", + "default": "-1", "description": "start timestamp for the requested influencers" }, "end": { "type": "string", + "default": "-1", "description": "end timestamp for the requested influencers" }, "influencer_score": { "type": "double", + "default": 0, "description": "influencer score threshold for the requested influencers" }, "sort": { @@ -55,11 +61,13 @@ }, "desc": { "type": "boolean", + "default": false, "description": "whether the results should be sorted in decending order" } }, "body": { - "description": "Influencer selection criteria" + "description": "Influencer selection criteria", + "required": false } } } diff --git a/specification/_json_spec/ml.get_job_stats.json b/specification/_json_spec/ml.get_job_stats.json index 0c9bea733b..cebf8d878e 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 0a021cf6ea..4f5a3b5336 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 d8f2b0b90f..bd4b020a19 100644 --- a/specification/_json_spec/ml.get_memory_stats.json +++ b/specification/_json_spec/ml.get_memory_stats.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ml.get_model_snapshots.json b/specification/_json_spec/ml.get_model_snapshots.json index dfe8a4ab30..172557413c 100644 --- a/specification/_json_spec/ml.get_model_snapshots.json +++ b/specification/_json_spec/ml.get_model_snapshots.json @@ -41,10 +41,12 @@ "params": { "from": { "type": "int", + "default": 0, "description": "Skips a number of documents" }, "size": { "type": "int", + "default": 100, "description": "The default number of documents returned in queries as a string." }, "start": { @@ -61,11 +63,13 @@ }, "desc": { "type": "boolean", + "default": false, "description": "True if the results should be sorted in descending order" } }, "body": { - "description": "Model snapshot selection criteria" + "description": "Model snapshot selection criteria", + "required": false } } } diff --git a/specification/_json_spec/ml.get_overall_buckets.json b/specification/_json_spec/ml.get_overall_buckets.json index f2376c7142..94f93aead2 100644 --- a/specification/_json_spec/ml.get_overall_buckets.json +++ b/specification/_json_spec/ml.get_overall_buckets.json @@ -27,6 +27,7 @@ "params": { "top_n": { "type": "int", + "default": 1, "description": "The number of top job bucket scores to be used in the overall_score calculation" }, "bucket_span": { @@ -39,6 +40,7 @@ }, "exclude_interim": { "type": "boolean", + "default": false, "description": "If true overall buckets that include interim buckets will be excluded" }, "start": { @@ -51,11 +53,13 @@ }, "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)" } }, "body": { - "description": "Overall bucket selection details if not provided in URI" + "description": "Overall bucket selection details if not provided in URI", + "required": false } } } diff --git a/specification/_json_spec/ml.get_records.json b/specification/_json_spec/ml.get_records.json index 38fdfe8c71..41c176efab 100644 --- a/specification/_json_spec/ml.get_records.json +++ b/specification/_json_spec/ml.get_records.json @@ -27,39 +27,48 @@ "params": { "exclude_interim": { "type": "boolean", + "default": false, "description": "Exclude interim results" }, "from": { "type": "int", + "default": 0, "description": "skips a number of records" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of records to get" }, "start": { "type": "string", + "default": "-1", "description": "Start time filter for records" }, "end": { "type": "string", + "default": "-1", "description": "End time filter for records" }, "record_score": { "type": "double", + "default": 0, "description": "Returns records with anomaly scores greater or equal than this value" }, "sort": { "type": "string", + "default": "record_score", "description": "Sort records by a particular field" }, "desc": { "type": "boolean", + "default": false, "description": "Set the sort direction" } }, "body": { - "description": "Record selection criteria" + "description": "Record selection criteria", + "required": false } } } diff --git a/specification/_json_spec/ml.put_datafeed.json b/specification/_json_spec/ml.put_datafeed.json index 12962e5daf..eb03213f37 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 da5effcd4b..f5af8173b7 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 c1fbd91cbc..591f5fe76f 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 beff4b5ec6..ab3e760acc 100644 --- a/specification/_json_spec/ml.revert_model_snapshot.json +++ b/specification/_json_spec/ml.revert_model_snapshot.json @@ -31,11 +31,13 @@ "params": { "delete_intervening_results": { "type": "boolean", + "default": false, "description": "Should we reset the results back to the time of the snapshot?" } }, "body": { - "description": "Reversion options" + "description": "Reversion options", + "required": false } } } diff --git a/specification/_json_spec/ml.set_upgrade_mode.json b/specification/_json_spec/ml.set_upgrade_mode.json index 5c85778696..815c7bd795 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 66c5b211aa..04c439ffc8 100644 --- a/specification/_json_spec/ml.start_data_frame_analytics.json +++ b/specification/_json_spec/ml.start_data_frame_analytics.json @@ -27,11 +27,13 @@ "params": { "timeout": { "type": "time", + "default": "20s", "description": "Controls the time to wait until the task has started. Defaults to 20 seconds" } }, "body": { - "description": "The start data frame analytics parameters" + "description": "The start data frame analytics parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.start_datafeed.json b/specification/_json_spec/ml.start_datafeed.json index 1c533012c0..3762132513 100644 --- a/specification/_json_spec/ml.start_datafeed.json +++ b/specification/_json_spec/ml.start_datafeed.json @@ -35,11 +35,13 @@ }, "timeout": { "type": "time", + "default": "20s", "description": "Controls the time to wait until a datafeed has started. Default to 20 seconds" } }, "body": { - "description": "The start datafeed parameters" + "description": "The start datafeed parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.stop_data_frame_analytics.json b/specification/_json_spec/ml.stop_data_frame_analytics.json index edde0665d2..eb31940dd8 100644 --- a/specification/_json_spec/ml.stop_data_frame_analytics.json +++ b/specification/_json_spec/ml.stop_data_frame_analytics.json @@ -27,19 +27,23 @@ "params": { "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)" }, "force": { "type": "boolean", + "default": false, "description": "True if the data frame analytics should be forcefully stopped" }, "timeout": { "type": "time", + "default": "20s", "description": "Controls the time to wait until the task has stopped. Defaults to 20 seconds" } }, "body": { - "description": "The stop data frame analytics parameters" + "description": "The stop data frame analytics parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.stop_datafeed.json b/specification/_json_spec/ml.stop_datafeed.json index ecc26aafdf..1f07982c92 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 ed928b0355..cc8078ead6 100644 --- a/specification/_json_spec/ml.stop_trained_model_deployment.json +++ b/specification/_json_spec/ml.stop_trained_model_deployment.json @@ -28,15 +28,18 @@ "params": { "allow_no_match": { "type": "boolean", + "default": true, "description": "Whether to ignore if a wildcard expression matches no deployments. (This includes `_all` string or when no deployments have been specified)" }, "force": { "type": "boolean", + "default": false, "description": "True if the deployment should be forcefully stopped" } }, "body": { - "description": "The stop deployment parameters" + "description": "The stop deployment parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.update_datafeed.json b/specification/_json_spec/ml.update_datafeed.json index f04163f28b..8174ba55fe 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 f0ef4179e9..d4bfc131a9 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 085deb3375..915107973a 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 5d21b655f3..db3ef0b6f4 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 ebf5131902..41b7bd2faf 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 6279d48b76..6e9003c366 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 c371cdb86e..292afebd6a 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 308acd147d..1f3a43f352 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 597fee53e3..ac32132646 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 5adbccc397..4141adec04 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 6bc904b97c..db8083d648 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 65797d13ae..da48dee987 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": { @@ -59,7 +61,8 @@ } }, "body": { - "description": "An index_filter specified with the Query DSL" + "description": "An index_filter specified with the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/put_script.json b/specification/_json_spec/put_script.json index d1a3361aa6..42f69e0905 100644 --- a/specification/_json_spec/put_script.json +++ b/specification/_json_spec/put_script.json @@ -41,6 +41,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { diff --git a/specification/_json_spec/rank_eval.json b/specification/_json_spec/rank_eval.json index 4a7a7b0ba1..1673623ce3 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 3b1d019aa7..e0f2738571 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/render_search_template.json b/specification/_json_spec/render_search_template.json index 744726a79b..da6294d40b 100644 --- a/specification/_json_spec/render_search_template.json +++ b/specification/_json_spec/render_search_template.json @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The search definition template and its params" + "description": "The search definition template and its params", + "required": true } } } diff --git a/specification/_json_spec/rollup.stop_job.json b/specification/_json_spec/rollup.stop_job.json index aaf6f527a6..6b5d510660 100644 --- a/specification/_json_spec/rollup.stop_job.json +++ b/specification/_json_spec/rollup.stop_job.json @@ -26,10 +26,12 @@ "params": { "wait_for_completion": { "type": "boolean", + "default": false, "description": "True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false." }, "timeout": { "type": "time", + "default": "30s", "description": "Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s." } } diff --git a/specification/_json_spec/scripts_painless_execute.json b/specification/_json_spec/scripts_painless_execute.json index 55c7004aa1..36d26994b8 100644 --- a/specification/_json_spec/scripts_painless_execute.json +++ b/specification/_json_spec/scripts_painless_execute.json @@ -20,7 +20,8 @@ }, "params": {}, "body": { - "description": "The script to execute" + "description": "The script to execute", + "required": true } } } diff --git a/specification/_json_spec/scroll.json b/specification/_json_spec/scroll.json index 5d122c2c08..c3bfaab632 100644 --- a/specification/_json_spec/scroll.json +++ b/specification/_json_spec/scroll.json @@ -36,6 +36,7 @@ "params": { "scroll": { "type": "time", + "default": "1d", "description": "Specify how long a consistent view of the index should be maintained for scrolled search" }, "scroll_id": { @@ -49,7 +50,8 @@ } }, "body": { - "description": "The scroll ID if not passed by URL or query parameter." + "description": "The scroll ID if not passed by URL or query parameter.", + "required": false } } } diff --git a/specification/_json_spec/search.json b/specification/_json_spec/search.json index 812ec3d40f..48ae65c7a2 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": { @@ -226,7 +240,8 @@ } }, "body": { - "description": "The search definition using the Query DSL" + "description": "The search definition using the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/search_application.list.json b/specification/_json_spec/search_application.list.json index aa6eeea047..31bc289f7e 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 8bf52f898b..d49f65b34f 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 26c1f71ae1..633826c7bf 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 3a553e1264..13f8df02e9 100644 --- a/specification/_json_spec/search_shards.json +++ b/specification/_json_spec/search_shards.json @@ -38,14 +38,17 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": false, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" }, "expand_wildcards": { diff --git a/specification/_json_spec/search_template.json b/specification/_json_spec/search_template.json index 4420947714..2a77568e56 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 13bf1dc9ab..57d0d9f722 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 41440e22e8..5f48d0d065 100644 --- a/specification/_json_spec/searchable_snapshots.mount.json +++ b/specification/_json_spec/searchable_snapshots.mount.json @@ -42,7 +42,7 @@ "storage": { "type": "string", "description": "Selects the kind of local storage used to accelerate searches. Experimental, and defaults to `full_copy`", - "default": false + "default": "full_copy" } }, "body": { diff --git a/specification/_json_spec/security.disable_user_profile.json b/specification/_json_spec/security.disable_user_profile.json index 370b11c157..e8d2cdf945 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 bba94a8503..d4e64c5040 100644 --- a/specification/_json_spec/security.enable_user_profile.json +++ b/specification/_json_spec/security.enable_user_profile.json @@ -27,6 +27,7 @@ "refresh": { "type": "enum", "options": ["true", "false", "wait_for"], + "default": "false", "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes." } } diff --git a/specification/_json_spec/security.grant_api_key.json b/specification/_json_spec/security.grant_api_key.json index f509bb3a09..eb1299e6d8 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 b99b262485..2413a51390 100644 --- a/specification/_json_spec/security.put_user.json +++ b/specification/_json_spec/security.put_user.json @@ -28,6 +28,7 @@ "refresh": { "type": "enum", "options": ["true", "false", "wait_for"], + "default": "true", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes." } }, diff --git a/specification/_json_spec/security.update_user_profile_data.json b/specification/_json_spec/security.update_user_profile_data.json index b7fb25c7b6..d655a383df 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 2b90546436..e1b124458a 100644 --- a/specification/_json_spec/shutdown.delete_node.json +++ b/specification/_json_spec/shutdown.delete_node.json @@ -32,6 +32,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/shutdown.put_node.json b/specification/_json_spec/shutdown.put_node.json index 622ac6095b..8eb9e28868 100644 --- a/specification/_json_spec/shutdown.put_node.json +++ b/specification/_json_spec/shutdown.put_node.json @@ -32,6 +32,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/slm.delete_lifecycle.json b/specification/_json_spec/slm.delete_lifecycle.json index 5993c7a19b..d3524a701d 100644 --- a/specification/_json_spec/slm.delete_lifecycle.json +++ b/specification/_json_spec/slm.delete_lifecycle.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.execute_lifecycle.json b/specification/_json_spec/slm.execute_lifecycle.json index 6273106d0c..71efac0cd5 100644 --- a/specification/_json_spec/slm.execute_lifecycle.json +++ b/specification/_json_spec/slm.execute_lifecycle.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.execute_retention.json b/specification/_json_spec/slm.execute_retention.json index 8727f7f2cc..bdf550da74 100644 --- a/specification/_json_spec/slm.execute_retention.json +++ b/specification/_json_spec/slm.execute_retention.json @@ -25,6 +25,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.get_lifecycle.json b/specification/_json_spec/slm.get_lifecycle.json index b25fdc1798..8deac8ec8c 100644 --- a/specification/_json_spec/slm.get_lifecycle.json +++ b/specification/_json_spec/slm.get_lifecycle.json @@ -35,6 +35,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.get_stats.json b/specification/_json_spec/slm.get_stats.json index 0ce9871c6d..ea44da3ead 100644 --- a/specification/_json_spec/slm.get_stats.json +++ b/specification/_json_spec/slm.get_stats.json @@ -25,6 +25,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.get_status.json b/specification/_json_spec/slm.get_status.json index 7aaa57891c..98e0fedfe6 100644 --- a/specification/_json_spec/slm.get_status.json +++ b/specification/_json_spec/slm.get_status.json @@ -25,6 +25,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.put_lifecycle.json b/specification/_json_spec/slm.put_lifecycle.json index 9a853861e8..2d0898ac98 100644 --- a/specification/_json_spec/slm.put_lifecycle.json +++ b/specification/_json_spec/slm.put_lifecycle.json @@ -32,11 +32,13 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, "body": { - "description": "The snapshot lifecycle policy definition to register" + "description": "The snapshot lifecycle policy definition to register", + "required": true } } } diff --git a/specification/_json_spec/slm.start.json b/specification/_json_spec/slm.start.json index ea70d99fa5..b3a2a65c91 100644 --- a/specification/_json_spec/slm.start.json +++ b/specification/_json_spec/slm.start.json @@ -25,6 +25,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/specification/_json_spec/slm.stop.json b/specification/_json_spec/slm.stop.json index 8db67e091f..e80858aa6e 100644 --- a/specification/_json_spec/slm.stop.json +++ b/specification/_json_spec/slm.stop.json @@ -25,6 +25,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/specification/_json_spec/snapshot.cleanup_repository.json b/specification/_json_spec/snapshot.cleanup_repository.json index 6d76cf47c6..ef69898174 100644 --- a/specification/_json_spec/snapshot.cleanup_repository.json +++ b/specification/_json_spec/snapshot.cleanup_repository.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/snapshot.create_repository.json b/specification/_json_spec/snapshot.create_repository.json index 0df0f103b4..79ab5b7ea8 100644 --- a/specification/_json_spec/snapshot.create_repository.json +++ b/specification/_json_spec/snapshot.create_repository.json @@ -32,10 +32,12 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "verify": { "type": "boolean", + "default": true, "description": "Whether to verify the repository after creation" } }, diff --git a/specification/_json_spec/snapshot.delete_repository.json b/specification/_json_spec/snapshot.delete_repository.json index 87178d5eca..b7a7368c3e 100644 --- a/specification/_json_spec/snapshot.delete_repository.json +++ b/specification/_json_spec/snapshot.delete_repository.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/snapshot.get.json b/specification/_json_spec/snapshot.get.json index cc6efd0ee9..e806773bf9 100644 --- a/specification/_json_spec/snapshot.get.json +++ b/specification/_json_spec/snapshot.get.json @@ -35,18 +35,22 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown" }, "index_names": { "type": "boolean", + "default": true, "description": "Whether to include the name of each index in the snapshot. Defaults to true." }, "index_details": { "type": "boolean", + "default": false, "description": "Whether to include details of each index in the snapshot, if those details are available. Defaults to false." }, "include_repository": { "type": "boolean", + "default": true, "description": "Whether to include the repository name in the snapshot info. Defaults to true." }, "sort": { @@ -65,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": { @@ -83,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": { @@ -91,6 +97,7 @@ }, "verbose": { "type": "boolean", + "default": true, "description": "Whether to show verbose snapshot info or only show the basic info found in the repository index blob" } } diff --git a/specification/_json_spec/snapshot.get_repository.json b/specification/_json_spec/snapshot.get_repository.json index a41c0f6fce..8387b8d76c 100644 --- a/specification/_json_spec/snapshot.get_repository.json +++ b/specification/_json_spec/snapshot.get_repository.json @@ -35,6 +35,7 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/specification/_json_spec/snapshot.repository_analyze.json b/specification/_json_spec/snapshot.repository_analyze.json index 4a59dd886f..e69ddcf0e9 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 34d5bedc8f..132f2329b0 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.status.json b/specification/_json_spec/snapshot.status.json index 2295d6b682..a0516f6202 100644 --- a/specification/_json_spec/snapshot.status.json +++ b/specification/_json_spec/snapshot.status.json @@ -49,6 +49,7 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown" } } diff --git a/specification/_json_spec/snapshot.verify_repository.json b/specification/_json_spec/snapshot.verify_repository.json index e301bae8e1..3df09a8ae4 100644 --- a/specification/_json_spec/snapshot.verify_repository.json +++ b/specification/_json_spec/snapshot.verify_repository.json @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/streams.logs_disable.json b/specification/_json_spec/streams.logs_disable.json index 8ac525142a..c88c044076 100644 --- a/specification/_json_spec/streams.logs_disable.json +++ b/specification/_json_spec/streams.logs_disable.json @@ -21,6 +21,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." }, "master_timeout": { diff --git a/specification/_json_spec/streams.logs_enable.json b/specification/_json_spec/streams.logs_enable.json index 7438879c65..f366ba7e4b 100644 --- a/specification/_json_spec/streams.logs_enable.json +++ b/specification/_json_spec/streams.logs_enable.json @@ -21,6 +21,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." }, "master_timeout": { diff --git a/specification/_json_spec/streams.status.json b/specification/_json_spec/streams.status.json index 1d5b92a154..bacdc09eb6 100644 --- a/specification/_json_spec/streams.status.json +++ b/specification/_json_spec/streams.status.json @@ -18,6 +18,12 @@ } ] }, - "params": {} + "params": { + "master_timeout": { + "type": "time", + "default": "30s", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + } + } } } diff --git a/specification/_json_spec/tasks.cancel.json b/specification/_json_spec/tasks.cancel.json index 3de320dc2d..a3e93ccbd6 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 afffbf3083..c004949b46 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 6b730f091f..b17e94c43f 100644 --- a/specification/_json_spec/tasks.list.json +++ b/specification/_json_spec/tasks.list.json @@ -28,6 +28,7 @@ }, "detailed": { "type": "boolean", + "default": false, "description": "Return detailed task information (default: false)" }, "parent_task_id": { @@ -36,6 +37,7 @@ }, "wait_for_completion": { "type": "boolean", + "default": false, "description": "Wait for the matching tasks to complete (default: false)" }, "group_by": { @@ -46,6 +48,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/terms_enum.json b/specification/_json_spec/terms_enum.json index 753bf10d05..1289a5aba9 100644 --- a/specification/_json_spec/terms_enum.json +++ b/specification/_json_spec/terms_enum.json @@ -26,7 +26,8 @@ }, "params": {}, "body": { - "description": "field name, string which is the prefix expected in matching terms, timeout and size for max number of results" + "description": "field name, string which is the prefix expected in matching terms, timeout and size for max number of results", + "required": true } } } diff --git a/specification/_json_spec/termvectors.json b/specification/_json_spec/termvectors.json index 185040de11..a0da42b842 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 15676abdf4..b6f86c7a9e 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 03cd04d812..1abf8de5b7 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 216a958f57..3ca7a3db9b 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 57f63fd25a..4e8e099b3f 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 f5a6b9b2bd..51914ab0df 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 426c00bf5a..9afe06e62e 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 79a5b5e394..057a7e71a9 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 0a07f98dd3..ab77bc856c 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 4b43682eca..aebe981e35 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 dd5ce39f98..d15eb391ec 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 897419bdc8..a9605658f2 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 c76df245f0..ce92e18ee2 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 e481dfa885..71eda92783 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 116678f135..c7f462a4a8 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 4b4079c948..b8a7e0a654 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 162e62c641..c000e67afa 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 990b7d8520..7547b48c03 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": { @@ -163,7 +171,8 @@ } }, "body": { - "description": "The search definition using the Query DSL" + "description": "The search definition using the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/update_by_query_rethrottle.json b/specification/_json_spec/update_by_query_rethrottle.json index baab149329..0b5688ab08 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 b263571f35..db3d2c6571 100644 --- a/specification/_json_spec/watcher.execute_watch.json +++ b/specification/_json_spec/watcher.execute_watch.json @@ -31,6 +31,7 @@ "params": { "debug": { "type": "boolean", + "default": false, "description": "indicates whether the watch should execute in debug mode" } }, diff --git a/specification/_json_spec/watcher.put_watch.json b/specification/_json_spec/watcher.put_watch.json index 28b739d833..8a95f656db 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.stats.json b/specification/_json_spec/watcher.stats.json index 2d706cb715..e07e3f3741 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" } }