diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 0ee253fb33..5ed7d0031c 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -9154,7 +9154,7 @@ "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html" }, - "operationId": "inference-get-model", + "operationId": "inference-get-model-1", "parameters": [ { "$ref": "#/components/parameters/inference.get_model#inference_id" @@ -9249,7 +9249,7 @@ "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html" }, - "operationId": "inference-get-model-1", + "operationId": "inference-get-model-2", "parameters": [ { "$ref": "#/components/parameters/inference.get_model#task_type" @@ -9346,6 +9346,24 @@ } } }, + "/_inference": { + "get": { + "tags": [ + "inference.get_model" + ], + "summary": "Get a model in the Inference API", + "description": "Get a model in the Inference API", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html" + }, + "operationId": "inference-get-model", + "responses": { + "200": { + "$ref": "#/components/responses/inference.get_model#200" + } + } + } + }, "/": { "get": { "tags": [ @@ -20076,8 +20094,8 @@ "tags": [ "update_by_query" ], - "summary": "Updates documents that match the specified query. If no query is specified,\n performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change.", - "description": "Updates documents that match the specified query. If no query is specified,\n performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change.", + "summary": "Performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change.", + "description": "Performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html" }, diff --git a/output/schema/schema.json b/output/schema/schema.json index 12100bd375..054bf8f793 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -3355,6 +3355,114 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "private" + } + }, + "description": "Deletes a connector secret.", + "docUrl": null, + "name": "connector.secret_delete", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "DELETE" + ], + "path": "/_connector/_secret/{id}" + } + ], + "visibility": "private" + }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "private" + } + }, + "description": "Retrieves a secret stored by Connectors.", + "docUrl": null, + "name": "connector.secret_get", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_connector/_secret/{id}" + } + ], + "visibility": "private" + }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "private" + } + }, + "description": "Creates a secret for a Connector.", + "docUrl": null, + "name": "connector.secret_post", + "request": null, + "requestBodyRequired": true, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_connector/_secret" + } + ], + "visibility": "private" + }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "private" + } + }, + "description": "Creates or updates a secret for a Connector.", + "docUrl": null, + "name": "connector.secret_put", + "request": null, + "requestBodyRequired": true, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/_secret/{id}" + } + ], + "visibility": "private" + }, { "availability": { "serverless": { @@ -3394,6 +3502,33 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Checks in a connector sync job (refreshes 'last_seen').", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/check-in-connector-sync-job-api.html", + "name": "connector.sync_job_check_in", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/_sync_job/{connector_sync_job_id}/_check_in" + } + ], + "visibility": "public" + }, { "availability": { "serverless": { @@ -3433,6 +3568,36 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Sets an error for a connector sync job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/set-connector-sync-job-error-api.html", + "name": "connector.sync_job_error", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/_sync_job/{connector_sync_job_id}/_error" + } + ], + "visibility": "public" + }, { "availability": { "serverless": { @@ -3553,6 +3718,36 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Updates the stats fields in the connector sync job document.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/set-connector-sync-job-stats-api.html", + "name": "connector.sync_job_update_stats", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/_sync_job/{connector_sync_job_id}/_stats" + } + ], + "visibility": "public" + }, { "availability": { "serverless": { @@ -4806,6 +5001,63 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Executes an ESQL request asynchronously", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-api.html", + "name": "esql.async_query", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "stable", + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_query/async" + } + ], + "visibility": "public" + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Retrieves the results of a previously submitted async query request given its ID.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-get-api.html", + "name": "esql.async_query_get", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "stable", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_query/async/{id}" + } + ], + "visibility": "public" + }, { "availability": { "stack": { @@ -8658,6 +8910,12 @@ "since": "8.11.0", "stability": "experimental", "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_inference" + }, { "methods": [ "GET" @@ -13704,6 +13962,9 @@ "namespace": "_global.open_point_in_time" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.open_point_in_time" @@ -13761,6 +14022,123 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "private" + } + }, + "description": "Extracts a UI-optimized structure to render flamegraphs from Universal Profiling.", + "docUrl": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", + "name": "profiling.flamegraph", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "stable", + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_profiling/flamegraph" + } + ], + "visibility": "private" + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "private" + } + }, + "description": "Extracts raw stacktrace information from Universal Profiling.", + "docUrl": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", + "name": "profiling.stacktraces", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "stable", + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_profiling/stacktraces" + } + ], + "visibility": "private" + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "private" + } + }, + "description": "Returns basic information about the status of Universal Profiling.", + "docUrl": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", + "name": "profiling.status", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "stable", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_profiling/status" + } + ], + "visibility": "private" + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "private" + } + }, + "description": "Extracts a list of topN functions from Universal Profiling.", + "docUrl": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", + "name": "profiling.topn_functions", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "stable", + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_profiling/topn/functions" + } + ], + "visibility": "private" + }, { "availability": { "serverless": { @@ -17211,6 +17589,37 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Retrieves information for Users using a subset of query DSL", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-user.html", + "name": "security.query_user", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "stable", + "urls": [ + { + "methods": [ + "GET", + "POST" + ], + "path": "/_security/_query/user" + } + ], + "visibility": "public" + }, { "availability": { "serverless": { @@ -17769,6 +18178,44 @@ ], "visibility": "private" }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Simulates running ingest with example documents.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-ingest-api.html", + "name": "simulate.ingest", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "GET", + "POST" + ], + "path": "/_ingest/_simulate" + }, + { + "methods": [ + "GET", + "POST" + ], + "path": "/_ingest/{index}/_simulate" + } + ], + "visibility": "public" + }, { "availability": { "serverless": { @@ -19372,6 +19819,64 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Finds the structure of a text field in an index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-field-structure.html", + "name": "text_structure.find_field_structure", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "stable", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_text_structure/find_field_structure" + } + ], + "visibility": "public" + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-message-structure.html", + "name": "text_structure.find_message_structure", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "stable", + "urls": [ + { + "methods": [ + "GET", + "POST" + ], + "path": "/_text_structure/find_message_structure" + } + ], + "visibility": "public" + }, { "availability": { "serverless": { @@ -20032,7 +20537,7 @@ "stability": "stable" } }, - "description": "Updates documents that match the specified query. If no query is specified,\n performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change.", + "description": "Performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html", "name": "update_by_query", "request": { diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index 213a6c1e9f..22ca32aabd 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -58,6 +58,12 @@ "type_alias definition _global.search._types:Suggest - Expected 1 generic parameters but got 0" ] }, + "async_search.status": { + "request": [ + "Request: missing json spec query parameter 'keep_alive'" + ], + "response": [] + }, "async_search.submit": { "request": [ "Request: query parameter 'ccs_minimize_roundtrips' does not exist in the json spec", @@ -84,7 +90,9 @@ }, "bulk": { "request": [ - "Request: missing json spec query parameter 'type'" + "Request: missing json spec query parameter 'type'", + "Request: missing json spec query parameter 'require_data_stream'", + "Request: missing json spec query parameter 'list_executed_pipelines'" ], "response": [] }, @@ -408,43 +416,94 @@ "response": [] }, "ccr.delete_auto_follow_pattern": { - "request": [], + "request": [ + "Request: missing json spec query parameter 'master_timeout'" + ], "response": [ "response definition ccr.delete_auto_follow_pattern:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] }, + "ccr.follow": { + "request": [ + "Request: missing json spec query parameter 'master_timeout'" + ], + "response": [] + }, + "ccr.follow_info": { + "request": [ + "Request: missing json spec query parameter 'master_timeout'" + ], + "response": [] + }, + "ccr.follow_stats": { + "request": [ + "Request: missing json spec query parameter 'timeout'" + ], + "response": [] + }, + "ccr.forget_follower": { + "request": [ + "Request: missing json spec query parameter 'timeout'" + ], + "response": [] + }, + "ccr.get_auto_follow_pattern": { + "request": [ + "Request: missing json spec query parameter 'master_timeout'" + ], + "response": [] + }, "ccr.pause_auto_follow_pattern": { - "request": [], + "request": [ + "Request: missing json spec query parameter 'master_timeout'" + ], "response": [ "response definition ccr.pause_auto_follow_pattern:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] }, "ccr.pause_follow": { - "request": [], + "request": [ + "Request: missing json spec query parameter 'master_timeout'" + ], "response": [ "response definition ccr.pause_follow:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] }, "ccr.put_auto_follow_pattern": { - "request": [], + "request": [ + "Request: missing json spec query parameter 'master_timeout'" + ], "response": [ "response definition ccr.put_auto_follow_pattern:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] }, "ccr.resume_auto_follow_pattern": { - "request": [], + "request": [ + "Request: missing json spec query parameter 'master_timeout'" + ], "response": [ "response definition ccr.resume_auto_follow_pattern:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] }, "ccr.resume_follow": { - "request": [], + "request": [ + "Request: missing json spec query parameter 'master_timeout'" + ], "response": [ "response definition ccr.resume_follow:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] }, + "ccr.stats": { + "request": [ + "Request: missing json spec query parameter 'timeout'", + "Request: missing json spec query parameter 'master_timeout'" + ], + "response": [] + }, "ccr.unfollow": { - "request": [], + "request": [ + "Request: missing json spec query parameter 'master_timeout'" + ], "response": [ "response definition ccr.unfollow:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] @@ -494,12 +553,54 @@ ], "response": [] }, + "connector.secret_delete": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "connector.secret_get": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "connector.secret_post": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "connector.secret_put": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "connector.sync_job_check_in": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "connector.sync_job_delete": { "request": [], "response": [ "response definition connector.sync_job_delete:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] }, + "connector.sync_job_error": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "connector.sync_job_update_stats": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "create": { "request": [], "response": [ @@ -570,8 +671,22 @@ ], "response": [] }, + "esql.async_query": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "esql.async_query_get": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "esql.query": { - "request": [], + "request": [ + "Request: missing json spec query parameter 'drop_null_columns'" + ], "response": [ "type_alias definition _types:EsqlColumns / instance_of - No type definition for '_builtins:binary'" ] @@ -737,7 +852,9 @@ ] }, "index": { - "request": [], + "request": [ + "Request: missing json spec query parameter 'require_data_stream'" + ], "response": [ "response definition _global.index:Response / body / instance_of - Non-leaf type cannot be used here: '_types:WriteResponseBase'" ] @@ -856,7 +973,9 @@ ] }, "indices.put_settings": { - "request": [], + "request": [ + "Request: missing json spec query parameter 'reopen'" + ], "response": [ "response definition indices.put_settings:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] @@ -881,6 +1000,13 @@ ], "response": [] }, + "indices.rollover": { + "request": [ + "Request: missing json spec query parameter 'lazy'", + "Request: missing json spec query parameter 'target_failure_store'" + ], + "response": [] + }, "indices.simulate_index_template": { "request": [ "Request: missing json spec query parameter 'create'", @@ -906,6 +1032,12 @@ "response definition inference.delete_model:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] }, + "inference.get_model": { + "request": [ + "Request: path parameter 'inference_id' is optional in the json spec" + ], + "response": [] + }, "inference.put_model": { "request": [ "request definition inference.put_model:Request / body / instance_of - Non-leaf type cannot be used here: 'inference._types:ModelConfig'" @@ -1125,6 +1257,30 @@ ], "response": [] }, + "profiling.flamegraph": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "profiling.stacktraces": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "profiling.status": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "profiling.topn_functions": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "put_script": { "request": [ "Request: missing json spec query parameter 'context'" @@ -1252,13 +1408,6 @@ "response definition security.enable_user_profile:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] }, - "security.get_api_key": { - "request": [ - "Request: query parameter 'active_only' does not exist in the json spec", - "Request: query parameter 'with_profile_uid' does not exist in the json spec" - ], - "response": [] - }, "security.get_settings": { "request": [ "Missing request & response" @@ -1310,14 +1459,17 @@ "response": [] }, "security.query_api_keys": { - "request": [ - "Request: query parameter 'with_profile_uid' does not exist in the json spec", - "Request: query parameter 'typed_keys' does not exist in the json spec" - ], + "request": [], "response": [ "type_alias definition security.query_api_keys:ApiKeyAggregate / instance_of - Non-leaf type cannot be used here: '_types.aggregations:RangeAggregate'" ] }, + "security.query_user": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "security.suggest_user_profiles": { "request": [], "response": [ @@ -1367,6 +1519,12 @@ "response definition shutdown.put_node:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] }, + "simulate.ingest": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "slm.delete_lifecycle": { "request": [], "response": [ @@ -1458,6 +1616,18 @@ ], "response": [] }, + "text_structure.find_field_structure": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "text_structure.find_message_structure": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "transform.delete_transform": { "request": [], "response": [ diff --git a/specification/_json_spec/async_search.status.json b/specification/_json_spec/async_search.status.json index 30ba0c5c5d..29a628eb98 100644 --- a/specification/_json_spec/async_search.status.json +++ b/specification/_json_spec/async_search.status.json @@ -22,6 +22,12 @@ } } ] + }, + "params": { + "keep_alive": { + "type": "time", + "description": "Specify the time interval in which the results (partial or final) for this search will be available" + } } } } diff --git a/specification/_json_spec/bulk.json b/specification/_json_spec/bulk.json index addfd5b96d..59e79d0684 100644 --- a/specification/_json_spec/bulk.json +++ b/specification/_json_spec/bulk.json @@ -69,6 +69,14 @@ "require_alias": { "type": "boolean", "description": "Sets require_alias for all incoming documents. Defaults to unset (false)" + }, + "require_data_stream": { + "type": "boolean", + "description": "When true, requires the destination to be a data stream (existing or to-be-created). Default is false" + }, + "list_executed_pipelines": { + "type": "boolean", + "description": "Sets list_executed_pipelines for all incoming documents. Defaults to unset (false)" } }, "body": { diff --git a/specification/_json_spec/ccr.delete_auto_follow_pattern.json b/specification/_json_spec/ccr.delete_auto_follow_pattern.json index 037d89ee83..8609fc4321 100644 --- a/specification/_json_spec/ccr.delete_auto_follow_pattern.json +++ b/specification/_json_spec/ccr.delete_auto_follow_pattern.json @@ -22,6 +22,12 @@ } } ] + }, + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + } } } } diff --git a/specification/_json_spec/ccr.follow.json b/specification/_json_spec/ccr.follow.json index 47afdb56be..c4c098fb6c 100644 --- a/specification/_json_spec/ccr.follow.json +++ b/specification/_json_spec/ccr.follow.json @@ -29,6 +29,10 @@ "type": "string", "description": "Sets the number of shard copies that must be active before returning. Defaults to 0. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)", "default": "0" + }, + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" } }, "body": { diff --git a/specification/_json_spec/ccr.follow_info.json b/specification/_json_spec/ccr.follow_info.json index 3ee0404081..286c883ab6 100644 --- a/specification/_json_spec/ccr.follow_info.json +++ b/specification/_json_spec/ccr.follow_info.json @@ -22,6 +22,12 @@ } } ] + }, + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + } } } } diff --git a/specification/_json_spec/ccr.follow_stats.json b/specification/_json_spec/ccr.follow_stats.json index 5d022680a4..4c74385e48 100644 --- a/specification/_json_spec/ccr.follow_stats.json +++ b/specification/_json_spec/ccr.follow_stats.json @@ -22,6 +22,12 @@ } } ] + }, + "params": { + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } } } } diff --git a/specification/_json_spec/ccr.forget_follower.json b/specification/_json_spec/ccr.forget_follower.json index 9faf144350..1011971350 100644 --- a/specification/_json_spec/ccr.forget_follower.json +++ b/specification/_json_spec/ccr.forget_follower.json @@ -24,6 +24,12 @@ } ] }, + "params": { + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + } + }, "body": { "description": "the name and UUID of the follower index, the name of the cluster containing the follower index, and the alias from the perspective of that cluster for the remote cluster containing the leader index", "required": true diff --git a/specification/_json_spec/ccr.get_auto_follow_pattern.json b/specification/_json_spec/ccr.get_auto_follow_pattern.json index 881f10e59a..54479b784f 100644 --- a/specification/_json_spec/ccr.get_auto_follow_pattern.json +++ b/specification/_json_spec/ccr.get_auto_follow_pattern.json @@ -26,6 +26,12 @@ } } ] + }, + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + } } } } diff --git a/specification/_json_spec/ccr.pause_auto_follow_pattern.json b/specification/_json_spec/ccr.pause_auto_follow_pattern.json index 7654117db7..322a7ac947 100644 --- a/specification/_json_spec/ccr.pause_auto_follow_pattern.json +++ b/specification/_json_spec/ccr.pause_auto_follow_pattern.json @@ -22,6 +22,12 @@ } } ] + }, + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + } } } } diff --git a/specification/_json_spec/ccr.pause_follow.json b/specification/_json_spec/ccr.pause_follow.json index 5a3391fb82..613219e85f 100644 --- a/specification/_json_spec/ccr.pause_follow.json +++ b/specification/_json_spec/ccr.pause_follow.json @@ -22,6 +22,12 @@ } } ] + }, + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + } } } } diff --git a/specification/_json_spec/ccr.put_auto_follow_pattern.json b/specification/_json_spec/ccr.put_auto_follow_pattern.json index c504893eba..d631b1b576 100644 --- a/specification/_json_spec/ccr.put_auto_follow_pattern.json +++ b/specification/_json_spec/ccr.put_auto_follow_pattern.json @@ -24,6 +24,12 @@ } ] }, + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + } + }, "body": { "description": "The specification of the auto follow pattern", "required": true diff --git a/specification/_json_spec/ccr.resume_auto_follow_pattern.json b/specification/_json_spec/ccr.resume_auto_follow_pattern.json index 164344c9cd..90a259b45d 100644 --- a/specification/_json_spec/ccr.resume_auto_follow_pattern.json +++ b/specification/_json_spec/ccr.resume_auto_follow_pattern.json @@ -22,6 +22,12 @@ } } ] + }, + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + } } } } diff --git a/specification/_json_spec/ccr.resume_follow.json b/specification/_json_spec/ccr.resume_follow.json index 31da060a2d..aa2b955970 100644 --- a/specification/_json_spec/ccr.resume_follow.json +++ b/specification/_json_spec/ccr.resume_follow.json @@ -24,6 +24,12 @@ } ] }, + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + } + }, "body": { "description": "The name of the leader index and other optional ccr related parameters", "required": false diff --git a/specification/_json_spec/ccr.stats.json b/specification/_json_spec/ccr.stats.json index 3d450d47ab..cdaef7c4b4 100644 --- a/specification/_json_spec/ccr.stats.json +++ b/specification/_json_spec/ccr.stats.json @@ -16,6 +16,16 @@ "methods": ["GET"] } ] + }, + "params": { + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + }, + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + } } } } diff --git a/specification/_json_spec/ccr.unfollow.json b/specification/_json_spec/ccr.unfollow.json index 316b8f5e6c..61d7a287c1 100644 --- a/specification/_json_spec/ccr.unfollow.json +++ b/specification/_json_spec/ccr.unfollow.json @@ -22,6 +22,12 @@ } } ] + }, + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + } } } } diff --git a/specification/_json_spec/connector.secret_delete.json b/specification/_json_spec/connector.secret_delete.json new file mode 100644 index 0000000000..e8dd530535 --- /dev/null +++ b/specification/_json_spec/connector.secret_delete.json @@ -0,0 +1,28 @@ +{ + "connector.secret_delete": { + "documentation": { + "url": null, + "description": "Deletes a connector secret." + }, + "stability": "experimental", + "visibility": "private", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/_secret/{id}", + "methods": ["DELETE"], + "parts": { + "id": { + "type": "string", + "description": "The ID of the secret" + } + } + } + ] + }, + "params": {} + } +} diff --git a/specification/_json_spec/connector.secret_get.json b/specification/_json_spec/connector.secret_get.json new file mode 100644 index 0000000000..f3240968ce --- /dev/null +++ b/specification/_json_spec/connector.secret_get.json @@ -0,0 +1,28 @@ +{ + "connector.secret_get": { + "documentation": { + "url": null, + "description": "Retrieves a secret stored by Connectors." + }, + "stability": "experimental", + "visibility": "private", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/_secret/{id}", + "methods": ["GET"], + "parts": { + "id": { + "type": "string", + "description": "The ID of the secret" + } + } + } + ] + }, + "params": {} + } +} diff --git a/specification/_json_spec/connector.secret_post.json b/specification/_json_spec/connector.secret_post.json new file mode 100644 index 0000000000..938dc278b2 --- /dev/null +++ b/specification/_json_spec/connector.secret_post.json @@ -0,0 +1,26 @@ +{ + "connector.secret_post": { + "documentation": { + "url": null, + "description": "Creates a secret for a Connector." + }, + "stability": "experimental", + "visibility": "private", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/_secret", + "methods": ["POST"] + } + ] + }, + "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 new file mode 100644 index 0000000000..458713e404 --- /dev/null +++ b/specification/_json_spec/connector.secret_put.json @@ -0,0 +1,32 @@ +{ + "connector.secret_put": { + "documentation": { + "url": null, + "description": "Creates or updates a secret for a Connector." + }, + "stability": "experimental", + "visibility": "private", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/_secret/{id}", + "methods": ["PUT"], + "parts": { + "id": { + "type": "string", + "description": "The unique identifier of the connector secret to be created or updated." + } + } + } + ] + }, + "params": {}, + "body": { + "description": "The secret value to store", + "required": true + } + } +} diff --git a/specification/_json_spec/connector.sync_job_check_in.json b/specification/_json_spec/connector.sync_job_check_in.json new file mode 100644 index 0000000000..6f85303bc8 --- /dev/null +++ b/specification/_json_spec/connector.sync_job_check_in.json @@ -0,0 +1,27 @@ +{ + "connector.sync_job_check_in": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/check-in-connector-sync-job-api.html", + "description": "Checks in a connector sync job (refreshes 'last_seen')." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/_sync_job/{connector_sync_job_id}/_check_in", + "methods": ["PUT"], + "parts": { + "connector_sync_job_id": { + "type": "string", + "description": "The unique identifier of the connector sync job to be checked in" + } + } + } + ] + } + } +} diff --git a/specification/_json_spec/connector.sync_job_error.json b/specification/_json_spec/connector.sync_job_error.json new file mode 100644 index 0000000000..c4b55aff03 --- /dev/null +++ b/specification/_json_spec/connector.sync_job_error.json @@ -0,0 +1,32 @@ +{ + "connector.sync_job_error": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/set-connector-sync-job-error-api.html", + "description": "Sets an error for a connector sync job." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/_sync_job/{connector_sync_job_id}/_error", + "methods": ["PUT"], + "parts": { + "connector_sync_job_id": { + "type": "string", + "description": "The unique identifier of the connector sync job to set an error for." + } + } + } + ] + }, + "body": { + "description": "The error to set in the connector sync job.", + "required": true + } + } +} diff --git a/specification/_json_spec/connector.sync_job_update_stats.json b/specification/_json_spec/connector.sync_job_update_stats.json new file mode 100644 index 0000000000..ce4e5a87a7 --- /dev/null +++ b/specification/_json_spec/connector.sync_job_update_stats.json @@ -0,0 +1,32 @@ +{ + "connector.sync_job_update_stats": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/set-connector-sync-job-stats-api.html", + "description": "Updates the stats fields in the connector sync job document." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/_sync_job/{connector_sync_job_id}/_stats", + "methods": ["PUT"], + "parts": { + "connector_sync_job_id": { + "type": "string", + "description": "The unique identifier of the connector sync job to be updated." + } + } + } + ] + }, + "body": { + "description": "The stats to update for the connector sync job.", + "required": true + } + } +} diff --git a/specification/_json_spec/esql.async_query.json b/specification/_json_spec/esql.async_query.json new file mode 100644 index 0000000000..fe6b455181 --- /dev/null +++ b/specification/_json_spec/esql.async_query.json @@ -0,0 +1,42 @@ +{ + "esql.async_query": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-api.html", + "description": "Executes an ESQL request asynchronously" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_query/async", + "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 + }, + "drop_null_columns": { + "type": "boolean", + "description": "Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section.", + "default": false + } + }, + "body": { + "description": "Use the `query` element to start a query. Use `columnar` to format the answer.", + "required": true + } + } +} diff --git a/specification/_json_spec/esql.async_query_get.json b/specification/_json_spec/esql.async_query_get.json new file mode 100644 index 0000000000..b2b4b17ccc --- /dev/null +++ b/specification/_json_spec/esql.async_query_get.json @@ -0,0 +1,42 @@ +{ + "esql.async_query_get": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-get-api.html", + "description": "Retrieves the results of a previously submitted async query request given its ID." + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_query/async/{id}", + "methods": ["GET"], + "parts": { + "id": { + "type": "string", + "description": "The async query ID" + } + } + } + ] + }, + "params": { + "wait_for_completion_timeout": { + "type": "time", + "description": "Specify the time that the request should block waiting for the final response" + }, + "keep_alive": { + "type": "time", + "description": "Specify the time interval in which the results (partial or final) for this search will be available" + }, + "drop_null_columns": { + "type": "boolean", + "description": "Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section.", + "default": false + } + } + } +} diff --git a/specification/_json_spec/esql.query.json b/specification/_json_spec/esql.query.json index 3597c2773a..3bb46f0a07 100644 --- a/specification/_json_spec/esql.query.json +++ b/specification/_json_spec/esql.query.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-query-api.html", "description": "Executes an ESQL request" }, - "stability": "experimental", + "stability": "stable", "visibility": "public", "headers": { "accept": ["application/json"], @@ -27,10 +27,15 @@ "type": "string", "description": "The character to use between values within a CSV row. Only valid for the csv format.", "default": false + }, + "drop_null_columns": { + "type": "boolean", + "description": "Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section.", + "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.", + "description": "Use the `query` element to start a query. Use `columnar` to format the answer.", "required": true } } diff --git a/specification/_json_spec/field_caps.json b/specification/_json_spec/field_caps.json index 0460579608..bac569a746 100644 --- a/specification/_json_spec/field_caps.json +++ b/specification/_json_spec/field_caps.json @@ -63,7 +63,7 @@ "include_empty_fields": { "type": "boolean", "default": true, - "description": "Indicates whether empty fields should be included in the response." + "description": "Include empty fields in result" } }, "body": { diff --git a/specification/_json_spec/index.json b/specification/_json_spec/index.json index e63799f651..e6a900e9d8 100644 --- a/specification/_json_spec/index.json +++ b/specification/_json_spec/index.json @@ -85,6 +85,10 @@ "require_alias": { "type": "boolean", "description": "When true, requires destination to be an alias. Default is false" + }, + "require_data_stream": { + "type": "boolean", + "description": "When true, requires the destination to be a data stream (existing or to-be-created). Default is false" } }, "body": { diff --git a/specification/_json_spec/indices.put_settings.json b/specification/_json_spec/indices.put_settings.json index 07b98a6e7a..fb8cbbc167 100644 --- a/specification/_json_spec/indices.put_settings.json +++ b/specification/_json_spec/indices.put_settings.json @@ -41,6 +41,10 @@ "type": "boolean", "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false`" }, + "reopen": { + "type": "boolean", + "description": "Whether to close and reopen the index to apply non-dynamic settings. If set to `true` the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. The default is `false`" + }, "ignore_unavailable": { "type": "boolean", "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" diff --git a/specification/_json_spec/indices.rollover.json b/specification/_json_spec/indices.rollover.json index d66bc708d0..82b726f99c 100644 --- a/specification/_json_spec/indices.rollover.json +++ b/specification/_json_spec/indices.rollover.json @@ -54,6 +54,17 @@ "wait_for_active_shards": { "type": "string", "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns." + }, + "lazy": { + "type": "boolean", + "default": "false", + "description": "If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams." + }, + "target_failure_store": { + "type": "boolean", + "description": "If set to true, the rollover action will be applied on the failure store of the data stream.", + "visibility": "feature_flag", + "feature_flag": "es.failure_store_feature_flag_enabled" } }, "body": { diff --git a/specification/_json_spec/inference.get_model.json b/specification/_json_spec/inference.get_model.json index f0f68e5474..5f76b48e8e 100644 --- a/specification/_json_spec/inference.get_model.json +++ b/specification/_json_spec/inference.get_model.json @@ -11,6 +11,10 @@ }, "url": { "paths": [ + { + "path": "/_inference", + "methods": ["GET"] + }, { "path": "/_inference/{inference_id}", "methods": ["GET"], diff --git a/specification/_json_spec/open_point_in_time.json b/specification/_json_spec/open_point_in_time.json index 5652b5e953..34e9f4a4b6 100644 --- a/specification/_json_spec/open_point_in_time.json +++ b/specification/_json_spec/open_point_in_time.json @@ -7,7 +7,8 @@ "stability": "stable", "visibility": "public", "headers": { - "accept": ["application/json"] + "accept": ["application/json"], + "content_type": ["application/json"] }, "url": { "paths": [ @@ -47,6 +48,9 @@ "description": "Specific the time to live for the point in time", "required": true } + }, + "body": { + "description": "An index_filter specified with the Query DSL" } } } diff --git a/specification/_json_spec/profiling.flamegraph.json b/specification/_json_spec/profiling.flamegraph.json new file mode 100644 index 0000000000..4213503fdc --- /dev/null +++ b/specification/_json_spec/profiling.flamegraph.json @@ -0,0 +1,26 @@ +{ + "profiling.flamegraph": { + "documentation": { + "url": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", + "description": "Extracts a UI-optimized structure to render flamegraphs from Universal Profiling." + }, + "stability": "stable", + "visibility": "private", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_profiling/flamegraph", + "methods": ["POST"] + } + ] + }, + "body": { + "description": "The filter conditions for the flamegraph", + "required": true + } + } +} diff --git a/specification/_json_spec/profiling.stacktraces.json b/specification/_json_spec/profiling.stacktraces.json new file mode 100644 index 0000000000..4a7c887d7f --- /dev/null +++ b/specification/_json_spec/profiling.stacktraces.json @@ -0,0 +1,26 @@ +{ + "profiling.stacktraces": { + "documentation": { + "url": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", + "description": "Extracts raw stacktrace information from Universal Profiling." + }, + "stability": "stable", + "visibility": "private", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_profiling/stacktraces", + "methods": ["POST"] + } + ] + }, + "body": { + "description": "The filter conditions for stacktraces", + "required": true + } + } +} diff --git a/specification/_json_spec/profiling.status.json b/specification/_json_spec/profiling.status.json new file mode 100644 index 0000000000..ae6f81847b --- /dev/null +++ b/specification/_json_spec/profiling.status.json @@ -0,0 +1,35 @@ +{ + "profiling.status": { + "documentation": { + "url": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", + "description": "Returns basic information about the status of Universal Profiling." + }, + "stability": "stable", + "visibility": "private", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_profiling/status", + "methods": ["GET"] + } + ] + }, + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Explicit operation timeout" + }, + "wait_for_resources_created": { + "type": "boolean", + "description": "Whether to return immediately or wait until resources have been created" + } + } + } +} diff --git a/specification/_json_spec/profiling.topn_functions.json b/specification/_json_spec/profiling.topn_functions.json new file mode 100644 index 0000000000..8571b64796 --- /dev/null +++ b/specification/_json_spec/profiling.topn_functions.json @@ -0,0 +1,26 @@ +{ + "profiling.topn_functions": { + "documentation": { + "url": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", + "description": "Extracts a list of topN functions from Universal Profiling." + }, + "stability": "stable", + "visibility": "private", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_profiling/topn/functions", + "methods": ["POST"] + } + ] + }, + "body": { + "description": "The filter conditions for stacktraces", + "required": true + } + } +} diff --git a/specification/_json_spec/search_application.search.json b/specification/_json_spec/search_application.search.json index 418f7a1670..07709bf8e1 100644 --- a/specification/_json_spec/search_application.search.json +++ b/specification/_json_spec/search_application.search.json @@ -27,6 +27,13 @@ "body": { "description": "Search parameters, including template parameters that override defaults", "required": false + }, + "params": { + "typed_keys": { + "type": "boolean", + "default": false, + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response" + } } } } diff --git a/specification/_json_spec/security.get_api_key.json b/specification/_json_spec/security.get_api_key.json index 516760b69e..a127e06511 100644 --- a/specification/_json_spec/security.get_api_key.json +++ b/specification/_json_spec/security.get_api_key.json @@ -43,6 +43,16 @@ "type": "boolean", "default": false, "description": "flag to show the limited-by role descriptors of API Keys" + }, + "with_profile_uid": { + "type": "boolean", + "default": false, + "description": "flag to also retrieve the API Key's owner profile uid, if it exists" + }, + "active_only": { + "type": "boolean", + "default": false, + "description": "flag to limit response to only active (not invalidated or expired) API keys" } } } diff --git a/specification/_json_spec/security.query_api_keys.json b/specification/_json_spec/security.query_api_keys.json index 3b2712774c..ab9acea209 100644 --- a/specification/_json_spec/security.query_api_keys.json +++ b/specification/_json_spec/security.query_api_keys.json @@ -23,6 +23,16 @@ "type": "boolean", "default": false, "description": "flag to show the limited-by role descriptors of API Keys" + }, + "with_profile_uid": { + "type": "boolean", + "default": false, + "description": "flag to also retrieve the API Key's owner profile uid, if it exists" + }, + "typed_keys": { + "type": "boolean", + "default": false, + "description": "flag to prefix aggregation names by their respective types in the response" } }, "body": { diff --git a/specification/_json_spec/security.query_user.json b/specification/_json_spec/security.query_user.json new file mode 100644 index 0000000000..a16a1aeadc --- /dev/null +++ b/specification/_json_spec/security.query_user.json @@ -0,0 +1,33 @@ +{ + "security.query_user": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-user.html", + "description": "Retrieves information for Users using a subset of query DSL" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_security/_query/user", + "methods": ["GET", "POST"] + } + ] + }, + "body": { + "description": "From, size, query, sort and search_after", + "required": false + }, + "params": { + "with_profile_uid": { + "type": "boolean", + "default": false, + "description": "flag to retrieve profile uid (if exists) associated with the user" + } + } + } +} diff --git a/specification/_json_spec/simulate.ingest.json b/specification/_json_spec/simulate.ingest.json new file mode 100644 index 0000000000..5bd6527f24 --- /dev/null +++ b/specification/_json_spec/simulate.ingest.json @@ -0,0 +1,42 @@ +{ + "simulate.ingest": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-ingest-api.html", + "description": "Simulates running ingest with example documents." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_ingest/_simulate", + "methods": ["GET", "POST"] + }, + { + "path": "/_ingest/{index}/_simulate", + "methods": ["GET", "POST"], + "parts": { + "index": { + "type": "string", + "description": "Default index for docs which don't provide one" + } + } + } + ] + }, + "params": { + "pipeline": { + "type": "string", + "description": "The pipeline id to preprocess incoming documents with if no pipeline is given for a particular document" + } + }, + "body": { + "description": "The simulate definition", + "required": true + } + } +} diff --git a/specification/_json_spec/text_structure.find_field_structure.json b/specification/_json_spec/text_structure.find_field_structure.json new file mode 100644 index 0000000000..9bbf183de9 --- /dev/null +++ b/specification/_json_spec/text_structure.find_field_structure.json @@ -0,0 +1,85 @@ +{ + "text_structure.find_field_structure": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-field-structure.html", + "description": "Finds the structure of a text field in an index." + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_text_structure/find_field_structure", + "methods": ["GET"] + } + ] + }, + "params": { + "index": { + "type": "string", + "description": "The index containing the analyzed field", + "required": true + }, + "field": { + "type": "string", + "description": "The field that should be analyzed", + "required": true + }, + "documents_to_sample": { + "type": "int", + "description": "How many documents should be included in the analysis", + "default": 1000 + }, + "timeout": { + "type": "time", + "description": "Timeout after which the analysis will be aborted", + "default": "25s" + }, + "format": { + "type": "enum", + "options": ["ndjson", "xml", "delimited", "semi_structured_text"], + "description": "Optional parameter to specify the high level file format" + }, + "column_names": { + "type": "list", + "description": "Optional parameter containing a comma separated list of the column names for a delimited file" + }, + "delimiter": { + "type": "string", + "description": "Optional parameter to specify the delimiter character for a delimited file - must be a single character" + }, + "quote": { + "type": "string", + "description": "Optional parameter to specify the quote character for a delimited file - must be a single character" + }, + "should_trim_fields": { + "type": "boolean", + "description": "Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them" + }, + "grok_pattern": { + "type": "string", + "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", + "description": "Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'" + }, + "timestamp_field": { + "type": "string", + "description": "Optional parameter to specify the timestamp field in the file" + }, + "timestamp_format": { + "type": "string", + "description": "Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format" + }, + "explain": { + "type": "boolean", + "description": "Whether to include a commentary on how the structure was derived", + "default": false + } + } + } +} diff --git a/specification/_json_spec/text_structure.find_message_structure.json b/specification/_json_spec/text_structure.find_message_structure.json new file mode 100644 index 0000000000..db4d552cb4 --- /dev/null +++ b/specification/_json_spec/text_structure.find_message_structure.json @@ -0,0 +1,75 @@ +{ + "text_structure.find_message_structure": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-message-structure.html", + "description": "Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch." + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_text_structure/find_message_structure", + "methods": ["GET", "POST"] + } + ] + }, + "params": { + "timeout": { + "type": "time", + "description": "Timeout after which the analysis will be aborted", + "default": "25s" + }, + "format": { + "type": "enum", + "options": ["ndjson", "xml", "delimited", "semi_structured_text"], + "description": "Optional parameter to specify the high level file format" + }, + "column_names": { + "type": "list", + "description": "Optional parameter containing a comma separated list of the column names for a delimited file" + }, + "delimiter": { + "type": "string", + "description": "Optional parameter to specify the delimiter character for a delimited file - must be a single character" + }, + "quote": { + "type": "string", + "description": "Optional parameter to specify the quote character for a delimited file - must be a single character" + }, + "should_trim_fields": { + "type": "boolean", + "description": "Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them" + }, + "grok_pattern": { + "type": "string", + "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", + "description": "Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'" + }, + "timestamp_field": { + "type": "string", + "description": "Optional parameter to specify the timestamp field in the file" + }, + "timestamp_format": { + "type": "string", + "description": "Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format" + }, + "explain": { + "type": "boolean", + "description": "Whether to include a commentary on how the structure was derived", + "default": false + } + }, + "body": { + "description": "JSON object with one field [messages], containing an array of messages to be analyzed", + "required": true + } + } +} diff --git a/specification/_json_spec/update_by_query.json b/specification/_json_spec/update_by_query.json index b6068132ae..3856c4249a 100644 --- a/specification/_json_spec/update_by_query.json +++ b/specification/_json_spec/update_by_query.json @@ -2,7 +2,7 @@ "update_by_query": { "documentation": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html", - "description": "Updates documents that match the specified query. If no query is specified,\n performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change." + "description": "Performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change." }, "stability": "stable", "visibility": "public",