From 8f7d32ff46f24c2caf2b5cbf2678f62d3a120cc2 Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Wed, 17 Sep 2025 15:26:16 +0400 Subject: [PATCH] [8.19] rest-api-spec: remove required: false for query parameters (#134658) --- .../api/cat.ml_data_frame_analytics.json | 1 - .../rest-api-spec/api/cat.ml_datafeeds.json | 1 - .../resources/rest-api-spec/api/cat.ml_jobs.json | 1 - .../rest-api-spec/api/cat.ml_trained_models.json | 1 - .../resources/rest-api-spec/api/cat.transforms.json | 3 --- .../rest-api-spec/api/inference.delete.json | 6 ++---- .../resources/rest-api-spec/api/ml.close_job.json | 2 -- .../rest-api-spec/api/ml.delete_datafeed.json | 1 - .../rest-api-spec/api/ml.delete_expired_data.json | 2 -- .../rest-api-spec/api/ml.delete_forecast.json | 2 -- .../rest-api-spec/api/ml.delete_trained_model.json | 2 -- .../resources/rest-api-spec/api/ml.forecast.json | 3 --- .../api/ml.get_data_frame_analytics.json | 2 -- .../api/ml.get_data_frame_analytics_stats.json | 2 -- .../rest-api-spec/api/ml.get_datafeed_stats.json | 1 - .../rest-api-spec/api/ml.get_datafeeds.json | 2 -- .../rest-api-spec/api/ml.get_job_stats.json | 1 - .../resources/rest-api-spec/api/ml.get_jobs.json | 2 -- .../api/ml.get_model_snapshot_upgrade_stats.json | 1 - .../rest-api-spec/api/ml.get_trained_models.json | 8 -------- .../api/ml.get_trained_models_stats.json | 1 - .../rest-api-spec/api/ml.infer_trained_model.json | 1 - .../rest-api-spec/api/ml.preview_datafeed.json | 2 -- .../rest-api-spec/api/ml.put_trained_model.json | 2 -- .../api/ml.start_data_frame_analytics.json | 1 - .../rest-api-spec/api/ml.start_datafeed.json | 3 --- .../api/ml.start_trained_model_deployment.json | 12 ++---------- .../api/ml.stop_data_frame_analytics.json | 3 --- .../rest-api-spec/api/ml.stop_datafeed.json | 3 --- .../api/ml.stop_trained_model_deployment.json | 2 -- .../api/ml.update_trained_model_deployment.json | 1 - .../rest-api-spec/api/ml.upgrade_job_snapshot.json | 2 -- .../resources/rest-api-spec/api/rollup.stop_job.json | 2 -- .../api/security.clear_cached_realms.json | 3 +-- .../api/transform.delete_transform.json | 3 --- .../rest-api-spec/api/transform.get_transform.json | 4 ---- .../api/transform.get_transform_stats.json | 4 ---- .../api/transform.preview_transform.json | 1 - .../rest-api-spec/api/transform.put_transform.json | 2 -- .../rest-api-spec/api/transform.reset_transform.json | 2 -- .../api/transform.schedule_now_transform.json | 1 - .../rest-api-spec/api/transform.start_transform.json | 2 -- .../rest-api-spec/api/transform.stop_transform.json | 5 ----- .../api/transform.update_transform.json | 2 -- .../api/transform.upgrade_transforms.json | 2 -- .../rest-api-spec/api/watcher.execute_watch.json | 3 +-- .../resources/rest-api-spec/api/watcher.stats.json | 3 +-- .../main/resources/rest-api-spec/api/xpack.info.json | 1 - 48 files changed, 7 insertions(+), 110 deletions(-) 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 e138d1c47a17d..366fe0f65afd8 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 d833768c5b1d9..b2154b8392dd3 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 7262fec8cc509..63a05bd974e72 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 951473ac9dc07..35f961015067e 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 5dac1eda56915..7fb5f3be27b09 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/inference.delete.json b/rest-api-spec/src/main/resources/rest-api-spec/api/inference.delete.json index 56ca78d897040..4b4905bf612c4 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 1c4481f4c0361..3afa564015743 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 e19ef272d4a55..558d11a3e4390 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 ebf6c1cd89c2c..c79dbb19b7462 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 c1741fb3a308c..71196ec133716 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 97ba89863af5b..d156cd4cd1aa6 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 6dc99cabc3f93..2ec27b882a439 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 6d9232525657d..034dca53dedb2 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 060cc6c435581..3b0e43c049d98 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 6bbf752a34eb0..feb3ba4518bff 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 7566311462f3c..ebef372af1e23 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 81c40da45a343..852fa807770dc 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 c5e13af0ab2cf..4d56e75be0197 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 9035276b9efe8..601f3fdb71faa 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 d0280679fc90d..f960fff05d5cc 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,47 +36,39 @@ "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." }, "include_model_definition": { "type": "boolean", - "required": false, "description": "Should the full model definition be included in the results. These definitions can be large. So be cautious when including them. Defaults to false.", "default": false, "deprecated": true }, "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 20817d0528368..38e7e76d76b38 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 8b4f62f16aee8..7ef0cc7ef52a1 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 @@ -51,7 +51,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 bdba6c9abc5b7..e3aba8b50c6fa 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 5767313b35326..57d3ecbf35528 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 b51c15385b813..e3504a37e77cb 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 9bfcc2776865c..299fec8cbc52c 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 d808a9e281c64..2891432bc2578 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 9745ea2809798..c65e2cf5d12e8 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 4ea773d315777..07ede870d38e1 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 b65d9cfeccf13..dcff856260b7a 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 83de036997c2a..cfa56bd3f1880 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 874aa4b68db7b..15f6ac39ac7c3 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 ab09ec4f17f13..9f0d605190886 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 c252fbe19abdb..19a5fd19fd6bf 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 569bb300e9468..232728790717c 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 5104684d22226..d01981eb84888 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 bf9451bdb5679..0e8a887cab93b 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 04453fb5b8361..411be11388e37 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 7911fcb8e2d34..1c618dd316143 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 ead45231b32bf..b8946c65e1447 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 a0acf19dc5b49..d7d4a7c2b90a6 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 638c5eb771644..ca32d93bac3ba 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 0c31ede0e29b9..f824205829699 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 e2aa92dd7e07f..94658ad776da9 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 e22be5fd54496..cd8e6586531f2 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 3a97f9d09defd..6eff5dedbcfca 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 57afa07a11e35..68f53d36b295d 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 f5ade417f89d9..d33b5666b7201 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 },