From 5126aa7eaf9b2b0847ebefb0c4c87cca2a6a2c27 Mon Sep 17 00:00:00 2001 From: pquentin <42327+pquentin@users.noreply.github.com> Date: Wed, 25 Dec 2024 04:06:33 +0000 Subject: [PATCH] Update rest-api-spec --- output/openapi/elasticsearch-openapi.json | 4 + output/schema/schema.json | 4 + output/schema/validation-errors.json | 111 +++++++----------- specification/_json_spec/bulk.json | 8 +- .../_json_spec/ilm.delete_lifecycle.json | 11 +- .../_json_spec/ilm.explain_lifecycle.json | 4 + .../_json_spec/ilm.get_lifecycle.json | 11 +- .../_json_spec/ilm.put_lifecycle.json | 11 +- specification/_json_spec/ilm.start.json | 11 +- specification/_json_spec/ilm.stop.json | 11 +- .../ingest.delete_geoip_database.json | 11 +- .../ingest.delete_ip_location_database.json | 11 +- .../_json_spec/ingest.put_geoip_database.json | 11 +- .../ingest.put_ip_location_database.json | 11 +- .../_json_spec/slm.delete_lifecycle.json | 11 +- .../_json_spec/slm.execute_lifecycle.json | 11 +- .../_json_spec/slm.execute_retention.json | 11 +- .../_json_spec/slm.get_lifecycle.json | 11 +- specification/_json_spec/slm.get_stats.json | 11 +- specification/_json_spec/slm.get_status.json | 11 +- .../_json_spec/slm.put_lifecycle.json | 11 +- 21 files changed, 222 insertions(+), 85 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index df94e7547b..7e2199761c 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -10464,6 +10464,7 @@ { "in": "query", "name": "master_timeout", + "description": "Explicit operation timeout for connection to master node", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -10473,6 +10474,7 @@ { "in": "query", "name": "timeout", + "description": "Explicit operation timeout", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -10507,6 +10509,7 @@ { "in": "query", "name": "master_timeout", + "description": "Explicit operation timeout for connection to master node", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -10516,6 +10519,7 @@ { "in": "query", "name": "timeout", + "description": "Explicit operation timeout", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" diff --git a/output/schema/schema.json b/output/schema/schema.json index de7a4785df..4cb6bcfc12 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -123863,6 +123863,7 @@ "path": [], "query": [ { + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, "type": { @@ -123874,6 +123875,7 @@ } }, { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -123927,6 +123929,7 @@ "path": [], "query": [ { + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, "type": { @@ -123938,6 +123941,7 @@ } }, { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index ac8a210930..761e740870 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -43,6 +43,12 @@ ], "response": [] }, + "bulk": { + "request": [ + "Request: missing json spec query parameter 'type'" + ], + "response": [] + }, "capabilities": { "request": [ "Missing request & response" @@ -628,44 +634,8 @@ ], "response": [] }, - "ilm.delete_lifecycle": { - "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec", - "Request: query parameter 'timeout' does not exist in the json spec" - ], - "response": [] - }, "ilm.explain_lifecycle": { "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec", - "Request: query parameter 'timeout' does not exist in the json spec" - ], - "response": [] - }, - "ilm.get_lifecycle": { - "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec", - "Request: query parameter 'timeout' does not exist in the json spec" - ], - "response": [] - }, - "ilm.put_lifecycle": { - "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec", - "Request: query parameter 'timeout' does not exist in the json spec" - ], - "response": [] - }, - "ilm.start": { - "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec", - "Request: query parameter 'timeout' does not exist in the json spec" - ], - "response": [] - }, - "ilm.stop": { - "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec", "Request: query parameter 'timeout' does not exist in the json spec" ], "response": [] @@ -747,20 +717,6 @@ ], "response": [] }, - "ingest.delete_geoip_database": { - "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec", - "Request: query parameter 'timeout' does not exist in the json spec" - ], - "response": [] - }, - "ingest.delete_ip_location_database": { - "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec", - "Request: query parameter 'timeout' does not exist in the json spec" - ], - "response": [] - }, "ingest.get_geoip_database": { "request": [ "Request: query parameter 'master_timeout' does not exist in the json spec" @@ -773,20 +729,6 @@ ], "response": [] }, - "ingest.put_geoip_database": { - "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec", - "Request: query parameter 'timeout' does not exist in the json spec" - ], - "response": [] - }, - "ingest.put_ip_location_database": { - "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec", - "Request: query parameter 'timeout' does not exist in the json spec" - ], - "response": [] - }, "license.delete": { "request": [ "Request: missing json spec query parameter 'master_timeout'", @@ -1019,10 +961,45 @@ ], "response": [] }, - "slm.put_lifecycle": { + "slm.delete_lifecycle": { "request": [ - "Request: query parameter 'master_timeout' does not exist in the json spec", - "Request: query parameter 'timeout' does not exist in the json spec" + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'timeout'" + ], + "response": [] + }, + "slm.execute_lifecycle": { + "request": [ + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'timeout'" + ], + "response": [] + }, + "slm.execute_retention": { + "request": [ + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'timeout'" + ], + "response": [] + }, + "slm.get_lifecycle": { + "request": [ + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'timeout'" + ], + "response": [] + }, + "slm.get_stats": { + "request": [ + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'timeout'" + ], + "response": [] + }, + "slm.get_status": { + "request": [ + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'timeout'" ], "response": [] }, diff --git a/specification/_json_spec/bulk.json b/specification/_json_spec/bulk.json index 3444e1c017..59e79d0684 100644 --- a/specification/_json_spec/bulk.json +++ b/specification/_json_spec/bulk.json @@ -46,6 +46,10 @@ "type": "time", "description": "Explicit operation timeout" }, + "type": { + "type": "string", + "description": "Default document type for items which don't provide one" + }, "_source": { "type": "list", "description": "True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request" @@ -64,11 +68,11 @@ }, "require_alias": { "type": "boolean", - "description": "If true, the request’s actions must target an index alias. Defaults to false." + "description": "Sets require_alias for all incoming documents. Defaults to unset (false)" }, "require_data_stream": { "type": "boolean", - "description": "If true, the request's actions must target a data stream (existing or to-be-created). Default to false" + "description": "When true, requires the destination to be a data stream (existing or to-be-created). Default is false" }, "list_executed_pipelines": { "type": "boolean", diff --git a/specification/_json_spec/ilm.delete_lifecycle.json b/specification/_json_spec/ilm.delete_lifecycle.json index d3e83b77b3..32f55522b0 100644 --- a/specification/_json_spec/ilm.delete_lifecycle.json +++ b/specification/_json_spec/ilm.delete_lifecycle.json @@ -23,6 +23,15 @@ } ] }, - "params": {} + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } + } } } diff --git a/specification/_json_spec/ilm.explain_lifecycle.json b/specification/_json_spec/ilm.explain_lifecycle.json index 993c9fc0c8..76a815e79b 100644 --- a/specification/_json_spec/ilm.explain_lifecycle.json +++ b/specification/_json_spec/ilm.explain_lifecycle.json @@ -31,6 +31,10 @@ "only_errors": { "type": "boolean", "description": "filters the indices included in the response to ones in an ILM error state, implies only_managed" + }, + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" } } } diff --git a/specification/_json_spec/ilm.get_lifecycle.json b/specification/_json_spec/ilm.get_lifecycle.json index 1e5037edb9..44c3ea878c 100644 --- a/specification/_json_spec/ilm.get_lifecycle.json +++ b/specification/_json_spec/ilm.get_lifecycle.json @@ -27,6 +27,15 @@ } ] }, - "params": {} + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } + } } } diff --git a/specification/_json_spec/ilm.put_lifecycle.json b/specification/_json_spec/ilm.put_lifecycle.json index 2ae9227811..381956a35c 100644 --- a/specification/_json_spec/ilm.put_lifecycle.json +++ b/specification/_json_spec/ilm.put_lifecycle.json @@ -24,7 +24,16 @@ } ] }, - "params": {}, + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } + }, "body": { "description": "The lifecycle policy definition to register" } diff --git a/specification/_json_spec/ilm.start.json b/specification/_json_spec/ilm.start.json index 722ad25ee2..893c8c98ba 100644 --- a/specification/_json_spec/ilm.start.json +++ b/specification/_json_spec/ilm.start.json @@ -17,6 +17,15 @@ } ] }, - "params": {} + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } + } } } diff --git a/specification/_json_spec/ilm.stop.json b/specification/_json_spec/ilm.stop.json index 7a9643962a..b60cd2223d 100644 --- a/specification/_json_spec/ilm.stop.json +++ b/specification/_json_spec/ilm.stop.json @@ -17,6 +17,15 @@ } ] }, - "params": {} + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } + } } } diff --git a/specification/_json_spec/ingest.delete_geoip_database.json b/specification/_json_spec/ingest.delete_geoip_database.json index ce4d2b7173..d56019cf4f 100644 --- a/specification/_json_spec/ingest.delete_geoip_database.json +++ b/specification/_json_spec/ingest.delete_geoip_database.json @@ -23,6 +23,15 @@ } ] }, - "params": {} + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } + } } } diff --git a/specification/_json_spec/ingest.delete_ip_location_database.json b/specification/_json_spec/ingest.delete_ip_location_database.json index 629ea86961..427cbe9817 100644 --- a/specification/_json_spec/ingest.delete_ip_location_database.json +++ b/specification/_json_spec/ingest.delete_ip_location_database.json @@ -23,6 +23,15 @@ } ] }, - "params": {} + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } + } } } diff --git a/specification/_json_spec/ingest.put_geoip_database.json b/specification/_json_spec/ingest.put_geoip_database.json index f27c28fd73..c732652c34 100644 --- a/specification/_json_spec/ingest.put_geoip_database.json +++ b/specification/_json_spec/ingest.put_geoip_database.json @@ -24,7 +24,16 @@ } ] }, - "params": {}, + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } + }, "body": { "description": "The database configuration definition", "required": true diff --git a/specification/_json_spec/ingest.put_ip_location_database.json b/specification/_json_spec/ingest.put_ip_location_database.json index b10e290bd4..87a2adab72 100644 --- a/specification/_json_spec/ingest.put_ip_location_database.json +++ b/specification/_json_spec/ingest.put_ip_location_database.json @@ -24,7 +24,16 @@ } ] }, - "params": {}, + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } + }, "body": { "description": "The database configuration definition", "required": true diff --git a/specification/_json_spec/slm.delete_lifecycle.json b/specification/_json_spec/slm.delete_lifecycle.json index a27bc3e650..3017931873 100644 --- a/specification/_json_spec/slm.delete_lifecycle.json +++ b/specification/_json_spec/slm.delete_lifecycle.json @@ -23,6 +23,15 @@ } ] }, - "params": {} + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } + } } } diff --git a/specification/_json_spec/slm.execute_lifecycle.json b/specification/_json_spec/slm.execute_lifecycle.json index 181345955e..4625097a98 100644 --- a/specification/_json_spec/slm.execute_lifecycle.json +++ b/specification/_json_spec/slm.execute_lifecycle.json @@ -23,6 +23,15 @@ } ] }, - "params": {} + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } + } } } diff --git a/specification/_json_spec/slm.execute_retention.json b/specification/_json_spec/slm.execute_retention.json index ad0c65fefc..eb5c31c0f0 100644 --- a/specification/_json_spec/slm.execute_retention.json +++ b/specification/_json_spec/slm.execute_retention.json @@ -17,6 +17,15 @@ } ] }, - "params": {} + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } + } } } diff --git a/specification/_json_spec/slm.get_lifecycle.json b/specification/_json_spec/slm.get_lifecycle.json index b32057a5fc..6d71517825 100644 --- a/specification/_json_spec/slm.get_lifecycle.json +++ b/specification/_json_spec/slm.get_lifecycle.json @@ -27,6 +27,15 @@ } ] }, - "params": {} + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } + } } } diff --git a/specification/_json_spec/slm.get_stats.json b/specification/_json_spec/slm.get_stats.json index 92c27a4abe..2d9899c8e8 100644 --- a/specification/_json_spec/slm.get_stats.json +++ b/specification/_json_spec/slm.get_stats.json @@ -17,6 +17,15 @@ } ] }, - "params": {} + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } + } } } diff --git a/specification/_json_spec/slm.get_status.json b/specification/_json_spec/slm.get_status.json index 9617adc746..10b0c02a12 100644 --- a/specification/_json_spec/slm.get_status.json +++ b/specification/_json_spec/slm.get_status.json @@ -17,6 +17,15 @@ } ] }, - "params": {} + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } + } } } diff --git a/specification/_json_spec/slm.put_lifecycle.json b/specification/_json_spec/slm.put_lifecycle.json index f9037c4055..5a605362e8 100644 --- a/specification/_json_spec/slm.put_lifecycle.json +++ b/specification/_json_spec/slm.put_lifecycle.json @@ -24,7 +24,16 @@ } ] }, - "params": {}, + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } + }, "body": { "description": "The snapshot lifecycle policy definition to register" }