diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index 05256be8e3..34717a8197 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -1,121 +1,5 @@ { "endpointErrors": { - "cat.aliases": { - "request": [ - "Request: query parameter 'bytes' does not exist in the json spec", - "Request: query parameter 'time' does not exist in the json spec" - ], - "response": [] - }, - "cat.allocation": { - "request": [ - "Request: query parameter 'time' does not exist in the json spec" - ], - "response": [] - }, - "cat.component_templates": { - "request": [ - "Request: query parameter 'bytes' does not exist in the json spec", - "Request: query parameter 'time' does not exist in the json spec" - ], - "response": [] - }, - "cat.count": { - "request": [ - "Request: query parameter 'bytes' does not exist in the json spec", - "Request: query parameter 'time' does not exist in the json spec" - ], - "response": [] - }, - "cat.fielddata": { - "request": [ - "Request: query parameter 'time' does not exist in the json spec" - ], - "response": [] - }, - "cat.health": { - "request": [ - "Request: query parameter 'bytes' does not exist in the json spec" - ], - "response": [] - }, - "cat.master": { - "request": [ - "Request: query parameter 'bytes' does not exist in the json spec", - "Request: query parameter 'time' does not exist in the json spec" - ], - "response": [] - }, - "cat.ml_datafeeds": { - "request": [ - "Request: query parameter 'bytes' does not exist in the json spec" - ], - "response": [] - }, - "cat.nodeattrs": { - "request": [ - "Request: query parameter 'bytes' does not exist in the json spec", - "Request: query parameter 'time' does not exist in the json spec" - ], - "response": [] - }, - "cat.pending_tasks": { - "request": [ - "Request: query parameter 'bytes' does not exist in the json spec" - ], - "response": [] - }, - "cat.plugins": { - "request": [ - "Request: query parameter 'bytes' does not exist in the json spec", - "Request: query parameter 'time' does not exist in the json spec" - ], - "response": [] - }, - "cat.repositories": { - "request": [ - "Request: query parameter 'bytes' does not exist in the json spec", - "Request: query parameter 'time' does not exist in the json spec" - ], - "response": [] - }, - "cat.segments": { - "request": [ - "Request: query parameter 'time' does not exist in the json spec" - ], - "response": [] - }, - "cat.snapshots": { - "request": [ - "Request: query parameter 'bytes' does not exist in the json spec" - ], - "response": [] - }, - "cat.tasks": { - "request": [ - "Request: query parameter 'bytes' does not exist in the json spec" - ], - "response": [] - }, - "cat.templates": { - "request": [ - "Request: query parameter 'bytes' does not exist in the json spec", - "Request: query parameter 'time' does not exist in the json spec" - ], - "response": [] - }, - "cat.thread_pool": { - "request": [ - "Request: query parameter 'bytes' does not exist in the json spec" - ], - "response": [] - }, - "cat.transforms": { - "request": [ - "Request: query parameter 'bytes' does not exist in the json spec" - ], - "response": [] - }, "streams.status": { "request": [ "Request: query parameter 'master_timeout' does not exist in the json spec", diff --git a/specification/_json_spec/cat.aliases.json b/specification/_json_spec/cat.aliases.json index f44d577e3b..9fc78fd6fd 100644 --- a/specification/_json_spec/cat.aliases.json +++ b/specification/_json_spec/cat.aliases.json @@ -59,8 +59,18 @@ }, "master_timeout": { "type": "time", - "description": "Timeout for waiting for new cluster state in case it is blocked", - "default": "30s" + "default": "30s", + "description": "Timeout for waiting for new cluster state in case it is blocked" + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.allocation.json b/specification/_json_spec/cat.allocation.json index bb8420de8a..fa1f591b63 100644 --- a/specification/_json_spec/cat.allocation.json +++ b/specification/_json_spec/cat.allocation.json @@ -38,6 +38,11 @@ "description": "The unit in which to display byte values", "options": ["b", "kb", "mb", "gb", "tb", "pb"] }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] + }, "local": { "type": "boolean", "description": "Return local information, do not retrieve the state from master node (default: false)" diff --git a/specification/_json_spec/cat.component_templates.json b/specification/_json_spec/cat.component_templates.json index 1a53c26bab..a4964a0bc9 100644 --- a/specification/_json_spec/cat.component_templates.json +++ b/specification/_json_spec/cat.component_templates.json @@ -58,6 +58,16 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.count.json b/specification/_json_spec/cat.count.json index ef88d10f74..fc77804834 100644 --- a/specification/_json_spec/cat.count.json +++ b/specification/_json_spec/cat.count.json @@ -50,6 +50,16 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.fielddata.json b/specification/_json_spec/cat.fielddata.json index 8630374a38..d99f49cfd0 100644 --- a/specification/_json_spec/cat.fielddata.json +++ b/specification/_json_spec/cat.fielddata.json @@ -59,6 +59,11 @@ "fields": { "type": "list", "description": "A comma-separated list of fields to return in the output" + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.health.json b/specification/_json_spec/cat.health.json index b540a6dc6a..2d421cbfbf 100644 --- a/specification/_json_spec/cat.health.json +++ b/specification/_json_spec/cat.health.json @@ -50,6 +50,11 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] } } } diff --git a/specification/_json_spec/cat.master.json b/specification/_json_spec/cat.master.json index 33a3f98a46..9531b4795f 100644 --- a/specification/_json_spec/cat.master.json +++ b/specification/_json_spec/cat.master.json @@ -48,6 +48,16 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.ml_data_frame_analytics.json b/specification/_json_spec/cat.ml_data_frame_analytics.json index f22e037b72..c184e31fa8 100644 --- a/specification/_json_spec/cat.ml_data_frame_analytics.json +++ b/specification/_json_spec/cat.ml_data_frame_analytics.json @@ -30,7 +30,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/specification/_json_spec/cat.ml_datafeeds.json b/specification/_json_spec/cat.ml_datafeeds.json index 0099e50a72..3cc24754f3 100644 --- a/specification/_json_spec/cat.ml_datafeeds.json +++ b/specification/_json_spec/cat.ml_datafeeds.json @@ -30,7 +30,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": { @@ -60,6 +59,11 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] } } } diff --git a/specification/_json_spec/cat.ml_jobs.json b/specification/_json_spec/cat.ml_jobs.json index 4f097c20f8..304979056f 100644 --- a/specification/_json_spec/cat.ml_jobs.json +++ b/specification/_json_spec/cat.ml_jobs.json @@ -30,7 +30,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/specification/_json_spec/cat.ml_trained_models.json b/specification/_json_spec/cat.ml_trained_models.json index 34b25ba2e9..f6a7396972 100644 --- a/specification/_json_spec/cat.ml_trained_models.json +++ b/specification/_json_spec/cat.ml_trained_models.json @@ -30,7 +30,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/specification/_json_spec/cat.nodeattrs.json b/specification/_json_spec/cat.nodeattrs.json index 79be8801ef..2d44dccdc5 100644 --- a/specification/_json_spec/cat.nodeattrs.json +++ b/specification/_json_spec/cat.nodeattrs.json @@ -48,6 +48,16 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.pending_tasks.json b/specification/_json_spec/cat.pending_tasks.json index 1db0c59593..bd9553e4d5 100644 --- a/specification/_json_spec/cat.pending_tasks.json +++ b/specification/_json_spec/cat.pending_tasks.json @@ -53,6 +53,11 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] } } } diff --git a/specification/_json_spec/cat.plugins.json b/specification/_json_spec/cat.plugins.json index 7336f9d10c..a7a364be49 100644 --- a/specification/_json_spec/cat.plugins.json +++ b/specification/_json_spec/cat.plugins.json @@ -53,6 +53,16 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.repositories.json b/specification/_json_spec/cat.repositories.json index e45483b701..0baddddacf 100644 --- a/specification/_json_spec/cat.repositories.json +++ b/specification/_json_spec/cat.repositories.json @@ -49,6 +49,16 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.segments.json b/specification/_json_spec/cat.segments.json index e3d3f09b55..ff0945c44c 100644 --- a/specification/_json_spec/cat.segments.json +++ b/specification/_json_spec/cat.segments.json @@ -63,6 +63,11 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.snapshots.json b/specification/_json_spec/cat.snapshots.json index 73e5de45b2..4054e1dd58 100644 --- a/specification/_json_spec/cat.snapshots.json +++ b/specification/_json_spec/cat.snapshots.json @@ -64,6 +64,11 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] } } } diff --git a/specification/_json_spec/cat.tasks.json b/specification/_json_spec/cat.tasks.json index 5cd7e43330..94c54e9194 100644 --- a/specification/_json_spec/cat.tasks.json +++ b/specification/_json_spec/cat.tasks.json @@ -71,6 +71,11 @@ "type": "boolean", "default": false, "description": "If `true`, the request blocks until the task has completed." + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] } } } diff --git a/specification/_json_spec/cat.templates.json b/specification/_json_spec/cat.templates.json index 9592cc6379..d6e33f81e0 100644 --- a/specification/_json_spec/cat.templates.json +++ b/specification/_json_spec/cat.templates.json @@ -58,6 +58,16 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.thread_pool.json b/specification/_json_spec/cat.thread_pool.json index 0a0fb2fde0..32db2c83a7 100644 --- a/specification/_json_spec/cat.thread_pool.json +++ b/specification/_json_spec/cat.thread_pool.json @@ -63,6 +63,11 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] } } } diff --git a/specification/_json_spec/cat.transforms.json b/specification/_json_spec/cat.transforms.json index 6ad5442463..dba1ce927d 100644 --- a/specification/_json_spec/cat.transforms.json +++ b/specification/_json_spec/cat.transforms.json @@ -30,17 +30,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": { @@ -70,6 +67,11 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] } } } diff --git a/specification/_json_spec/inference.delete.json b/specification/_json_spec/inference.delete.json index bb0dd202cf..057aed6cd6 100644 --- a/specification/_json_spec/inference.delete.json +++ b/specification/_json_spec/inference.delete.json @@ -40,13 +40,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/specification/_json_spec/ml.close_job.json b/specification/_json_spec/ml.close_job.json index 58afb5e33e..9bb6332b7c 100644 --- a/specification/_json_spec/ml.close_job.json +++ b/specification/_json_spec/ml.close_job.json @@ -27,12 +27,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/specification/_json_spec/ml.delete_datafeed.json b/specification/_json_spec/ml.delete_datafeed.json index 8cb78ae238..1cac823610 100644 --- a/specification/_json_spec/ml.delete_datafeed.json +++ b/specification/_json_spec/ml.delete_datafeed.json @@ -26,7 +26,6 @@ "params": { "force": { "type": "boolean", - "required": false, "description": "True if the datafeed should be forcefully deleted" } } diff --git a/specification/_json_spec/ml.delete_expired_data.json b/specification/_json_spec/ml.delete_expired_data.json index 54af79e189..adafb23f16 100644 --- a/specification/_json_spec/ml.delete_expired_data.json +++ b/specification/_json_spec/ml.delete_expired_data.json @@ -31,12 +31,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/specification/_json_spec/ml.delete_forecast.json b/specification/_json_spec/ml.delete_forecast.json index 36cd515514..820b370c27 100644 --- a/specification/_json_spec/ml.delete_forecast.json +++ b/specification/_json_spec/ml.delete_forecast.json @@ -40,12 +40,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/specification/_json_spec/ml.delete_trained_model.json b/specification/_json_spec/ml.delete_trained_model.json index b9996c193f..daf0b83ee7 100644 --- a/specification/_json_spec/ml.delete_trained_model.json +++ b/specification/_json_spec/ml.delete_trained_model.json @@ -26,13 +26,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/specification/_json_spec/ml.forecast.json b/specification/_json_spec/ml.forecast.json index 82017a1648..ab562e094e 100644 --- a/specification/_json_spec/ml.forecast.json +++ b/specification/_json_spec/ml.forecast.json @@ -27,17 +27,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/specification/_json_spec/ml.get_data_frame_analytics.json b/specification/_json_spec/ml.get_data_frame_analytics.json index c6a5623fe1..56a2544fac 100644 --- a/specification/_json_spec/ml.get_data_frame_analytics.json +++ b/specification/_json_spec/ml.get_data_frame_analytics.json @@ -30,7 +30,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 }, @@ -45,7 +44,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/specification/_json_spec/ml.get_data_frame_analytics_stats.json b/specification/_json_spec/ml.get_data_frame_analytics_stats.json index 5f455a1fab..06f1eca928 100644 --- a/specification/_json_spec/ml.get_data_frame_analytics_stats.json +++ b/specification/_json_spec/ml.get_data_frame_analytics_stats.json @@ -30,7 +30,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 }, @@ -46,7 +45,6 @@ }, "verbose": { "type": "boolean", - "required": false, "description": "whether the stats response should be verbose", "default": false } diff --git a/specification/_json_spec/ml.get_datafeed_stats.json b/specification/_json_spec/ml.get_datafeed_stats.json index d96770b94e..f89efe2200 100644 --- a/specification/_json_spec/ml.get_datafeed_stats.json +++ b/specification/_json_spec/ml.get_datafeed_stats.json @@ -30,7 +30,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/specification/_json_spec/ml.get_datafeeds.json b/specification/_json_spec/ml.get_datafeeds.json index b635910d17..dc33d432ff 100644 --- a/specification/_json_spec/ml.get_datafeeds.json +++ b/specification/_json_spec/ml.get_datafeeds.json @@ -30,11 +30,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/specification/_json_spec/ml.get_job_stats.json b/specification/_json_spec/ml.get_job_stats.json index 7eba509b7e..f45d9cb9f7 100644 --- a/specification/_json_spec/ml.get_job_stats.json +++ b/specification/_json_spec/ml.get_job_stats.json @@ -30,7 +30,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/specification/_json_spec/ml.get_jobs.json b/specification/_json_spec/ml.get_jobs.json index 0bb11fee46..2ad5df0f9b 100644 --- a/specification/_json_spec/ml.get_jobs.json +++ b/specification/_json_spec/ml.get_jobs.json @@ -30,11 +30,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/specification/_json_spec/ml.get_model_snapshot_upgrade_stats.json b/specification/_json_spec/ml.get_model_snapshot_upgrade_stats.json index 559f28ab04..d868fa96e3 100644 --- a/specification/_json_spec/ml.get_model_snapshot_upgrade_stats.json +++ b/specification/_json_spec/ml.get_model_snapshot_upgrade_stats.json @@ -30,7 +30,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/specification/_json_spec/ml.get_trained_models.json b/specification/_json_spec/ml.get_trained_models.json index b37a5df8e2..d48c5054f5 100644 --- a/specification/_json_spec/ml.get_trained_models.json +++ b/specification/_json_spec/ml.get_trained_models.json @@ -30,40 +30,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/specification/_json_spec/ml.get_trained_models_stats.json b/specification/_json_spec/ml.get_trained_models_stats.json index 23542a2d4a..41f5f40180 100644 --- a/specification/_json_spec/ml.get_trained_models_stats.json +++ b/specification/_json_spec/ml.get_trained_models_stats.json @@ -30,7 +30,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/specification/_json_spec/ml.infer_trained_model.json b/specification/_json_spec/ml.infer_trained_model.json index e2ae1f05f9..b3461333c6 100644 --- a/specification/_json_spec/ml.infer_trained_model.json +++ b/specification/_json_spec/ml.infer_trained_model.json @@ -28,7 +28,6 @@ "params": { "timeout": { "type": "time", - "required": false, "description": "Controls the amount of time to wait for inference results.", "default": "10s" } diff --git a/specification/_json_spec/ml.preview_datafeed.json b/specification/_json_spec/ml.preview_datafeed.json index 17e3a1efdf..e6f29b9963 100644 --- a/specification/_json_spec/ml.preview_datafeed.json +++ b/specification/_json_spec/ml.preview_datafeed.json @@ -31,12 +31,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/specification/_json_spec/ml.put_trained_model.json b/specification/_json_spec/ml.put_trained_model.json index 5807280337..da873e35ee 100644 --- a/specification/_json_spec/ml.put_trained_model.json +++ b/specification/_json_spec/ml.put_trained_model.json @@ -26,13 +26,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/specification/_json_spec/ml.start_data_frame_analytics.json b/specification/_json_spec/ml.start_data_frame_analytics.json index 7eb86979ce..51691d753d 100644 --- a/specification/_json_spec/ml.start_data_frame_analytics.json +++ b/specification/_json_spec/ml.start_data_frame_analytics.json @@ -27,7 +27,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/specification/_json_spec/ml.start_datafeed.json b/specification/_json_spec/ml.start_datafeed.json index 7da8c4fa19..4d0b07ddf2 100644 --- a/specification/_json_spec/ml.start_datafeed.json +++ b/specification/_json_spec/ml.start_datafeed.json @@ -27,17 +27,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/specification/_json_spec/ml.start_trained_model_deployment.json b/specification/_json_spec/ml.start_trained_model_deployment.json index d072c8462c..b5d4f8a7ec 100644 --- a/specification/_json_spec/ml.start_trained_model_deployment.json +++ b/specification/_json_spec/ml.start_trained_model_deployment.json @@ -28,47 +28,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", "started", "fully_allocated"], "default": "started" diff --git a/specification/_json_spec/ml.stop_data_frame_analytics.json b/specification/_json_spec/ml.stop_data_frame_analytics.json index 89f262a66e..21d470ec10 100644 --- a/specification/_json_spec/ml.stop_data_frame_analytics.json +++ b/specification/_json_spec/ml.stop_data_frame_analytics.json @@ -27,17 +27,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/specification/_json_spec/ml.stop_datafeed.json b/specification/_json_spec/ml.stop_datafeed.json index 325a420d4f..80dca45888 100644 --- a/specification/_json_spec/ml.stop_datafeed.json +++ b/specification/_json_spec/ml.stop_datafeed.json @@ -27,17 +27,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/specification/_json_spec/ml.stop_trained_model_deployment.json b/specification/_json_spec/ml.stop_trained_model_deployment.json index e2129f0b51..ecc6dc1628 100644 --- a/specification/_json_spec/ml.stop_trained_model_deployment.json +++ b/specification/_json_spec/ml.stop_trained_model_deployment.json @@ -28,12 +28,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/specification/_json_spec/ml.update_trained_model_deployment.json b/specification/_json_spec/ml.update_trained_model_deployment.json index f8ccb10079..94476779a1 100644 --- a/specification/_json_spec/ml.update_trained_model_deployment.json +++ b/specification/_json_spec/ml.update_trained_model_deployment.json @@ -27,7 +27,6 @@ "params": { "number_of_allocations": { "type": "int", - "required": false, "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 e0463b6e49..afc1b3a1e1 100644 --- a/specification/_json_spec/ml.upgrade_job_snapshot.json +++ b/specification/_json_spec/ml.upgrade_job_snapshot.json @@ -30,12 +30,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/specification/_json_spec/rollup.stop_job.json b/specification/_json_spec/rollup.stop_job.json index ec0d5c1af3..c414699da5 100644 --- a/specification/_json_spec/rollup.stop_job.json +++ b/specification/_json_spec/rollup.stop_job.json @@ -26,12 +26,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/specification/_json_spec/security.clear_cached_realms.json b/specification/_json_spec/security.clear_cached_realms.json index 5b4e06f0b7..98337763c4 100644 --- a/specification/_json_spec/security.clear_cached_realms.json +++ b/specification/_json_spec/security.clear_cached_realms.json @@ -26,8 +26,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/specification/_json_spec/transform.delete_transform.json b/specification/_json_spec/transform.delete_transform.json index 0c8d2ea58a..ac7fade471 100644 --- a/specification/_json_spec/transform.delete_transform.json +++ b/specification/_json_spec/transform.delete_transform.json @@ -26,17 +26,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/specification/_json_spec/transform.get_transform.json b/specification/_json_spec/transform.get_transform.json index 835264067b..c6f9adbc71 100644 --- a/specification/_json_spec/transform.get_transform.json +++ b/specification/_json_spec/transform.get_transform.json @@ -30,21 +30,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/specification/_json_spec/transform.get_transform_stats.json b/specification/_json_spec/transform.get_transform_stats.json index 604be01f72..83e6b5146f 100644 --- a/specification/_json_spec/transform.get_transform_stats.json +++ b/specification/_json_spec/transform.get_transform_stats.json @@ -26,22 +26,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/specification/_json_spec/transform.preview_transform.json b/specification/_json_spec/transform.preview_transform.json index ec2b37e5d3..f624b2f746 100644 --- a/specification/_json_spec/transform.preview_transform.json +++ b/specification/_json_spec/transform.preview_transform.json @@ -31,7 +31,6 @@ "params": { "timeout": { "type": "time", - "required": false, "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 f9fc20f58f..7e9ca901cc 100644 --- a/specification/_json_spec/transform.put_transform.json +++ b/specification/_json_spec/transform.put_transform.json @@ -27,12 +27,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/specification/_json_spec/transform.reset_transform.json b/specification/_json_spec/transform.reset_transform.json index d6af5d6167..ab5baf3fbb 100644 --- a/specification/_json_spec/transform.reset_transform.json +++ b/specification/_json_spec/transform.reset_transform.json @@ -26,12 +26,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/specification/_json_spec/transform.schedule_now_transform.json b/specification/_json_spec/transform.schedule_now_transform.json index fbfaf2935b..77bcb04923 100644 --- a/specification/_json_spec/transform.schedule_now_transform.json +++ b/specification/_json_spec/transform.schedule_now_transform.json @@ -28,7 +28,6 @@ "params": { "timeout": { "type": "time", - "required": false, "description": "Controls the time to wait for the scheduling to take place" } } diff --git a/specification/_json_spec/transform.start_transform.json b/specification/_json_spec/transform.start_transform.json index c8f85d1edb..a7759fe7fb 100644 --- a/specification/_json_spec/transform.start_transform.json +++ b/specification/_json_spec/transform.start_transform.json @@ -26,12 +26,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/specification/_json_spec/transform.stop_transform.json b/specification/_json_spec/transform.stop_transform.json index 4917c198e2..768ee7c0d1 100644 --- a/specification/_json_spec/transform.stop_transform.json +++ b/specification/_json_spec/transform.stop_transform.json @@ -26,27 +26,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/specification/_json_spec/transform.update_transform.json b/specification/_json_spec/transform.update_transform.json index 88a48f0bd6..ce427bec73 100644 --- a/specification/_json_spec/transform.update_transform.json +++ b/specification/_json_spec/transform.update_transform.json @@ -28,12 +28,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/specification/_json_spec/transform.upgrade_transforms.json b/specification/_json_spec/transform.upgrade_transforms.json index 93e902bef4..e53ddd4271 100644 --- a/specification/_json_spec/transform.upgrade_transforms.json +++ b/specification/_json_spec/transform.upgrade_transforms.json @@ -21,12 +21,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/specification/_json_spec/watcher.execute_watch.json b/specification/_json_spec/watcher.execute_watch.json index f2039a311e..35d4b695e6 100644 --- a/specification/_json_spec/watcher.execute_watch.json +++ b/specification/_json_spec/watcher.execute_watch.json @@ -31,8 +31,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/specification/_json_spec/watcher.stats.json b/specification/_json_spec/watcher.stats.json index 0d7cf60fc5..034dd70254 100644 --- a/specification/_json_spec/watcher.stats.json +++ b/specification/_json_spec/watcher.stats.json @@ -46,8 +46,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/specification/_json_spec/xpack.info.json b/specification/_json_spec/xpack.info.json index 777f76b835..b1e11ae4cc 100644 --- a/specification/_json_spec/xpack.info.json +++ b/specification/_json_spec/xpack.info.json @@ -20,7 +20,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 },