diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_data_frame_analytics.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_data_frame_analytics.json index a85a71fd3766b..f9712e83de4bc 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_data_frame_analytics.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_data_frame_analytics.json @@ -37,7 +37,6 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)" }, "bytes": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json index 7b81872cbaebc..81081307c583e 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json @@ -37,7 +37,6 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)" }, "format": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_jobs.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_jobs.json index 8f8721a9f3353..4d82b6dfc6c6c 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_jobs.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_jobs.json @@ -37,7 +37,6 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)" }, "bytes": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_trained_models.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_trained_models.json index ef98e0af5cdce..0dad824e71539 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_trained_models.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_trained_models.json @@ -37,7 +37,6 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)", "default": true }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.transforms.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.transforms.json index 624544deec842..49dee56a0a481 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.transforms.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.transforms.json @@ -37,17 +37,14 @@ "params": { "from": { "type": "int", - "required": false, "description": "skips a number of transform configs, defaults to 0" }, "size": { "type": "int", - "required": false, "description": "specifies a max number of transforms to get, defaults to 100" }, "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)" }, "format": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.resolve_index.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.resolve_index.json index b94163c6a263b..94996a2da720f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.resolve_index.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.resolve_index.json @@ -52,7 +52,12 @@ }, "mode": { "type": "enum", - "options": ["standard", "time_series", "logsdb", "lookup"], + "options": [ + "standard", + "time_series", + "logsdb", + "lookup" + ], "default": "", "description": "Filter indices by index mode. Comma-separated list of IndexMode. Empty means no filter." } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/inference.delete.json b/rest-api-spec/src/main/resources/rest-api-spec/api/inference.delete.json index 1ffe8d1e3e664..ae281c48aadb4 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/inference.delete.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/inference.delete.json @@ -46,13 +46,11 @@ "params": { "dry_run": { "type": "boolean", - "description": "If true the endpoint will not be deleted and a list of ingest processors which reference this endpoint will be returned.", - "required": 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", - "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).", - "required": false + "description": "If true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields)." } } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.close_job.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.close_job.json index 348708fec5a52..3e355635038ea 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.close_job.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.close_job.json @@ -33,12 +33,10 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "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", - "required": false, "description": "True if the job should be forcefully closed" }, "timeout": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_datafeed.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_datafeed.json index 5dfe10a9b7020..1a126b68abb3b 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_datafeed.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_datafeed.json @@ -30,7 +30,6 @@ "params": { "force": { "type": "boolean", - "required": false, "description": "True if the datafeed should be forcefully deleted" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_expired_data.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_expired_data.json index 0616308d00eb9..9f43718109a7d 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_expired_data.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_expired_data.json @@ -39,12 +39,10 @@ "params": { "requests_per_second": { "type": "number", - "required": false, "description": "The desired requests per second for the deletion processes." }, "timeout": { "type": "time", - "required": false, "description": "How long can the underlying delete processes run until they are canceled" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_forecast.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_forecast.json index 44efe6fbd782f..de80d715c20cc 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_forecast.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_forecast.json @@ -46,12 +46,10 @@ "params": { "allow_no_forecasts": { "type": "boolean", - "required": false, "description": "Whether to ignore if `_all` matches no forecasts" }, "timeout": { "type": "time", - "required": false, "description": "Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_trained_model.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_trained_model.json index 4f8bea08a74bf..33cdde5d0e980 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_trained_model.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_trained_model.json @@ -30,13 +30,11 @@ "params": { "timeout": { "type": "time", - "required": false, "description": "Controls the amount of time to wait for the model to be deleted.", "default": "30s" }, "force": { "type": "boolean", - "required": false, "description": "True if the model should be forcefully deleted" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.forecast.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.forecast.json index 34a0ff8f9dab8..41231edaa9a2e 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.forecast.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.forecast.json @@ -33,17 +33,14 @@ "params": { "duration": { "type": "time", - "required": false, "description": "The duration of the forecast" }, "expires_in": { "type": "time", - "required": false, "description": "The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity." }, "max_model_memory": { "type": "string", - "required": false, "description": "The max memory able to be used by the forecast. Default is 20mb." } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_data_frame_analytics.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_data_frame_analytics.json index 7accaee91d124..23749777f3124 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_data_frame_analytics.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_data_frame_analytics.json @@ -36,7 +36,6 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "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)", "default": true }, @@ -51,7 +50,6 @@ "default": 100 }, "exclude_generated": { - "required": false, "type": "boolean", "default": false, "description": "Omits fields that are illegal to set on data frame analytics PUT" diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_data_frame_analytics_stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_data_frame_analytics_stats.json index 0db1e2aed3235..6c0ececbce6ef 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_data_frame_analytics_stats.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_data_frame_analytics_stats.json @@ -36,7 +36,6 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "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)", "default": true }, @@ -52,7 +51,6 @@ }, "verbose": { "type": "boolean", - "required": false, "description": "whether the stats response should be verbose", "default": false } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_datafeed_stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_datafeed_stats.json index c793562c60517..22f32fe18160f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_datafeed_stats.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_datafeed_stats.json @@ -36,7 +36,6 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_datafeeds.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_datafeeds.json index 6f4cbd236633a..5595cff898070 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_datafeeds.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_datafeeds.json @@ -36,11 +36,9 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)" }, "exclude_generated": { - "required": false, "type": "boolean", "default": false, "description": "Omits fields that are illegal to set on datafeed PUT" diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_job_stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_job_stats.json index b4fe8e4bcf93f..ecbd34bc1c597 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_job_stats.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_job_stats.json @@ -36,7 +36,6 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_jobs.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_jobs.json index 8ae03f134716d..d4eb167c8ada9 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_jobs.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_jobs.json @@ -36,11 +36,9 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)" }, "exclude_generated": { - "required": false, "type": "boolean", "default": false, "description": "Omits fields that are illegal to set on job PUT" diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_model_snapshot_upgrade_stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_model_snapshot_upgrade_stats.json index 2462236e7790d..ba8dfbd8dea42 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_model_snapshot_upgrade_stats.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_model_snapshot_upgrade_stats.json @@ -34,7 +34,6 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no jobs or no snapshots. (This includes the `_all` string.)" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_trained_models.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_trained_models.json index 8c5ebaf82c371..400b64ccbb855 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_trained_models.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_trained_models.json @@ -36,40 +36,33 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)", "default": true }, "include": { "type": "string", - "required": false, "description": "A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none." }, "decompress_definition": { "type": "boolean", - "required": false, "default": true, "description": "Should the model definition be decompressed into valid JSON or returned in a custom compressed format. Defaults to true." }, "from": { - "required": false, "type": "int", "description": "skips a number of trained models", "default": 0 }, "size": { - "required": false, "type": "int", "description": "specifies a max number of trained models to get", "default": 100 }, "tags": { - "required": false, "type": "list", "description": "A comma-separated list of tags that the model must have." }, "exclude_generated": { - "required": false, "type": "boolean", "default": false, "description": "Omits fields that are illegal to set on model PUT" diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_trained_models_stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_trained_models_stats.json index f8fa01770c5e7..cfc78c1cdc0ff 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_trained_models_stats.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_trained_models_stats.json @@ -36,7 +36,6 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)", "default": true }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.infer_trained_model.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.infer_trained_model.json index d56e814891c9b..b2cebf906d60f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.infer_trained_model.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.infer_trained_model.json @@ -34,7 +34,6 @@ "params": { "timeout": { "type": "time", - "required": false, "description": "Controls the amount of time to wait for inference results.", "default": "10s" } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.preview_datafeed.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.preview_datafeed.json index 2f5a36e7b6eca..3f81762e543f0 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.preview_datafeed.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.preview_datafeed.json @@ -41,12 +41,10 @@ "params": { "start": { "type": "string", - "required": false, "description": "The start time from where the datafeed preview should begin" }, "end": { "type": "string", - "required": false, "description": "The end time when the datafeed preview should stop" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.put_trained_model.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.put_trained_model.json index 2755c6fe109d7..6c2d04fc4625f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.put_trained_model.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.put_trained_model.json @@ -32,13 +32,11 @@ }, "params": { "defer_definition_decompression": { - "required": false, "type": "boolean", "description": "If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations.", "default": false }, "wait_for_completion": { - "required": false, "type": "boolean", "description": "Whether to wait for all child operations(e.g. model download) to complete, before returning or not. Default to false", "default": false diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_data_frame_analytics.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_data_frame_analytics.json index 7f8a0ec306ccd..932e7dbf84475 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_data_frame_analytics.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_data_frame_analytics.json @@ -33,7 +33,6 @@ "params": { "timeout": { "type": "time", - "required": false, "description": "Controls the time to wait until the task has started. Defaults to 20 seconds" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_datafeed.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_datafeed.json index fc49d8f8214fb..3cb04662c1bc5 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_datafeed.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_datafeed.json @@ -33,17 +33,14 @@ "params": { "start": { "type": "string", - "required": false, "description": "The start time from where the datafeed should begin" }, "end": { "type": "string", - "required": false, "description": "The end time when the datafeed should stop. When not set, the datafeed continues in real time" }, "timeout": { "type": "time", - "required": false, "description": "Controls the time to wait until a datafeed has started. Default to 20 seconds" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_trained_model_deployment.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_trained_model_deployment.json index bcf45d58d5f4f..81faf2cfba3d4 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_trained_model_deployment.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.start_trained_model_deployment.json @@ -34,47 +34,39 @@ "params": { "cache_size": { "type": "string", - "description": "A byte-size value for configuring the inference cache size. For example, 20mb.", - "required": false + "description": "A byte-size value for configuring the inference cache size. For example, 20mb." }, "deployment_id": { "type": "string", - "description": "The Id of the new deployment. Defaults to the model_id if not set.", - "required": false + "description": "The Id of the new deployment. Defaults to the model_id if not set." }, "number_of_allocations": { "type": "int", "description": "The total number of allocations this model is assigned across machine learning nodes.", - "required": false, "default": 1 }, "threads_per_allocation": { "type": "int", "description": "The number of threads used by each model allocation during inference.", - "required": false, "default": 1 }, "priority": { "type": "string", "description": "The deployment priority.", - "required": false, "default": "normal" }, "queue_capacity": { "type": "int", "description": "Controls how many inference requests are allowed in the queue at a time.", - "required": false, "default": 1024 }, "timeout": { "type": "time", - "required": false, "description": "Controls the amount of time to wait for the model to deploy.", "default": "20s" }, "wait_for": { "type": "string", - "required": false, "description": "The allocation status for which to wait", "options": [ "starting", diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_data_frame_analytics.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_data_frame_analytics.json index a645c86c67535..8b886d15db5e0 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_data_frame_analytics.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_data_frame_analytics.json @@ -33,17 +33,14 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "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", - "required": false, "description": "True if the data frame analytics should be forcefully stopped" }, "timeout": { "type": "time", - "required": false, "description": "Controls the time to wait until the task has stopped. Defaults to 20 seconds" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_datafeed.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_datafeed.json index 405b1df3fa7ea..172d99a36dd8e 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_datafeed.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_datafeed.json @@ -33,17 +33,14 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "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", - "required": false, "description": "True if the datafeed should be forcefully stopped." }, "timeout": { "type": "time", - "required": false, "description": "Controls the time to wait until a datafeed has stopped. Default to 20 seconds" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_trained_model_deployment.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_trained_model_deployment.json index 0e51bb396bc11..6ee6024979f0e 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_trained_model_deployment.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.stop_trained_model_deployment.json @@ -34,12 +34,10 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "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", - "required": false, "description": "True if the deployment should be forcefully stopped" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.update_trained_model_deployment.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.update_trained_model_deployment.json index 02665223d5540..5e99998600a55 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.update_trained_model_deployment.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.update_trained_model_deployment.json @@ -33,7 +33,6 @@ "params": { "number_of_allocations": { "type": "int", - "required": false, "description": "Update the model deployment to this number of allocations." } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.upgrade_job_snapshot.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.upgrade_job_snapshot.json index 7604eb281bc65..c3a1e8050f4ad 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/ml.upgrade_job_snapshot.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/ml.upgrade_job_snapshot.json @@ -34,12 +34,10 @@ "params": { "timeout": { "type": "time", - "required": false, "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", - "required": false, "description": "Should the request wait until the task is complete before responding to the caller. Default is false." } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/rollup.stop_job.json b/rest-api-spec/src/main/resources/rest-api-spec/api/rollup.stop_job.json index ab18b29ba0e5e..aae459ebe49a8 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/rollup.stop_job.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/rollup.stop_job.json @@ -30,12 +30,10 @@ "params": { "wait_for_completion": { "type": "boolean", - "required": 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", - "required": false, "description": "Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s." } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/security.clear_cached_realms.json b/rest-api-spec/src/main/resources/rest-api-spec/api/security.clear_cached_realms.json index 410e7d8688c92..988dcb6ace94b 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/security.clear_cached_realms.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/security.clear_cached_realms.json @@ -30,8 +30,7 @@ "params": { "usernames": { "type": "list", - "description": "Comma-separated list of usernames to clear from the cache", - "required": false + "description": "Comma-separated list of usernames to clear from the cache" } } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.delete_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.delete_transform.json index a35d47b3f4525..e8bbb58225e88 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.delete_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.delete_transform.json @@ -30,17 +30,14 @@ "params": { "force": { "type": "boolean", - "required": 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", - "required": 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", - "required": false, "description": "Controls the time to wait for the transform deletion" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform.json index a733a78ced743..751f3492a9622 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform.json @@ -36,21 +36,17 @@ "params": { "from": { "type": "int", - "required": false, "description": "skips a number of transform configs, defaults to 0" }, "size": { "type": "int", - "required": false, "description": "specifies a max number of transforms to get, defaults to 100" }, "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)" }, "exclude_generated": { - "required": false, "type": "boolean", "default": false, "description": "Omits fields that are illegal to set on transform PUT" diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform_stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform_stats.json index 544d2d2873c0c..7c0e5e2efec6f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform_stats.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform_stats.json @@ -30,22 +30,18 @@ "params": { "from": { "type": "number", - "required": false, "description": "skips a number of transform stats, defaults to 0" }, "size": { "type": "number", - "required": false, "description": "specifies a max number of transform stats to get, defaults to 100" }, "timeout": { "type": "time", - "required": false, "description": "Controls the time to wait for the stats" }, "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.preview_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.preview_transform.json index 8dc2073c8eab2..11702f9c3a998 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.preview_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.preview_transform.json @@ -41,7 +41,6 @@ "params": { "timeout": { "type": "time", - "required": false, "description": "Controls the time to wait for the preview" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.put_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.put_transform.json index 1d9f94a58746a..7a34c1e68d393 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.put_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.put_transform.json @@ -33,12 +33,10 @@ "params": { "defer_validation": { "type": "boolean", - "required": false, "description": "If validations should be deferred until transform starts, defaults to false." }, "timeout": { "type": "time", - "required": false, "description": "Controls the time to wait for the transform to start" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.reset_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.reset_transform.json index 251975b897aa1..9cdca46a129b0 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.reset_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.reset_transform.json @@ -30,12 +30,10 @@ "params": { "force": { "type": "boolean", - "required": 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", - "required": false, "description": "Controls the time to wait for the transform to reset" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.schedule_now_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.schedule_now_transform.json index 338d9b3d92dac..3847e7c38677a 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.schedule_now_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.schedule_now_transform.json @@ -34,7 +34,6 @@ "params": { "timeout": { "type": "time", - "required": false, "description": "Controls the time to wait for the scheduling to take place" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.start_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.start_transform.json index 903e327226d61..0894c4e9d45a6 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.start_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.start_transform.json @@ -30,12 +30,10 @@ "params": { "from": { "type": "string", - "required": false, "description": "Restricts the set of transformed entities to those changed after this time" }, "timeout": { "type": "time", - "required": false, "description": "Controls the time to wait for the transform to start" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.stop_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.stop_transform.json index e8a8d2515a6bd..de249b7124573 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.stop_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.stop_transform.json @@ -30,27 +30,22 @@ "params": { "force": { "type": "boolean", - "required": false, "description": "Whether to force stop a failed transform or not. Default to false" }, "wait_for_completion": { "type": "boolean", - "required": false, "description": "Whether to wait for the transform to fully stop before returning or not. Default to false" }, "timeout": { "type": "time", - "required": false, "description": "Controls the time to wait until the transform has stopped. Default to 30 seconds" }, "allow_no_match": { "type": "boolean", - "required": false, "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", - "required": false, "description": "Whether to wait for the transform to reach a checkpoint before stopping. Default to false" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.update_transform.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.update_transform.json index d14aaccdc90cb..4aefc0ef55ebc 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.update_transform.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.update_transform.json @@ -34,12 +34,10 @@ "params": { "defer_validation": { "type": "boolean", - "required": false, "description": "If validations should be deferred until transform starts, defaults to false." }, "timeout": { "type": "time", - "required": false, "description": "Controls the time to wait for the update" } }, diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.upgrade_transforms.json b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.upgrade_transforms.json index 4837b438c3aef..cf1d74001edc5 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/transform.upgrade_transforms.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/transform.upgrade_transforms.json @@ -27,12 +27,10 @@ "params": { "dry_run": { "type": "boolean", - "required": false, "description": "Whether to only check for updates but don't execute" }, "timeout": { "type": "time", - "required": false, "description": "Controls the time to wait for the upgrade" } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.execute_watch.json b/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.execute_watch.json index 11a0f4e96f175..cbbb2d4f7e420 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.execute_watch.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.execute_watch.json @@ -41,8 +41,7 @@ "params": { "debug": { "type": "boolean", - "description": "indicates whether the watch should execute in debug mode", - "required": false + "description": "indicates whether the watch should execute in debug mode" } }, "body": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.stats.json index c3164c4e5054c..57f05f2acc23e 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.stats.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.stats.json @@ -52,8 +52,7 @@ }, "emit_stacktraces": { "type": "boolean", - "description": "Emits stack traces of currently running watches", - "required": false + "description": "Emits stack traces of currently running watches" } } } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/xpack.info.json b/rest-api-spec/src/main/resources/rest-api-spec/api/xpack.info.json index 9be8a8a0953d5..20a0903814600 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/xpack.info.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/xpack.info.json @@ -24,7 +24,6 @@ "params": { "human": { "type": "boolean", - "required": false, "description": "Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line. The default value is true.", "default": true },