From ead744a3f41beb38de093aab7f923d713fe40d3a Mon Sep 17 00:00:00 2001 From: pquentin <42327+pquentin@users.noreply.github.com> Date: Sun, 22 Dec 2024 04:06:25 +0000 Subject: [PATCH] Update rest-api-spec --- output/schema/schema-serverless.json | 60 +++++++++++-- output/schema/schema.json | 84 +++++++++++++++++++ output/schema/validation-errors.json | 26 +++++- specification/_json_spec/bulk.json | 8 +- specification/_json_spec/eql.search.json | 10 +++ .../_json_spec/migrate.cancel_reindex.json | 28 +++++++ .../migrate.get_reindex_status.json | 28 +++++++ specification/_json_spec/migrate.reindex.json | 26 ++++++ 8 files changed, 259 insertions(+), 11 deletions(-) create mode 100644 specification/_json_spec/migrate.cancel_reindex.json create mode 100644 specification/_json_spec/migrate.get_reindex_status.json create mode 100644 specification/_json_spec/migrate.reindex.json diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 99608360b2..a5b7c2318c 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -3149,6 +3149,7 @@ } }, "description": "Delete data streams.\nDeletes one or more data streams and their backing indices.", + "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.delete_data_stream", "privileges": { @@ -3338,6 +3339,7 @@ } }, "description": "Get the status for a data stream lifecycle.\nGet information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.", + "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html", "name": "indices.explain_data_lifecycle", "request": { @@ -3819,6 +3821,7 @@ } }, "description": "Update data stream lifecycles.\nUpdate the data stream lifecycle of the specified data streams.", + "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html", "name": "indices.put_data_lifecycle", "request": { @@ -20970,7 +20973,7 @@ } } ], - "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts#L24-L51" + "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts#L24-L52" }, { "body": { @@ -21433,7 +21436,7 @@ } } ], - "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts#L24-L39" + "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts#L24-L40" }, { "body": { @@ -22858,7 +22861,7 @@ } } ], - "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts#L25-L76" + "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts#L25-L77" }, { "body": { @@ -105256,6 +105259,44 @@ ], "specLocation": "tasks/_types/TaskListResponseBase.ts#L45-L47" }, + { + "kind": "enum", + "members": [ + { + "name": "disabled" + }, + { + "name": "v1" + } + ], + "name": { + "name": "EcsCompatibilityType", + "namespace": "text_structure._types" + }, + "specLocation": "text_structure/_types/Structure.ts#L40-L43" + }, + { + "kind": "enum", + "members": [ + { + "name": "delimited" + }, + { + "name": "ndjson" + }, + { + "name": "semi_structured_text" + }, + { + "name": "xml" + } + ], + "name": { + "name": "FormatType", + "namespace": "text_structure._types" + }, + "specLocation": "text_structure/_types/Structure.ts#L45-L50" + }, { "kind": "enum", "members": [ @@ -116416,7 +116457,7 @@ } } ], - "specLocation": "connector/_types/Connector.ts#L237-L268" + "specLocation": "connector/_types/Connector.ts#L252-L283" }, { "kind": "interface", @@ -116426,6 +116467,7 @@ }, "properties": [ { + "description": "Indicates whether document-level security is enabled.", "name": "document_level_security", "required": false, "type": { @@ -116437,6 +116479,7 @@ } }, { + "description": "Indicates whether incremental syncs are enabled.", "name": "incremental_sync", "required": false, "type": { @@ -116448,6 +116491,7 @@ } }, { + "description": "Indicates whether managed connector API keys are enabled.", "name": "native_connector_api_keys", "required": false, "type": { @@ -116470,7 +116514,7 @@ } } ], - "specLocation": "connector/_types/Connector.ts#L224-L229" + "specLocation": "connector/_types/Connector.ts#L230-L244" }, { "kind": "interface", @@ -116501,6 +116545,7 @@ }, "properties": [ { + "description": "Indicates whether advanced sync rules are enabled.", "name": "advanced", "required": false, "type": { @@ -116512,6 +116557,7 @@ } }, { + "description": "Indicates whether basic sync rules are enabled.", "name": "basic", "required": false, "type": { @@ -116523,7 +116569,7 @@ } } ], - "specLocation": "connector/_types/Connector.ts#L219-L222" + "specLocation": "connector/_types/Connector.ts#L219-L228" }, { "kind": "interface", @@ -116919,7 +116965,7 @@ } } ], - "specLocation": "connector/_types/Connector.ts#L231-L235" + "specLocation": "connector/_types/Connector.ts#L246-L250" }, { "kind": "interface", diff --git a/output/schema/schema.json b/output/schema/schema.json index 1343674085..9eab2d8299 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -9614,6 +9614,90 @@ } ] }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "private" + } + }, + "description": "This API returns the status of a migration reindex attempt for a data stream or index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html", + "name": "migrate.cancel_reindex", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_migration/reindex/{index}/_cancel" + } + ] + }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "private" + } + }, + "description": "This API returns the status of a migration reindex attempt for a data stream or index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html", + "name": "migrate.get_reindex_status", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_migration/reindex/{index}/_status" + } + ] + }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "private" + } + }, + "description": "This API reindexes all legacy backing indices for a data stream. It does this in a persistent task. The persistent task id is returned immediately, and the reindexing work is completed in that task", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html", + "name": "migrate.reindex", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_migration/reindex" + } + ] + }, { "availability": { "stack": { diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index ce971775f8..5b654a4716 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -43,6 +43,12 @@ ], "response": [] }, + "bulk": { + "request": [ + "Request: missing json spec query parameter 'type'" + ], + "response": [] + }, "capabilities": { "request": [ "Missing request & response" @@ -394,8 +400,6 @@ "eql.search": { "request": [ "Request: query parameter 'allow_no_indices' does not exist in the json spec", - "Request: query parameter 'allow_partial_search_results' does not exist in the json spec", - "Request: query parameter 'allow_partial_sequence_results' does not exist in the json spec", "Request: query parameter 'expand_wildcards' does not exist in the json spec", "Request: query parameter 'ignore_unavailable' does not exist in the json spec" ], @@ -638,6 +642,24 @@ ], "response": [] }, + "migrate.cancel_reindex": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "migrate.get_reindex_status": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "migrate.reindex": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "ml.delete_trained_model": { "request": [ "Request: missing json spec query parameter 'timeout'" diff --git a/specification/_json_spec/bulk.json b/specification/_json_spec/bulk.json index 3444e1c017..59e79d0684 100644 --- a/specification/_json_spec/bulk.json +++ b/specification/_json_spec/bulk.json @@ -46,6 +46,10 @@ "type": "time", "description": "Explicit operation timeout" }, + "type": { + "type": "string", + "description": "Default document type for items which don't provide one" + }, "_source": { "type": "list", "description": "True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request" @@ -64,11 +68,11 @@ }, "require_alias": { "type": "boolean", - "description": "If true, the request’s actions must target an index alias. Defaults to false." + "description": "Sets require_alias for all incoming documents. Defaults to unset (false)" }, "require_data_stream": { "type": "boolean", - "description": "If true, the request's actions must target a data stream (existing or to-be-created). Default to false" + "description": "When true, requires the destination to be a data stream (existing or to-be-created). Default is false" }, "list_executed_pipelines": { "type": "boolean", diff --git a/specification/_json_spec/eql.search.json b/specification/_json_spec/eql.search.json index 430a2a5ac8..3818508320 100644 --- a/specification/_json_spec/eql.search.json +++ b/specification/_json_spec/eql.search.json @@ -38,6 +38,16 @@ "type": "time", "description": "Update the time interval in which the results (partial or final) for this search will be available", "default": "5d" + }, + "allow_partial_search_results": { + "type": "boolean", + "description": "Control whether the query should keep running in case of shard failures, and return partial results", + "default": false + }, + "allow_partial_sequence_results": { + "type": "boolean", + "description": "Control whether a sequence query should return partial results or no results at all in case of shard failures. This option has effect only if [allow_partial_search_results] is true.", + "default": false } }, "body": { diff --git a/specification/_json_spec/migrate.cancel_reindex.json b/specification/_json_spec/migrate.cancel_reindex.json new file mode 100644 index 0000000000..660bd47272 --- /dev/null +++ b/specification/_json_spec/migrate.cancel_reindex.json @@ -0,0 +1,28 @@ +{ + "migrate.cancel_reindex": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html", + "description": "This API returns the status of a migration reindex attempt for a data stream or index" + }, + "stability": "experimental", + "visibility": "private", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_migration/reindex/{index}/_cancel", + "methods": ["POST"], + "parts": { + "index": { + "type": "string", + "description": "The index or data stream name" + } + } + } + ] + } + } +} diff --git a/specification/_json_spec/migrate.get_reindex_status.json b/specification/_json_spec/migrate.get_reindex_status.json new file mode 100644 index 0000000000..d5361ff1bb --- /dev/null +++ b/specification/_json_spec/migrate.get_reindex_status.json @@ -0,0 +1,28 @@ +{ + "migrate.get_reindex_status": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html", + "description": "This API returns the status of a migration reindex attempt for a data stream or index" + }, + "stability": "experimental", + "visibility": "private", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_migration/reindex/{index}/_status", + "methods": ["GET"], + "parts": { + "index": { + "type": "string", + "description": "The index or data stream name" + } + } + } + ] + } + } +} diff --git a/specification/_json_spec/migrate.reindex.json b/specification/_json_spec/migrate.reindex.json new file mode 100644 index 0000000000..ae2e6a8f8a --- /dev/null +++ b/specification/_json_spec/migrate.reindex.json @@ -0,0 +1,26 @@ +{ + "migrate.reindex": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html", + "description": "This API reindexes all legacy backing indices for a data stream. It does this in a persistent task. The persistent task id is returned immediately, and the reindexing work is completed in that task" + }, + "stability": "experimental", + "visibility": "private", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_migration/reindex", + "methods": ["POST"] + } + ] + }, + "body": { + "description": "The body contains the fields `mode` and `source.index, where the only mode currently supported is `upgrade`, and the `source.index` must be a data stream name", + "required": true + } + } +}