diff --git a/output/schema/schema.json b/output/schema/schema.json index dbffa0b55a..2f762e493a 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -644,6 +644,38 @@ } ] }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Get circuit breakers statistics", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO", + "name": "cat.circuit_breaker", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "text/plain", + "application/json" + ], + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_cat/circuit_breaker" + }, + { + "methods": [ + "GET" + ], + "path": "/_cat/circuit_breaker/{circuit_breaker_patterns}" + } + ] + }, { "availability": { "serverless": { @@ -7257,6 +7289,33 @@ } ] }, + { + "availability": { + "stack": { + "featureFlag": "random_sampling" + } + }, + "description": "Delete sampling configuration for an index or data stream", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-sample-configuration", + "name": "indices.delete_sample_configuration", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "DELETE" + ], + "path": "/{index}/_sample/config" + } + ] + }, { "availability": { "stack": { @@ -7817,6 +7876,30 @@ } ] }, + { + "availability": { + "stack": { + "featureFlag": "random_sampling" + } + }, + "description": "Get sampling configurations for all indices and data streams", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-all-sample-configuration", + "name": "indices.get_all_sample_configuration", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_sample/config" + } + ] + }, { "availability": { "serverless": { @@ -8274,6 +8357,30 @@ } ] }, + { + "availability": { + "stack": { + "featureFlag": "random_sampling" + } + }, + "description": "Get sampling configuration for an index or data stream", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample-configuration", + "name": "indices.get_sample_configuration", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/{index}/_sample/config" + } + ] + }, { "availability": { "stack": { @@ -8917,8 +9024,7 @@ { "availability": { "stack": { - "stability": "experimental", - "visibility": "public" + "featureFlag": "random_sampling" } }, "description": "Configure sampling for an index or data stream", diff --git a/specification/_json_spec/cat.circuit_breaker.json b/specification/_json_spec/cat.circuit_breaker.json new file mode 100644 index 0000000000..1d6195849c --- /dev/null +++ b/specification/_json_spec/cat.circuit_breaker.json @@ -0,0 +1,76 @@ +{ + "cat.circuit_breaker": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO", + "description": "Get circuit breakers statistics" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["text/plain", "application/json"] + }, + "url": { + "paths": [ + { + "path": "/_cat/circuit_breaker", + "methods": ["GET"] + }, + { + "path": "/_cat/circuit_breaker/{circuit_breaker_patterns}", + "methods": ["GET"], + "parts": { + "circuit_breaker_patterns": { + "type": "list", + "description": "A comma-separated list of regular-expressions to filter the circuit breakers in the output" + } + } + } + ] + }, + "params": { + "format": { + "type": "string", + "default": "text", + "description": "a short version of the Accept header, e.g. json, yaml" + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] + }, + "local": { + "type": "boolean", + "default": false, + "description": "Return local information, do not retrieve the state from master node (default: false)" + }, + "master_timeout": { + "type": "time", + "default": "30s", + "description": "Explicit operation timeout for connection to master node" + }, + "h": { + "type": "list", + "description": "Comma-separated list of column names to display" + }, + "help": { + "type": "boolean", + "description": "Return help information", + "default": false + }, + "s": { + "type": "list", + "description": "Comma-separated list of column names or column aliases to sort by" + }, + "v": { + "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/clear_scroll.json b/specification/_json_spec/clear_scroll.json index ae8974a419..72cf6c59df 100644 --- a/specification/_json_spec/clear_scroll.json +++ b/specification/_json_spec/clear_scroll.json @@ -33,7 +33,6 @@ } ] }, - "params": {}, "body": { "description": "A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter", "required": false diff --git a/specification/_json_spec/close_point_in_time.json b/specification/_json_spec/close_point_in_time.json index 19dec7215b..828030f72c 100644 --- a/specification/_json_spec/close_point_in_time.json +++ b/specification/_json_spec/close_point_in_time.json @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "a point-in-time id to close", "required": true diff --git a/specification/_json_spec/cluster.info.json b/specification/_json_spec/cluster.info.json index b551d045b2..ace02dab4c 100644 --- a/specification/_json_spec/cluster.info.json +++ b/specification/_json_spec/cluster.info.json @@ -23,7 +23,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/cluster.remote_info.json b/specification/_json_spec/cluster.remote_info.json index 936da90e14..4a9f5e4469 100644 --- a/specification/_json_spec/cluster.remote_info.json +++ b/specification/_json_spec/cluster.remote_info.json @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/connector.secret_delete.json b/specification/_json_spec/connector.secret_delete.json index 5ec1ebd7c1..47cb2c5660 100644 --- a/specification/_json_spec/connector.secret_delete.json +++ b/specification/_json_spec/connector.secret_delete.json @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/connector.secret_get.json b/specification/_json_spec/connector.secret_get.json index 2d8e691d22..b1f3f7315c 100644 --- a/specification/_json_spec/connector.secret_get.json +++ b/specification/_json_spec/connector.secret_get.json @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/connector.secret_post.json b/specification/_json_spec/connector.secret_post.json index e769fe3961..078d0d2bb3 100644 --- a/specification/_json_spec/connector.secret_post.json +++ b/specification/_json_spec/connector.secret_post.json @@ -17,7 +17,6 @@ } ] }, - "params": {}, "body": { "description": "The secret value to store", "required": true diff --git a/specification/_json_spec/connector.secret_put.json b/specification/_json_spec/connector.secret_put.json index e245263424..0f1a134071 100644 --- a/specification/_json_spec/connector.secret_put.json +++ b/specification/_json_spec/connector.secret_put.json @@ -23,7 +23,6 @@ } ] }, - "params": {}, "body": { "description": "The secret value to store", "required": true diff --git a/specification/_json_spec/connector.sync_job_list.json b/specification/_json_spec/connector.sync_job_list.json index 0b74d27d55..0c67e9cbab 100644 --- a/specification/_json_spec/connector.sync_job_list.json +++ b/specification/_json_spec/connector.sync_job_list.json @@ -29,8 +29,17 @@ "description": "specifies a max number of results to get (default: 100)" }, "status": { - "type": "string", - "description": "Sync job status, which sync jobs are fetched for" + "type": "enum", + "description": "A sync job status to fetch connector sync jobs for", + "options": [ + "canceling", + "canceled", + "completed", + "error", + "in_progress", + "pending", + "suspended" + ] }, "connector_id": { "type": "string", diff --git a/specification/_json_spec/dangling_indices.list_dangling_indices.json b/specification/_json_spec/dangling_indices.list_dangling_indices.json index 3825571937..879b5eb51f 100644 --- a/specification/_json_spec/dangling_indices.list_dangling_indices.json +++ b/specification/_json_spec/dangling_indices.list_dangling_indices.json @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/esql.async_query.json b/specification/_json_spec/esql.async_query.json index 737b54a72b..294a6d8529 100644 --- a/specification/_json_spec/esql.async_query.json +++ b/specification/_json_spec/esql.async_query.json @@ -20,8 +20,18 @@ }, "params": { "format": { - "type": "string", - "description": "a short version of the Accept header, e.g. json, yaml" + "type": "enum", + "description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.\n\nFor async requests, nothing will be returned if the async query doesn't finish within the timeout.\nThe query ID and running status are available in the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively.", + "options": [ + "csv", + "json", + "tsv", + "txt", + "yaml", + "cbor", + "smile", + "arrow" + ] }, "delimiter": { "type": "string", diff --git a/specification/_json_spec/esql.async_query_get.json b/specification/_json_spec/esql.async_query_get.json index 9b3e99ad40..abe3d0e6d3 100644 --- a/specification/_json_spec/esql.async_query_get.json +++ b/specification/_json_spec/esql.async_query_get.json @@ -25,8 +25,18 @@ }, "params": { "format": { - "type": "string", - "description": "a short version of the Accept header, e.g. json, yaml" + "type": "enum", + "description": "A short version of the Accept header, for example `json` or `yaml`.", + "options": [ + "csv", + "json", + "tsv", + "txt", + "yaml", + "cbor", + "smile", + "arrow" + ] }, "wait_for_completion_timeout": { "type": "time", diff --git a/specification/_json_spec/esql.query.json b/specification/_json_spec/esql.query.json index 739c4652bd..54370e33b3 100644 --- a/specification/_json_spec/esql.query.json +++ b/specification/_json_spec/esql.query.json @@ -20,8 +20,18 @@ }, "params": { "format": { - "type": "string", - "description": "a short version of the Accept header, e.g. json, yaml" + "type": "enum", + "description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.", + "options": [ + "csv", + "json", + "tsv", + "txt", + "yaml", + "cbor", + "smile", + "arrow" + ] }, "delimiter": { "type": "string", diff --git a/specification/_json_spec/fleet.delete_secret.json b/specification/_json_spec/fleet.delete_secret.json index 94a09cb64f..db80476d55 100644 --- a/specification/_json_spec/fleet.delete_secret.json +++ b/specification/_json_spec/fleet.delete_secret.json @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/fleet.get_secret.json b/specification/_json_spec/fleet.get_secret.json index 54535caa76..5eb05e8ea0 100644 --- a/specification/_json_spec/fleet.get_secret.json +++ b/specification/_json_spec/fleet.get_secret.json @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/fleet.msearch.json b/specification/_json_spec/fleet.msearch.json index 9e9377b994..d6e1ed8f32 100644 --- a/specification/_json_spec/fleet.msearch.json +++ b/specification/_json_spec/fleet.msearch.json @@ -28,7 +28,6 @@ } ] }, - "params": {}, "body": { "description": "The request definitions (metadata-fleet search request definition pairs), separated by newlines", "required": true, diff --git a/specification/_json_spec/fleet.post_secret.json b/specification/_json_spec/fleet.post_secret.json index a6552ddae2..898a245003 100644 --- a/specification/_json_spec/fleet.post_secret.json +++ b/specification/_json_spec/fleet.post_secret.json @@ -17,7 +17,6 @@ } ] }, - "params": {}, "body": { "description": "The secret value to store", "required": true diff --git a/specification/_json_spec/get_script_context.json b/specification/_json_spec/get_script_context.json index 3c4b4e2f6a..0852f9cc10 100644 --- a/specification/_json_spec/get_script_context.json +++ b/specification/_json_spec/get_script_context.json @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/get_script_languages.json b/specification/_json_spec/get_script_languages.json index dc9b0727d0..11c7f539e6 100644 --- a/specification/_json_spec/get_script_languages.json +++ b/specification/_json_spec/get_script_languages.json @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/ilm.get_status.json b/specification/_json_spec/ilm.get_status.json index 5e155b241f..cd4b2d5c5b 100644 --- a/specification/_json_spec/ilm.get_status.json +++ b/specification/_json_spec/ilm.get_status.json @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/ilm.move_to_step.json b/specification/_json_spec/ilm.move_to_step.json index 5f3554637c..a8ce667e77 100644 --- a/specification/_json_spec/ilm.move_to_step.json +++ b/specification/_json_spec/ilm.move_to_step.json @@ -24,7 +24,6 @@ } ] }, - "params": {}, "body": { "description": "The new lifecycle step to move to", "required": true diff --git a/specification/_json_spec/ilm.remove_policy.json b/specification/_json_spec/ilm.remove_policy.json index 9da56073a8..2adf8277ed 100644 --- a/specification/_json_spec/ilm.remove_policy.json +++ b/specification/_json_spec/ilm.remove_policy.json @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/ilm.retry.json b/specification/_json_spec/ilm.retry.json index 80eb6a3362..59d88557f2 100644 --- a/specification/_json_spec/ilm.retry.json +++ b/specification/_json_spec/ilm.retry.json @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/indices.delete_sample_configuration.json b/specification/_json_spec/indices.delete_sample_configuration.json new file mode 100644 index 0000000000..6302e794cd --- /dev/null +++ b/specification/_json_spec/indices.delete_sample_configuration.json @@ -0,0 +1,39 @@ +{ + "indices.delete_sample_configuration": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-sample-configuration", + "description": "Delete sampling configuration for an index or data stream" + }, + "stability": "experimental", + "visibility": "feature_flag", + "feature_flag": "random_sampling", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/{index}/_sample/config", + "methods": ["DELETE"], + "parts": { + "index": { + "type": "string", + "description": "The name of a data stream or index" + } + } + } + ] + }, + "params": { + "master_timeout": { + "type": "time", + "description": "Timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Timeout for the request" + } + } + } +} diff --git a/specification/_json_spec/indices.downsample.json b/specification/_json_spec/indices.downsample.json index a0bb5adb58..c5de52f532 100644 --- a/specification/_json_spec/indices.downsample.json +++ b/specification/_json_spec/indices.downsample.json @@ -30,7 +30,6 @@ } ] }, - "params": {}, "body": { "description": "The downsampling configuration", "required": true diff --git a/specification/_json_spec/indices.get_all_sample_configuration.json b/specification/_json_spec/indices.get_all_sample_configuration.json new file mode 100644 index 0000000000..655eab365b --- /dev/null +++ b/specification/_json_spec/indices.get_all_sample_configuration.json @@ -0,0 +1,28 @@ +{ + "indices.get_all_sample_configuration": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-all-sample-configuration", + "description": "Get sampling configurations for all indices and data streams" + }, + "stability": "experimental", + "visibility": "feature_flag", + "feature_flag": "random_sampling", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_sample/config", + "methods": ["GET"] + } + ] + }, + "params": { + "master_timeout": { + "type": "time", + "description": "Timeout for connection to master node" + } + } + } +} diff --git a/specification/_json_spec/indices.get_sample_configuration.json b/specification/_json_spec/indices.get_sample_configuration.json new file mode 100644 index 0000000000..97dcac0ad6 --- /dev/null +++ b/specification/_json_spec/indices.get_sample_configuration.json @@ -0,0 +1,34 @@ +{ + "indices.get_sample_configuration": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample-configuration", + "description": "Get sampling configuration for an index or data stream" + }, + "stability": "experimental", + "visibility": "feature_flag", + "feature_flag": "random_sampling", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/{index}/_sample/config", + "methods": ["GET"], + "parts": { + "index": { + "type": "string", + "description": "The name of a data stream or index" + } + } + } + ] + }, + "params": { + "master_timeout": { + "type": "time", + "description": "Timeout for connection to master node" + } + } + } +} diff --git a/specification/_json_spec/indices.modify_data_stream.json b/specification/_json_spec/indices.modify_data_stream.json index 175778733c..185cf9ce6b 100644 --- a/specification/_json_spec/indices.modify_data_stream.json +++ b/specification/_json_spec/indices.modify_data_stream.json @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "The data stream modifications", "required": true diff --git a/specification/_json_spec/indices.put_sample_configuration.json b/specification/_json_spec/indices.put_sample_configuration.json index 143156c5a9..80576f29c4 100644 --- a/specification/_json_spec/indices.put_sample_configuration.json +++ b/specification/_json_spec/indices.put_sample_configuration.json @@ -5,7 +5,8 @@ "description": "Configure sampling for an index or data stream" }, "stability": "experimental", - "visibility": "public", + "visibility": "feature_flag", + "feature_flag": "random_sampling", "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/info.json b/specification/_json_spec/info.json index 967ea0a2ee..7da080467f 100644 --- a/specification/_json_spec/info.json +++ b/specification/_json_spec/info.json @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/ingest.get_geoip_database.json b/specification/_json_spec/ingest.get_geoip_database.json index ed897e3dd8..569c2d0633 100644 --- a/specification/_json_spec/ingest.get_geoip_database.json +++ b/specification/_json_spec/ingest.get_geoip_database.json @@ -26,7 +26,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/ingest.get_ip_location_database.json b/specification/_json_spec/ingest.get_ip_location_database.json index d56ec86582..86019c6406 100644 --- a/specification/_json_spec/ingest.get_ip_location_database.json +++ b/specification/_json_spec/ingest.get_ip_location_database.json @@ -26,7 +26,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/ingest.processor_grok.json b/specification/_json_spec/ingest.processor_grok.json index 00a8c53ccb..3162c2621b 100644 --- a/specification/_json_spec/ingest.processor_grok.json +++ b/specification/_json_spec/ingest.processor_grok.json @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/license.get_basic_status.json b/specification/_json_spec/license.get_basic_status.json index e8deb44b16..6b01af0f56 100644 --- a/specification/_json_spec/license.get_basic_status.json +++ b/specification/_json_spec/license.get_basic_status.json @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/license.get_trial_status.json b/specification/_json_spec/license.get_trial_status.json index 525217ef51..1034f0fd2e 100644 --- a/specification/_json_spec/license.get_trial_status.json +++ b/specification/_json_spec/license.get_trial_status.json @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/logstash.delete_pipeline.json b/specification/_json_spec/logstash.delete_pipeline.json index 15b62e7d6a..6a550e4c8c 100644 --- a/specification/_json_spec/logstash.delete_pipeline.json +++ b/specification/_json_spec/logstash.delete_pipeline.json @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/logstash.get_pipeline.json b/specification/_json_spec/logstash.get_pipeline.json index a2e820a12f..b109c37ecd 100644 --- a/specification/_json_spec/logstash.get_pipeline.json +++ b/specification/_json_spec/logstash.get_pipeline.json @@ -26,7 +26,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/logstash.put_pipeline.json b/specification/_json_spec/logstash.put_pipeline.json index 1ffc727cb4..933a2544c2 100644 --- a/specification/_json_spec/logstash.put_pipeline.json +++ b/specification/_json_spec/logstash.put_pipeline.json @@ -24,7 +24,6 @@ } ] }, - "params": {}, "body": { "description": "The Pipeline to add or update", "required": true diff --git a/specification/_json_spec/migration.deprecations.json b/specification/_json_spec/migration.deprecations.json index b900c5eabb..8ef857188a 100644 --- a/specification/_json_spec/migration.deprecations.json +++ b/specification/_json_spec/migration.deprecations.json @@ -26,7 +26,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/migration.get_feature_upgrade_status.json b/specification/_json_spec/migration.get_feature_upgrade_status.json index 1d47922f5e..24c338de86 100644 --- a/specification/_json_spec/migration.get_feature_upgrade_status.json +++ b/specification/_json_spec/migration.get_feature_upgrade_status.json @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/migration.post_feature_upgrade.json b/specification/_json_spec/migration.post_feature_upgrade.json index 8d0d303af3..68b0477d46 100644 --- a/specification/_json_spec/migration.post_feature_upgrade.json +++ b/specification/_json_spec/migration.post_feature_upgrade.json @@ -16,7 +16,6 @@ "methods": ["POST"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/ml.estimate_model_memory.json b/specification/_json_spec/ml.estimate_model_memory.json index fa61c4e10d..5aa2ab6022 100644 --- a/specification/_json_spec/ml.estimate_model_memory.json +++ b/specification/_json_spec/ml.estimate_model_memory.json @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "The analysis config, plus cardinality estimates for fields it references", "required": true diff --git a/specification/_json_spec/ml.explain_data_frame_analytics.json b/specification/_json_spec/ml.explain_data_frame_analytics.json index 0887f1e7fa..8912c4b543 100644 --- a/specification/_json_spec/ml.explain_data_frame_analytics.json +++ b/specification/_json_spec/ml.explain_data_frame_analytics.json @@ -14,8 +14,7 @@ "paths": [ { "path": "/_ml/data_frame/analytics/_explain", - "methods": ["GET", "POST"], - "parts": {} + "methods": ["GET", "POST"] }, { "path": "/_ml/data_frame/analytics/{id}/_explain", diff --git a/specification/_json_spec/ml.get_trained_models.json b/specification/_json_spec/ml.get_trained_models.json index d48c5054f5..4663e5047c 100644 --- a/specification/_json_spec/ml.get_trained_models.json +++ b/specification/_json_spec/ml.get_trained_models.json @@ -34,8 +34,15 @@ "default": true }, "include": { - "type": "string", - "description": "A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none." + "type": "enum", + "description": "A comma delimited string of optional fields to include in the response\nbody.", + "options": [ + "definition", + "feature_importance_baseline", + "hyperparameters", + "total_feature_importance", + "definition_status" + ] }, "decompress_definition": { "type": "boolean", diff --git a/specification/_json_spec/ml.preview_data_frame_analytics.json b/specification/_json_spec/ml.preview_data_frame_analytics.json index 8aa1861168..cac75e8c64 100644 --- a/specification/_json_spec/ml.preview_data_frame_analytics.json +++ b/specification/_json_spec/ml.preview_data_frame_analytics.json @@ -14,8 +14,7 @@ "paths": [ { "path": "/_ml/data_frame/analytics/_preview", - "methods": ["GET", "POST"], - "parts": {} + "methods": ["GET", "POST"] }, { "path": "/_ml/data_frame/analytics/{id}/_preview", diff --git a/specification/_json_spec/ml.start_trained_model_deployment.json b/specification/_json_spec/ml.start_trained_model_deployment.json index b5d4f8a7ec..7e6c22fe23 100644 --- a/specification/_json_spec/ml.start_trained_model_deployment.json +++ b/specification/_json_spec/ml.start_trained_model_deployment.json @@ -45,9 +45,9 @@ "default": 1 }, "priority": { - "type": "string", + "type": "enum", "description": "The deployment priority.", - "default": "normal" + "options": ["normal", "low"] }, "queue_capacity": { "type": "int", @@ -60,9 +60,9 @@ "default": "20s" }, "wait_for": { - "type": "string", - "description": "The allocation status for which to wait", - "options": ["starting", "started", "fully_allocated"], + "type": "enum", + "description": "Specifies the allocation status to wait for before returning.", + "options": ["started", "starting", "fully_allocated"], "default": "started" } }, diff --git a/specification/_json_spec/ml.update_model_snapshot.json b/specification/_json_spec/ml.update_model_snapshot.json index 12d6b5c941..3244baf054 100644 --- a/specification/_json_spec/ml.update_model_snapshot.json +++ b/specification/_json_spec/ml.update_model_snapshot.json @@ -28,7 +28,6 @@ } ] }, - "params": {}, "body": { "description": "The model snapshot properties to update", "required": true diff --git a/specification/_json_spec/ml.validate.json b/specification/_json_spec/ml.validate.json index 20f6f97b32..8509daf94f 100644 --- a/specification/_json_spec/ml.validate.json +++ b/specification/_json_spec/ml.validate.json @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "The job config", "required": true diff --git a/specification/_json_spec/ml.validate_detector.json b/specification/_json_spec/ml.validate_detector.json index 363594770d..31983b3a80 100644 --- a/specification/_json_spec/ml.validate_detector.json +++ b/specification/_json_spec/ml.validate_detector.json @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "The detector", "required": true diff --git a/specification/_json_spec/ping.json b/specification/_json_spec/ping.json index ab81e9c84d..57a6898080 100644 --- a/specification/_json_spec/ping.json +++ b/specification/_json_spec/ping.json @@ -16,7 +16,6 @@ "methods": ["HEAD"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/scripts_painless_execute.json b/specification/_json_spec/scripts_painless_execute.json index f096b50fb1..da2a661f57 100644 --- a/specification/_json_spec/scripts_painless_execute.json +++ b/specification/_json_spec/scripts_painless_execute.json @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "The script to execute", "required": true diff --git a/specification/_json_spec/security.authenticate.json b/specification/_json_spec/security.authenticate.json index 851f230cce..0ddb4d539a 100644 --- a/specification/_json_spec/security.authenticate.json +++ b/specification/_json_spec/security.authenticate.json @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.clear_api_key_cache.json b/specification/_json_spec/security.clear_api_key_cache.json index fbb35f60aa..31a5dea20b 100644 --- a/specification/_json_spec/security.clear_api_key_cache.json +++ b/specification/_json_spec/security.clear_api_key_cache.json @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.clear_cached_privileges.json b/specification/_json_spec/security.clear_cached_privileges.json index a84ca7c980..24a24373bf 100644 --- a/specification/_json_spec/security.clear_cached_privileges.json +++ b/specification/_json_spec/security.clear_cached_privileges.json @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.clear_cached_roles.json b/specification/_json_spec/security.clear_cached_roles.json index 812be85bb6..e272a55720 100644 --- a/specification/_json_spec/security.clear_cached_roles.json +++ b/specification/_json_spec/security.clear_cached_roles.json @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.clear_cached_service_tokens.json b/specification/_json_spec/security.clear_cached_service_tokens.json index 5411081ad2..f1c99e842b 100644 --- a/specification/_json_spec/security.clear_cached_service_tokens.json +++ b/specification/_json_spec/security.clear_cached_service_tokens.json @@ -30,7 +30,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.create_cross_cluster_api_key.json b/specification/_json_spec/security.create_cross_cluster_api_key.json index 00a2816d76..4be79c09a8 100644 --- a/specification/_json_spec/security.create_cross_cluster_api_key.json +++ b/specification/_json_spec/security.create_cross_cluster_api_key.json @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "The request to create a cross-cluster API key", "required": true diff --git a/specification/_json_spec/security.delegate_pki.json b/specification/_json_spec/security.delegate_pki.json index 705a2de57f..1908994c0f 100644 --- a/specification/_json_spec/security.delegate_pki.json +++ b/specification/_json_spec/security.delegate_pki.json @@ -17,7 +17,6 @@ } ] }, - "params": {}, "body": { "description": "The X509Certificate chain.", "required": true diff --git a/specification/_json_spec/security.get_builtin_privileges.json b/specification/_json_spec/security.get_builtin_privileges.json index 7bb1b04eb4..f12d06b99f 100644 --- a/specification/_json_spec/security.get_builtin_privileges.json +++ b/specification/_json_spec/security.get_builtin_privileges.json @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.get_privileges.json b/specification/_json_spec/security.get_privileges.json index 19c657e8bd..97d5715616 100644 --- a/specification/_json_spec/security.get_privileges.json +++ b/specification/_json_spec/security.get_privileges.json @@ -40,7 +40,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.get_role.json b/specification/_json_spec/security.get_role.json index 0dc0f0bc3e..8dece32e9a 100644 --- a/specification/_json_spec/security.get_role.json +++ b/specification/_json_spec/security.get_role.json @@ -26,7 +26,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.get_role_mapping.json b/specification/_json_spec/security.get_role_mapping.json index afa9d88c96..0d195ac767 100644 --- a/specification/_json_spec/security.get_role_mapping.json +++ b/specification/_json_spec/security.get_role_mapping.json @@ -26,7 +26,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.get_service_accounts.json b/specification/_json_spec/security.get_service_accounts.json index 2d286c25ab..7a409998e5 100644 --- a/specification/_json_spec/security.get_service_accounts.json +++ b/specification/_json_spec/security.get_service_accounts.json @@ -40,7 +40,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.get_service_credentials.json b/specification/_json_spec/security.get_service_credentials.json index a3569ca772..4c86dbf7d0 100644 --- a/specification/_json_spec/security.get_service_credentials.json +++ b/specification/_json_spec/security.get_service_credentials.json @@ -26,7 +26,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.get_stats.json b/specification/_json_spec/security.get_stats.json index fa0f6e8b51..19baa75bb5 100644 --- a/specification/_json_spec/security.get_stats.json +++ b/specification/_json_spec/security.get_stats.json @@ -17,7 +17,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.get_token.json b/specification/_json_spec/security.get_token.json index 29498ce64c..d4f0ae0a0c 100644 --- a/specification/_json_spec/security.get_token.json +++ b/specification/_json_spec/security.get_token.json @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "The token request to get", "required": true diff --git a/specification/_json_spec/security.get_user_privileges.json b/specification/_json_spec/security.get_user_privileges.json index 89d45a7852..67799c90c3 100644 --- a/specification/_json_spec/security.get_user_privileges.json +++ b/specification/_json_spec/security.get_user_privileges.json @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.has_privileges.json b/specification/_json_spec/security.has_privileges.json index 22120527dc..03a43976b3 100644 --- a/specification/_json_spec/security.has_privileges.json +++ b/specification/_json_spec/security.has_privileges.json @@ -28,7 +28,6 @@ } ] }, - "params": {}, "body": { "description": "The privileges to test", "required": true diff --git a/specification/_json_spec/security.has_privileges_user_profile.json b/specification/_json_spec/security.has_privileges_user_profile.json index 596b745952..0b56a67450 100644 --- a/specification/_json_spec/security.has_privileges_user_profile.json +++ b/specification/_json_spec/security.has_privileges_user_profile.json @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "The privileges to check and the list of profile IDs", "required": true diff --git a/specification/_json_spec/security.invalidate_token.json b/specification/_json_spec/security.invalidate_token.json index 6598d7861f..a90aa7e3d2 100644 --- a/specification/_json_spec/security.invalidate_token.json +++ b/specification/_json_spec/security.invalidate_token.json @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "The token to invalidate", "required": true diff --git a/specification/_json_spec/shutdown.get_node.json b/specification/_json_spec/shutdown.get_node.json index 82c82632e1..110b8d6c50 100644 --- a/specification/_json_spec/shutdown.get_node.json +++ b/specification/_json_spec/shutdown.get_node.json @@ -14,8 +14,7 @@ "paths": [ { "path": "/_nodes/shutdown", - "methods": ["GET"], - "parts": {} + "methods": ["GET"] }, { "path": "/_nodes/{node_id}/shutdown", diff --git a/specification/_json_spec/simulate.ingest.json b/specification/_json_spec/simulate.ingest.json index e88aba811f..93c7978ff5 100644 --- a/specification/_json_spec/simulate.ingest.json +++ b/specification/_json_spec/simulate.ingest.json @@ -34,8 +34,9 @@ "description": "The pipeline id to preprocess incoming documents with if no pipeline is given for a particular document" }, "merge_type": { - "type": "string", - "description": "The mapping merge type if mapping overrides are being provided in mapping_addition. The allowed values are one of index or template. The index option merges mappings the way they would be merged into an existing index. The template option merges mappings the way they would be merged into a template.", + "type": "enum", + "description": "The mapping merge type if mapping overrides are being provided in mapping_addition.\nThe allowed values are one of index or template.\nThe index option merges mappings the way they would be merged into an existing index.\nThe template option merges mappings the way they would be merged into a template.", + "options": ["index", "template"], "default": "index" } }, diff --git a/specification/_json_spec/sql.query.json b/specification/_json_spec/sql.query.json index fef69b0617..d14320799c 100644 --- a/specification/_json_spec/sql.query.json +++ b/specification/_json_spec/sql.query.json @@ -20,8 +20,9 @@ }, "params": { "format": { - "type": "string", - "description": "a short version of the Accept header, e.g. json, yaml" + "type": "enum", + "description": "The format for the response.\nYou can also specify a format using the `Accept` HTTP header.\nIf you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence.", + "options": ["csv", "json", "tsv", "txt", "yaml", "cbor", "smile"] }, "project_routing": { "type": "string", diff --git a/specification/_json_spec/sql.translate.json b/specification/_json_spec/sql.translate.json index 9282f93a2c..09b25484fd 100644 --- a/specification/_json_spec/sql.translate.json +++ b/specification/_json_spec/sql.translate.json @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "Specify the query in the `query` element.", "required": true diff --git a/specification/_json_spec/ssl.certificates.json b/specification/_json_spec/ssl.certificates.json index 017364fa35..f0db925ac2 100644 --- a/specification/_json_spec/ssl.certificates.json +++ b/specification/_json_spec/ssl.certificates.json @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/streams.logs_disable.json b/specification/_json_spec/streams.logs_disable.json index c88c044076..58589d9a70 100644 --- a/specification/_json_spec/streams.logs_disable.json +++ b/specification/_json_spec/streams.logs_disable.json @@ -1,10 +1,10 @@ { "streams.logs_disable": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/streams-logs-disable.html", + "url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO", "description": "Disable the Logs Streams feature for this cluster" }, - "stability": "stable", + "stability": "experimental", "visibility": "feature_flag", "feature_flag": "logs_stream", "headers": { diff --git a/specification/_json_spec/streams.logs_enable.json b/specification/_json_spec/streams.logs_enable.json index f366ba7e4b..8220bc9065 100644 --- a/specification/_json_spec/streams.logs_enable.json +++ b/specification/_json_spec/streams.logs_enable.json @@ -1,10 +1,10 @@ { "streams.logs_enable": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/streams-logs-enable.html", + "url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO", "description": "Enable the Logs Streams feature for this cluster" }, - "stability": "stable", + "stability": "experimental", "visibility": "feature_flag", "feature_flag": "logs_stream", "headers": { diff --git a/specification/_json_spec/streams.status.json b/specification/_json_spec/streams.status.json index bacdc09eb6..395596a45d 100644 --- a/specification/_json_spec/streams.status.json +++ b/specification/_json_spec/streams.status.json @@ -1,10 +1,10 @@ { "streams.status": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/streams-status.html", + "url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO", "description": "Return the current status of the streams feature for each streams type" }, - "stability": "stable", + "stability": "experimental", "visibility": "feature_flag", "feature_flag": "logs_stream", "headers": { diff --git a/specification/_json_spec/terms_enum.json b/specification/_json_spec/terms_enum.json index a405909af2..c2c3c4b5d3 100644 --- a/specification/_json_spec/terms_enum.json +++ b/specification/_json_spec/terms_enum.json @@ -24,7 +24,6 @@ } ] }, - "params": {}, "body": { "description": "field name, string which is the prefix expected in matching terms, timeout and size for max number of results", "required": true diff --git a/specification/_json_spec/text_structure.find_field_structure.json b/specification/_json_spec/text_structure.find_field_structure.json index f4ffbc6728..537a3956f1 100644 --- a/specification/_json_spec/text_structure.find_field_structure.json +++ b/specification/_json_spec/text_structure.find_field_structure.json @@ -64,9 +64,10 @@ "description": "Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file" }, "ecs_compatibility": { - "type": "string", - "default": "disabled", - "description": "Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'" + "type": "enum", + "description": "The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of the meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output.\nThe intention in that situation is that a user who knows the meanings will rename the fields before using them.", + "options": ["disabled", "v1"], + "default": "disabled" }, "timestamp_field": { "type": "string", diff --git a/specification/_json_spec/text_structure.find_message_structure.json b/specification/_json_spec/text_structure.find_message_structure.json index 824415ec08..402eb4ba79 100644 --- a/specification/_json_spec/text_structure.find_message_structure.json +++ b/specification/_json_spec/text_structure.find_message_structure.json @@ -50,9 +50,10 @@ "description": "Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file" }, "ecs_compatibility": { - "type": "string", - "default": "disabled", - "description": "Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'" + "type": "enum", + "description": "The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it.", + "options": ["disabled", "v1"], + "default": "disabled" }, "timestamp_field": { "type": "string", diff --git a/specification/_json_spec/watcher.get_watch.json b/specification/_json_spec/watcher.get_watch.json index db5fd6678f..483c2924b6 100644 --- a/specification/_json_spec/watcher.get_watch.json +++ b/specification/_json_spec/watcher.get_watch.json @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/watcher.query_watches.json b/specification/_json_spec/watcher.query_watches.json index 8d081cd596..7f989e7722 100644 --- a/specification/_json_spec/watcher.query_watches.json +++ b/specification/_json_spec/watcher.query_watches.json @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "From, size, query, sort and search_after", "required": false