From 4cb8d4d9388da285c6da53d2b4c2d5d297cf400c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Laurent=20Saint-F=C3=A9lix?= Date: Thu, 9 Nov 2023 13:45:35 +0100 Subject: [PATCH] [JSON spec] sync spec files (#2343) * Sync json spec files for 8.11 * make contrib --- .../elasticsearch-serverless-openapi.json | 43 ++- output/schema/schema.json | 323 ++++++++++++++++-- output/schema/validation-errors.json | 66 ++++ specification/_json_spec/cluster.info.json | 2 +- specification/_json_spec/esql.query.json | 37 ++ .../_json_spec/fleet.delete_secret.json | 28 ++ .../_json_spec/fleet.get_secret.json | 28 ++ .../_json_spec/fleet.post_secret.json | 26 ++ .../indices.delete_data_lifecycle.json | 2 +- .../indices.delete_index_template.json | 2 +- .../_json_spec/indices.delete_template.json | 2 +- .../indices.exists_index_template.json | 2 +- .../_json_spec/indices.exists_template.json | 2 +- .../indices.explain_data_lifecycle.json | 2 +- .../indices.get_data_lifecycle.json | 2 +- .../indices.get_index_template.json | 2 +- .../_json_spec/indices.get_template.json | 2 +- .../indices.put_data_lifecycle.json | 4 +- .../indices.put_index_template.json | 2 +- .../_json_spec/indices.put_template.json | 2 +- .../indices.reload_search_analyzers.json | 4 + .../indices.simulate_index_template.json | 2 +- .../_json_spec/indices.simulate_template.json | 2 +- .../_json_spec/inference.delete_model.json | 31 ++ .../_json_spec/inference.get_model.json | 31 ++ .../_json_spec/inference.inference.json | 34 ++ .../_json_spec/inference.put_model.json | 34 ++ .../_json_spec/search_application.delete.json | 4 +- .../_json_spec/search_application.get.json | 2 +- .../_json_spec/search_application.list.json | 2 +- .../_json_spec/search_application.put.json | 2 +- .../search_application.render_query.json | 2 +- .../_json_spec/search_application.search.json | 2 +- ...security.create_cross_cluster_api_key.json | 5 +- .../_json_spec/security.get_settings.json | 23 ++ ...security.update_cross_cluster_api_key.json | 5 +- .../_json_spec/security.update_settings.json | 27 ++ 37 files changed, 726 insertions(+), 65 deletions(-) create mode 100644 specification/_json_spec/esql.query.json create mode 100644 specification/_json_spec/fleet.delete_secret.json create mode 100644 specification/_json_spec/fleet.get_secret.json create mode 100644 specification/_json_spec/fleet.post_secret.json create mode 100644 specification/_json_spec/inference.delete_model.json create mode 100644 specification/_json_spec/inference.get_model.json create mode 100644 specification/_json_spec/inference.inference.json create mode 100644 specification/_json_spec/inference.put_model.json create mode 100644 specification/_json_spec/security.get_settings.json create mode 100644 specification/_json_spec/security.update_settings.json diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 559c8b5978..de48bf624a 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -5763,7 +5763,7 @@ "summary": "Returns an index template.", "description": "Returns an index template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html" }, "operationId": "indices-get-index-template-1", "parameters": [ @@ -5796,7 +5796,7 @@ "summary": "Creates or updates an index template.", "description": "Creates or updates an index template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html" }, "operationId": "indices-put-index-template", "parameters": [ @@ -5823,7 +5823,7 @@ "summary": "Creates or updates an index template.", "description": "Creates or updates an index template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html" }, "operationId": "indices-put-index-template-1", "parameters": [ @@ -5850,7 +5850,7 @@ "summary": "Deletes an index template.", "description": "Deletes an index template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html" }, "operationId": "indices-delete-index-template", "parameters": [ @@ -5906,7 +5906,7 @@ "summary": "Returns information about whether a particular index template exists.", "description": "Returns information about whether a particular index template exists.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html" }, "operationId": "indices-exists-index-template", "parameters": [ @@ -6180,7 +6180,7 @@ "summary": "Returns an index template.", "description": "Returns an index template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html" }, "operationId": "indices-get-index-template", "parameters": [ @@ -6717,7 +6717,7 @@ "summary": "Creates or updates an index template.", "description": "Creates or updates an index template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html" }, "operationId": "indices-put-template", "parameters": [ @@ -6756,7 +6756,7 @@ "summary": "Creates or updates an index template.", "description": "Creates or updates an index template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html" }, "operationId": "indices-put-template-1", "parameters": [ @@ -7067,7 +7067,7 @@ "summary": "Simulate matching the given index name against the index templates in the system", "description": "Simulate matching the given index name against the index templates in the system", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html" }, "operationId": "indices-simulate-index-template", "parameters": [ @@ -7176,7 +7176,7 @@ "summary": "Simulate resolving the given template name or body", "description": "Simulate resolving the given template name or body", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html" }, "operationId": "indices-simulate-template", "parameters": [ @@ -7208,7 +7208,7 @@ "summary": "Simulate resolving the given template name or body", "description": "Simulate resolving the given template name or body", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html" }, "operationId": "indices-simulate-template-1", "parameters": [ @@ -11403,6 +11403,13 @@ "items": { "type": "string" } + }, + "scores": { + "description": "The optional vocabulary value scores if required by the tokenizer.", + "type": "array", + "items": { + "type": "number" + } } }, "required": [ @@ -14808,7 +14815,7 @@ "summary": "Deletes a search application.", "description": "Deletes a search application.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html" }, "operationId": "search-application-delete", "parameters": [ @@ -17272,6 +17279,16 @@ }, "style": "form" }, + { + "in": "query", + "name": "delete_dest_index", + "description": "If this value is true, the destination index is deleted together with the transform. If false, the destination\nindex will not be deleted", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, { "in": "query", "name": "timeout", @@ -44752,7 +44769,7 @@ "type": "object", "properties": { "limit": { - "description": "[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will\napply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.", + "description": "[preview] This functionality is in technical preview and may be changed or removed in a future release.\nElastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.", "type": "number" } } diff --git a/output/schema/schema.json b/output/schema/schema.json index 139e8ec5a9..1c6bf48dd1 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -3780,6 +3780,36 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Executes an ESQL request", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-query-api.html", + "name": "esql.query", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_query" + } + ], + "visibility": "public" + }, { "availability": { "serverless": { @@ -4026,6 +4056,60 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "private" + } + }, + "description": "Deletes a secret stored by Fleet.", + "docUrl": null, + "name": "fleet.delete_secret", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "DELETE" + ], + "path": "/_fleet/secret/{id}" + } + ], + "visibility": "private" + }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "private" + } + }, + "description": "Retrieves a secret stored by Fleet.", + "docUrl": null, + "name": "fleet.get_secret", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_fleet/secret/{id}" + } + ], + "visibility": "private" + }, { "availability": { "serverless": { @@ -4121,6 +4205,33 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "private" + } + }, + "description": "Creates a secret stored by Fleet.", + "docUrl": null, + "name": "fleet.post_secret", + "request": null, + "requestBodyRequired": true, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_fleet/secret" + } + ], + "visibility": "private" + }, { "availability": { "serverless": { @@ -5423,7 +5534,7 @@ } }, "description": "Deletes an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html", "name": "indices.delete_index_template", "privileges": { "cluster": [ @@ -5463,7 +5574,7 @@ } }, "description": "Deletes an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template-v1.html", "name": "indices.delete_template", "privileges": { "cluster": [ @@ -5670,7 +5781,7 @@ } }, "description": "Returns information about whether a particular index template exists.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html", "name": "indices.exists_index_template", "request": { "name": "Request", @@ -5704,7 +5815,7 @@ } }, "description": "Returns information about whether a particular index template exists.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-template-exists-v1.html", "name": "indices.exists_template", "request": { "name": "Request", @@ -6141,7 +6252,7 @@ } }, "description": "Returns an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html", "name": "indices.get_index_template", "privileges": { "cluster": [ @@ -6294,7 +6405,7 @@ } }, "description": "Returns an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template-v1.html", "name": "indices.get_template", "request": { "name": "Request", @@ -6581,7 +6692,7 @@ } }, "description": "Creates or updates an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html", "name": "indices.put_index_template", "request": { "name": "Request", @@ -6717,7 +6828,7 @@ } }, "description": "Creates or updates an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html", "name": "indices.put_template", "request": { "name": "Request", @@ -7093,7 +7204,7 @@ } }, "description": "Simulate matching the given index name against the index templates in the system", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html", "name": "indices.simulate_index_template", "request": { "name": "Request", @@ -7134,7 +7245,7 @@ } }, "description": "Simulate resolving the given template name or body", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html", "name": "indices.simulate_template", "privileges": { "cluster": [ @@ -7404,6 +7515,114 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Delete model in the Inference API", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html", + "name": "inference.delete_model", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "DELETE" + ], + "path": "/_inference/{task_type}/{model_id}" + } + ], + "visibility": "public" + }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Get a model in the Inference API", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html", + "name": "inference.get_model", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_inference/{task_type}/{model_id}" + } + ], + "visibility": "public" + }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Perform inference on a model", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html", + "name": "inference.inference", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_inference/{task_type}/{model_id}" + } + ], + "visibility": "public" + }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Configure a model for use in the Inference API", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html", + "name": "inference.put_model", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{model_id}" + } + ], + "visibility": "public" + }, { "availability": { "serverless": { @@ -13224,7 +13443,7 @@ } }, "description": "Deletes a search application.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html", "name": "search_application.delete", "request": { "name": "Request", @@ -13520,7 +13739,7 @@ { "availability": { "stack": { - "stability": "beta", + "stability": "experimental", "visibility": "public" } }, @@ -13536,7 +13755,7 @@ "responseMediaType": [ "application/json" ], - "stability": "beta", + "stability": "experimental", "urls": [ { "methods": [ @@ -14283,13 +14502,12 @@ { "availability": { "stack": { - "stability": "experimental", - "visibility": "feature_flag" + "stability": "beta", + "visibility": "public" } }, "description": "Creates a cross-cluster API key for API key based remote cluster access.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html", - "featureFlag": "es.untrusted_remote_cluster_feature_flag_registered", "name": "security.create_cross_cluster_api_key", "request": null, "requestBodyRequired": true, @@ -14300,7 +14518,7 @@ "responseMediaType": [ "application/json" ], - "stability": "experimental", + "stability": "beta", "urls": [ { "methods": [ @@ -14309,7 +14527,7 @@ "path": "/_security/cross_cluster/api_key" } ], - "visibility": "feature_flag" + "visibility": "public" }, { "availability": { @@ -15102,6 +15320,36 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Retrieve settings for the security system indices", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-settings.html", + "name": "security.get_settings", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "stable", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_security/settings" + } + ], + "visibility": "public" + }, { "availability": { "serverless": { @@ -16138,13 +16386,12 @@ { "availability": { "stack": { - "stability": "experimental", - "visibility": "feature_flag" + "stability": "beta", + "visibility": "public" } }, "description": "Updates attributes of an existing cross-cluster API key.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-cross-cluster-api-key.html", - "featureFlag": "es.untrusted_remote_cluster_feature_flag_registered", "name": "security.update_cross_cluster_api_key", "request": null, "requestBodyRequired": true, @@ -16155,7 +16402,7 @@ "responseMediaType": [ "application/json" ], - "stability": "experimental", + "stability": "beta", "urls": [ { "methods": [ @@ -16164,7 +16411,37 @@ "path": "/_security/cross_cluster/api_key/{id}" } ], - "visibility": "feature_flag" + "visibility": "public" + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Update settings for the security system index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-settings.html", + "name": "security.update_settings", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "stable", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_security/settings" + } + ], + "visibility": "public" }, { "availability": { diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index aac2584cf6..fed637b7ad 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -552,12 +552,30 @@ ], "response": [] }, + "esql.query": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "features.get_features": { "request": [ "Request: missing json spec query parameter 'master_timeout'" ], "response": [] }, + "fleet.delete_secret": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "fleet.get_secret": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "fleet.msearch": { "request": [ "Request: query parameter 'allow_no_indices' does not exist in the json spec", @@ -578,6 +596,12 @@ "type_alias definition _global.msearch:ResponseItem / union_of / instance_of / Generics / instance_of - No type definition for '_global.msearch:TDocument'" ] }, + "fleet.post_secret": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "fleet.search": { "request": [ "Request: query parameter 'allow_no_indices' does not exist in the json spec", @@ -843,6 +867,12 @@ "response definition indices.refresh:Response / body / instance_of - Non-leaf type cannot be used here: '_types:ShardsOperationResponseBase'" ] }, + "indices.reload_search_analyzers": { + "request": [ + "Request: missing json spec query parameter 'resource'" + ], + "response": [] + }, "indices.simulate_index_template": { "request": [ "Request: missing json spec query parameter 'cause'" @@ -861,6 +891,30 @@ "response definition indices.update_aliases:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] }, + "inference.delete_model": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "inference.get_model": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "inference.inference": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "inference.put_model": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "ingest.delete_pipeline": { "request": [], "response": [ @@ -1216,6 +1270,12 @@ "response definition security.enable_user_profile:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] }, + "security.get_settings": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "security.get_user": { "request": [], "response": [ @@ -1272,6 +1332,12 @@ ], "response": [] }, + "security.update_settings": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "security.update_user_profile_data": { "request": [], "response": [ diff --git a/specification/_json_spec/cluster.info.json b/specification/_json_spec/cluster.info.json index 5ad8f13083..ca6ad6d8e2 100644 --- a/specification/_json_spec/cluster.info.json +++ b/specification/_json_spec/cluster.info.json @@ -17,7 +17,7 @@ "parts": { "target": { "type": "list", - "options": ["_all", "http", "ingest", "thread_pool"], + "options": ["_all", "http", "ingest", "thread_pool", "script"], "description": "Limit the information returned to the specified target." } } diff --git a/specification/_json_spec/esql.query.json b/specification/_json_spec/esql.query.json new file mode 100644 index 0000000000..3597c2773a --- /dev/null +++ b/specification/_json_spec/esql.query.json @@ -0,0 +1,37 @@ +{ + "esql.query": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-query-api.html", + "description": "Executes an ESQL request" + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_query", + "methods": ["POST"] + } + ] + }, + "params": { + "format": { + "type": "string", + "description": "a short version of the Accept header, e.g. json, yaml" + }, + "delimiter": { + "type": "string", + "description": "The character to use between values within a CSV row. Only valid for the csv format.", + "default": false + } + }, + "body": { + "description": "Use the `query` element to start a query. Use `time_zone` to specify an execution time zone and `columnar` to format the answer.", + "required": true + } + } +} diff --git a/specification/_json_spec/fleet.delete_secret.json b/specification/_json_spec/fleet.delete_secret.json new file mode 100644 index 0000000000..6b597747bc --- /dev/null +++ b/specification/_json_spec/fleet.delete_secret.json @@ -0,0 +1,28 @@ +{ + "fleet.delete_secret": { + "documentation": { + "url": null, + "description": "Deletes a secret stored by Fleet." + }, + "stability": "experimental", + "visibility": "private", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_fleet/secret/{id}", + "methods": ["DELETE"], + "parts": { + "id": { + "type": "string", + "description": "The ID of the secret" + } + } + } + ] + }, + "params": {} + } +} diff --git a/specification/_json_spec/fleet.get_secret.json b/specification/_json_spec/fleet.get_secret.json new file mode 100644 index 0000000000..14d8d9ef5b --- /dev/null +++ b/specification/_json_spec/fleet.get_secret.json @@ -0,0 +1,28 @@ +{ + "fleet.get_secret": { + "documentation": { + "url": null, + "description": "Retrieves a secret stored by Fleet." + }, + "stability": "experimental", + "visibility": "private", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_fleet/secret/{id}", + "methods": ["GET"], + "parts": { + "id": { + "type": "string", + "description": "The ID of the secret" + } + } + } + ] + }, + "params": {} + } +} diff --git a/specification/_json_spec/fleet.post_secret.json b/specification/_json_spec/fleet.post_secret.json new file mode 100644 index 0000000000..a317196f2f --- /dev/null +++ b/specification/_json_spec/fleet.post_secret.json @@ -0,0 +1,26 @@ +{ + "fleet.post_secret": { + "documentation": { + "url": null, + "description": "Creates a secret stored by Fleet." + }, + "stability": "experimental", + "visibility": "private", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_fleet/secret", + "methods": ["POST"] + } + ] + }, + "params": {}, + "body": { + "description": "The secret value to store", + "required": true + } + } +} diff --git a/specification/_json_spec/indices.delete_data_lifecycle.json b/specification/_json_spec/indices.delete_data_lifecycle.json index 94affa5502..48311aed8d 100644 --- a/specification/_json_spec/indices.delete_data_lifecycle.json +++ b/specification/_json_spec/indices.delete_data_lifecycle.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html", "description": "Deletes the data stream lifecycle of the selected data streams." }, - "stability": "stable", + "stability": "experimental", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/indices.delete_index_template.json b/specification/_json_spec/indices.delete_index_template.json index adc89391f4..664917491f 100644 --- a/specification/_json_spec/indices.delete_index_template.json +++ b/specification/_json_spec/indices.delete_index_template.json @@ -1,7 +1,7 @@ { "indices.delete_index_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html", "description": "Deletes an index template." }, "stability": "stable", diff --git a/specification/_json_spec/indices.delete_template.json b/specification/_json_spec/indices.delete_template.json index 6a00897190..897cd5b0ac 100644 --- a/specification/_json_spec/indices.delete_template.json +++ b/specification/_json_spec/indices.delete_template.json @@ -1,7 +1,7 @@ { "indices.delete_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template-v1.html", "description": "Deletes an index template." }, "stability": "stable", diff --git a/specification/_json_spec/indices.exists_index_template.json b/specification/_json_spec/indices.exists_index_template.json index 6462f5a078..20819f7130 100644 --- a/specification/_json_spec/indices.exists_index_template.json +++ b/specification/_json_spec/indices.exists_index_template.json @@ -1,7 +1,7 @@ { "indices.exists_index_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html", "description": "Returns information about whether a particular index template exists." }, "stability": "stable", diff --git a/specification/_json_spec/indices.exists_template.json b/specification/_json_spec/indices.exists_template.json index 28a6bb36f2..b2b7e26e93 100644 --- a/specification/_json_spec/indices.exists_template.json +++ b/specification/_json_spec/indices.exists_template.json @@ -1,7 +1,7 @@ { "indices.exists_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-template-exists-v1.html", "description": "Returns information about whether a particular index template exists." }, "stability": "stable", diff --git a/specification/_json_spec/indices.explain_data_lifecycle.json b/specification/_json_spec/indices.explain_data_lifecycle.json index e61a497806..9f2b24a6f8 100644 --- a/specification/_json_spec/indices.explain_data_lifecycle.json +++ b/specification/_json_spec/indices.explain_data_lifecycle.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html", "description": "Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc." }, - "stability": "stable", + "stability": "experimental", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/indices.get_data_lifecycle.json b/specification/_json_spec/indices.get_data_lifecycle.json index db5e92db4c..4783815ce0 100644 --- a/specification/_json_spec/indices.get_data_lifecycle.json +++ b/specification/_json_spec/indices.get_data_lifecycle.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html", "description": "Returns the data stream lifecycle of the selected data streams." }, - "stability": "stable", + "stability": "experimental", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/indices.get_index_template.json b/specification/_json_spec/indices.get_index_template.json index a6c1e7e673..dd6dcc8dd0 100644 --- a/specification/_json_spec/indices.get_index_template.json +++ b/specification/_json_spec/indices.get_index_template.json @@ -1,7 +1,7 @@ { "indices.get_index_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html", "description": "Returns an index template." }, "stability": "stable", diff --git a/specification/_json_spec/indices.get_template.json b/specification/_json_spec/indices.get_template.json index cba1c4d78a..3785caa755 100644 --- a/specification/_json_spec/indices.get_template.json +++ b/specification/_json_spec/indices.get_template.json @@ -1,7 +1,7 @@ { "indices.get_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template-v1.html", "description": "Returns an index template." }, "stability": "stable", diff --git a/specification/_json_spec/indices.put_data_lifecycle.json b/specification/_json_spec/indices.put_data_lifecycle.json index 7cec6a3363..5d96f47245 100644 --- a/specification/_json_spec/indices.put_data_lifecycle.json +++ b/specification/_json_spec/indices.put_data_lifecycle.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html", "description": "Updates the data stream lifecycle of the selected data streams." }, - "stability": "stable", + "stability": "experimental", "visibility": "public", "headers": { "accept": ["application/json"] @@ -40,7 +40,7 @@ } }, "body": { - "description": "The data lifecycle configuration that consist of the data retention" + "description": "The data stream lifecycle configuration that consist of the data retention" } } } diff --git a/specification/_json_spec/indices.put_index_template.json b/specification/_json_spec/indices.put_index_template.json index 182b8808f0..540773ae30 100644 --- a/specification/_json_spec/indices.put_index_template.json +++ b/specification/_json_spec/indices.put_index_template.json @@ -1,7 +1,7 @@ { "indices.put_index_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html", "description": "Creates or updates an index template." }, "stability": "stable", diff --git a/specification/_json_spec/indices.put_template.json b/specification/_json_spec/indices.put_template.json index 9a0ce912b9..cdafd1963c 100644 --- a/specification/_json_spec/indices.put_template.json +++ b/specification/_json_spec/indices.put_template.json @@ -1,7 +1,7 @@ { "indices.put_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html", "description": "Creates or updates an index template." }, "stability": "stable", diff --git a/specification/_json_spec/indices.reload_search_analyzers.json b/specification/_json_spec/indices.reload_search_analyzers.json index 7494633e0a..af78bfc238 100644 --- a/specification/_json_spec/indices.reload_search_analyzers.json +++ b/specification/_json_spec/indices.reload_search_analyzers.json @@ -37,6 +37,10 @@ "options": ["open", "closed", "hidden", "none", "all"], "default": "open", "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both." + }, + "resource": { + "type": "string", + "description": "changed resource to reload analyzers from if applicable" } } } diff --git a/specification/_json_spec/indices.simulate_index_template.json b/specification/_json_spec/indices.simulate_index_template.json index fa8cfe9e21..294030fff1 100644 --- a/specification/_json_spec/indices.simulate_index_template.json +++ b/specification/_json_spec/indices.simulate_index_template.json @@ -1,7 +1,7 @@ { "indices.simulate_index_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html", "description": "Simulate matching the given index name against the index templates in the system" }, "stability": "stable", diff --git a/specification/_json_spec/indices.simulate_template.json b/specification/_json_spec/indices.simulate_template.json index 9c19e12f69..a34c69d21b 100644 --- a/specification/_json_spec/indices.simulate_template.json +++ b/specification/_json_spec/indices.simulate_template.json @@ -1,7 +1,7 @@ { "indices.simulate_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html", "description": "Simulate resolving the given template name or body" }, "stability": "stable", diff --git a/specification/_json_spec/inference.delete_model.json b/specification/_json_spec/inference.delete_model.json new file mode 100644 index 0000000000..5c4f504328 --- /dev/null +++ b/specification/_json_spec/inference.delete_model.json @@ -0,0 +1,31 @@ +{ + "inference.delete_model": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html", + "description": "Delete model in the Inference API" + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{model_id}", + "methods": ["DELETE"], + "parts": { + "task_type": { + "type": "string", + "description": "The model task type" + }, + "model_id": { + "type": "string", + "description": "The model Id" + } + } + } + ] + } + } +} diff --git a/specification/_json_spec/inference.get_model.json b/specification/_json_spec/inference.get_model.json new file mode 100644 index 0000000000..114d133c25 --- /dev/null +++ b/specification/_json_spec/inference.get_model.json @@ -0,0 +1,31 @@ +{ + "inference.get_model": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html", + "description": "Get a model in the Inference API" + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{model_id}", + "methods": ["GET"], + "parts": { + "task_type": { + "type": "string", + "description": "The model task type" + }, + "model_id": { + "type": "string", + "description": "The model Id" + } + } + } + ] + } + } +} diff --git a/specification/_json_spec/inference.inference.json b/specification/_json_spec/inference.inference.json new file mode 100644 index 0000000000..d8b63ad8da --- /dev/null +++ b/specification/_json_spec/inference.inference.json @@ -0,0 +1,34 @@ +{ + "inference.inference": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html", + "description": "Perform inference on a model" + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{model_id}", + "methods": ["POST"], + "parts": { + "task_type": { + "type": "string", + "description": "The model task type" + }, + "model_id": { + "type": "string", + "description": "The model Id" + } + } + } + ] + }, + "body": { + "description": "The inference payload" + } + } +} diff --git a/specification/_json_spec/inference.put_model.json b/specification/_json_spec/inference.put_model.json new file mode 100644 index 0000000000..ec72b4404c --- /dev/null +++ b/specification/_json_spec/inference.put_model.json @@ -0,0 +1,34 @@ +{ + "inference.put_model": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html", + "description": "Configure a model for use in the Inference API" + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{model_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The model task type" + }, + "model_id": { + "type": "string", + "description": "The model Id" + } + } + } + ] + }, + "body": { + "description": "The model's task and service settings" + } + } +} diff --git a/specification/_json_spec/search_application.delete.json b/specification/_json_spec/search_application.delete.json index 2ef372d094..352611e2dc 100644 --- a/specification/_json_spec/search_application.delete.json +++ b/specification/_json_spec/search_application.delete.json @@ -1,10 +1,10 @@ { "search_application.delete": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html", + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html", "description": "Deletes a search application." }, - "stability": "beta", + "stability": "experimental", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/search_application.get.json b/specification/_json_spec/search_application.get.json index 3472712c50..a2e4d2bddb 100644 --- a/specification/_json_spec/search_application.get.json +++ b/specification/_json_spec/search_application.get.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-search-application.html", "description": "Returns the details about a search application." }, - "stability": "beta", + "stability": "experimental", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/search_application.list.json b/specification/_json_spec/search_application.list.json index 6a2dcb395a..348c0a4b08 100644 --- a/specification/_json_spec/search_application.list.json +++ b/specification/_json_spec/search_application.list.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-search-applications.html", "description": "Returns the existing search applications." }, - "stability": "beta", + "stability": "experimental", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/search_application.put.json b/specification/_json_spec/search_application.put.json index 7214ab9f3a..8e93526b86 100644 --- a/specification/_json_spec/search_application.put.json +++ b/specification/_json_spec/search_application.put.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html", "description": "Creates or updates a search application." }, - "stability": "beta", + "stability": "experimental", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/search_application.render_query.json b/specification/_json_spec/search_application.render_query.json index ed554e5061..2e61c36afa 100644 --- a/specification/_json_spec/search_application.render_query.json +++ b/specification/_json_spec/search_application.render_query.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-render-query.html", "description": "Renders a query for given search application search parameters" }, - "stability": "beta", + "stability": "experimental", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/search_application.search.json b/specification/_json_spec/search_application.search.json index 949aaddf22..418f7a1670 100644 --- a/specification/_json_spec/search_application.search.json +++ b/specification/_json_spec/search_application.search.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html", "description": "Perform a search against a search application" }, - "stability": "beta", + "stability": "experimental", "visibility": "public", "headers": { "accept": ["application/json"], 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 f1c11be4c2..1b958c1d34 100644 --- a/specification/_json_spec/security.create_cross_cluster_api_key.json +++ b/specification/_json_spec/security.create_cross_cluster_api_key.json @@ -4,9 +4,8 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html", "description": "Creates a cross-cluster API key for API key based remote cluster access." }, - "stability": "experimental", - "visibility": "feature_flag", - "feature_flag": "es.untrusted_remote_cluster_feature_flag_registered", + "stability": "beta", + "visibility": "public", "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/security.get_settings.json b/specification/_json_spec/security.get_settings.json new file mode 100644 index 0000000000..2dc08e4e03 --- /dev/null +++ b/specification/_json_spec/security.get_settings.json @@ -0,0 +1,23 @@ +{ + "security.get_settings": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-settings.html", + "description": "Retrieve settings for the security system indices" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_security/settings", + "methods": ["GET"] + } + ] + }, + "params": {} + } +} diff --git a/specification/_json_spec/security.update_cross_cluster_api_key.json b/specification/_json_spec/security.update_cross_cluster_api_key.json index 8bb003663a..dc7140ca0f 100644 --- a/specification/_json_spec/security.update_cross_cluster_api_key.json +++ b/specification/_json_spec/security.update_cross_cluster_api_key.json @@ -4,9 +4,8 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-cross-cluster-api-key.html", "description": "Updates attributes of an existing cross-cluster API key." }, - "stability": "experimental", - "visibility": "feature_flag", - "feature_flag": "es.untrusted_remote_cluster_feature_flag_registered", + "stability": "beta", + "visibility": "public", "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/security.update_settings.json b/specification/_json_spec/security.update_settings.json new file mode 100644 index 0000000000..7ddc65c7ae --- /dev/null +++ b/specification/_json_spec/security.update_settings.json @@ -0,0 +1,27 @@ +{ + "security.update_settings": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-settings.html", + "description": "Update settings for the security system index" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_security/settings", + "methods": ["PUT"] + } + ] + }, + "params": {}, + "body": { + "description": "An object with the new settings for each index, if any", + "required": true + } + } +}