From 1c3d8e2c119242c49250bf88b6cc2a35dce4872f Mon Sep 17 00:00:00 2001 From: pquentin <42327+pquentin@users.noreply.github.com> Date: Sat, 30 Nov 2024 04:06:19 +0000 Subject: [PATCH 1/2] Update rest-api-spec --- output/schema/validation-errors.json | 2 ++ specification/_json_spec/async_search.submit.json | 10 ---------- 2 files changed, 2 insertions(+), 10 deletions(-) diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index 0cbd80c628..389e53d701 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -51,7 +51,9 @@ }, "async_search.submit": { "request": [ + "Request: query parameter 'keep_alive' does not exist in the json spec", "Request: query parameter 'min_compatible_shard_node' does not exist in the json spec", + "Request: query parameter 'pre_filter_shard_size' does not exist in the json spec", "interface definition _types:QueryVectorBuilder - Property text_embedding is a single-variant and must be required", "type_alias definition _spec_utils:PipeSeparatedFlags / union_of / instance_of - No type definition for '_spec_utils.PipeSeparatedFlags:T'" ], diff --git a/specification/_json_spec/async_search.submit.json b/specification/_json_spec/async_search.submit.json index 628a79a4e9..2d5ad25831 100644 --- a/specification/_json_spec/async_search.submit.json +++ b/specification/_json_spec/async_search.submit.json @@ -39,11 +39,6 @@ "description": "Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)", "default": false }, - "keep_alive": { - "type": "time", - "description": "Update the time interval in which the results (partial or final) for this search will be available", - "default": "5d" - }, "batched_reduce_size": { "type": "number", "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available.", @@ -118,11 +113,6 @@ "type": "string", "description": "Specify the node or shard the operation should be performed on (default: random)" }, - "pre_filter_shard_size": { - "type": "number", - "default": 1, - "description": "Cannot be changed: this is to enforce the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped." - }, "rest_total_hits_as_int": { "type": "boolean", "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response", From a3e09d1bfe9fc920071c4ffbf334e1be4302d767 Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Mon, 2 Dec 2024 14:32:06 +0400 Subject: [PATCH 2/2] Remove two rejected parameters from async_search.submit --- output/openapi/elasticsearch-openapi.json | 32 ------------------- .../elasticsearch-serverless-openapi.json | 32 ------------------- output/schema/schema-serverless.json | 28 +--------------- output/schema/schema.json | 28 +--------------- output/schema/validation-errors.json | 2 -- output/typescript/types.ts | 2 -- .../submit/AsyncSearchSubmitRequest.ts | 15 ++------- 7 files changed, 4 insertions(+), 135 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 343bd9376c..1fd0ba4707 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -170,9 +170,6 @@ { "$ref": "#/components/parameters/async_search.submit#keep_on_completion" }, - { - "$ref": "#/components/parameters/async_search.submit#keep_alive" - }, { "$ref": "#/components/parameters/async_search.submit#allow_no_indices" }, @@ -224,9 +221,6 @@ { "$ref": "#/components/parameters/async_search.submit#preference" }, - { - "$ref": "#/components/parameters/async_search.submit#pre_filter_shard_size" - }, { "$ref": "#/components/parameters/async_search.submit#request_cache" }, @@ -329,9 +323,6 @@ { "$ref": "#/components/parameters/async_search.submit#keep_on_completion" }, - { - "$ref": "#/components/parameters/async_search.submit#keep_alive" - }, { "$ref": "#/components/parameters/async_search.submit#allow_no_indices" }, @@ -383,9 +374,6 @@ { "$ref": "#/components/parameters/async_search.submit#preference" }, - { - "$ref": "#/components/parameters/async_search.submit#pre_filter_shard_size" - }, { "$ref": "#/components/parameters/async_search.submit#request_cache" }, @@ -92583,16 +92571,6 @@ }, "style": "form" }, - "async_search.submit#keep_alive": { - "in": "query", - "name": "keep_alive", - "description": "Specifies how long the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Duration" - }, - "style": "form" - }, "async_search.submit#allow_no_indices": { "in": "query", "name": "allow_no_indices", @@ -92762,16 +92740,6 @@ }, "style": "form" }, - "async_search.submit#pre_filter_shard_size": { - "in": "query", - "name": "pre_filter_shard_size", - "description": "The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped.", - "deprecated": false, - "schema": { - "type": "number" - }, - "style": "form" - }, "async_search.submit#request_cache": { "in": "query", "name": "request_cache", diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index d42c978569..cca4e875b2 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -170,9 +170,6 @@ { "$ref": "#/components/parameters/async_search.submit#keep_on_completion" }, - { - "$ref": "#/components/parameters/async_search.submit#keep_alive" - }, { "$ref": "#/components/parameters/async_search.submit#allow_no_indices" }, @@ -224,9 +221,6 @@ { "$ref": "#/components/parameters/async_search.submit#preference" }, - { - "$ref": "#/components/parameters/async_search.submit#pre_filter_shard_size" - }, { "$ref": "#/components/parameters/async_search.submit#request_cache" }, @@ -329,9 +323,6 @@ { "$ref": "#/components/parameters/async_search.submit#keep_on_completion" }, - { - "$ref": "#/components/parameters/async_search.submit#keep_alive" - }, { "$ref": "#/components/parameters/async_search.submit#allow_no_indices" }, @@ -383,9 +374,6 @@ { "$ref": "#/components/parameters/async_search.submit#preference" }, - { - "$ref": "#/components/parameters/async_search.submit#pre_filter_shard_size" - }, { "$ref": "#/components/parameters/async_search.submit#request_cache" }, @@ -56914,16 +56902,6 @@ }, "style": "form" }, - "async_search.submit#keep_alive": { - "in": "query", - "name": "keep_alive", - "description": "Specifies how long the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Duration" - }, - "style": "form" - }, "async_search.submit#allow_no_indices": { "in": "query", "name": "allow_no_indices", @@ -57093,16 +57071,6 @@ }, "style": "form" }, - "async_search.submit#pre_filter_shard_size": { - "in": "query", - "name": "pre_filter_shard_size", - "description": "The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped.", - "deprecated": false, - "schema": { - "type": "number" - }, - "style": "form" - }, "async_search.submit#request_cache": { "in": "query", "name": "request_cache", diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 089746d09a..65615ae7d2 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -10687,19 +10687,6 @@ } } }, - { - "description": "Specifies how long the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.", - "name": "keep_alive", - "required": false, - "serverDefault": "5d", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, { "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", @@ -10905,19 +10892,6 @@ } } }, - { - "description": "The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped.", - "name": "pre_filter_shard_size", - "required": false, - "serverDefault": 1, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, { "description": "Specify if request cache should be used for this request or not, defaults to true", "name": "request_cache", @@ -11226,7 +11200,7 @@ } } ], - "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L291" + "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L280" }, { "body": { diff --git a/output/schema/schema.json b/output/schema/schema.json index b29c2f2f4d..805d41d07a 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -88092,19 +88092,6 @@ } } }, - { - "description": "Specifies how long the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.", - "name": "keep_alive", - "required": false, - "serverDefault": "5d", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, { "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", @@ -88310,19 +88297,6 @@ } } }, - { - "description": "The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped.", - "name": "pre_filter_shard_size", - "required": false, - "serverDefault": 1, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, { "description": "Specify if request cache should be used for this request or not, defaults to true", "name": "request_cache", @@ -88631,7 +88605,7 @@ } } ], - "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L291" + "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L280" }, { "kind": "response", diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index 389e53d701..0cbd80c628 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -51,9 +51,7 @@ }, "async_search.submit": { "request": [ - "Request: query parameter 'keep_alive' does not exist in the json spec", "Request: query parameter 'min_compatible_shard_node' does not exist in the json spec", - "Request: query parameter 'pre_filter_shard_size' does not exist in the json spec", "interface definition _types:QueryVectorBuilder - Property text_embedding is a single-variant and must be required", "type_alias definition _spec_utils:PipeSeparatedFlags / union_of / instance_of - No type definition for '_spec_utils.PipeSeparatedFlags:T'" ], diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 3d81ed461e..f73cb069a8 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -6747,7 +6747,6 @@ export interface AsyncSearchSubmitRequest extends RequestBase { index?: Indices wait_for_completion_timeout?: Duration keep_on_completion?: boolean - keep_alive?: Duration allow_no_indices?: boolean allow_partial_search_results?: boolean analyzer?: string @@ -6765,7 +6764,6 @@ export interface AsyncSearchSubmitRequest extends RequestBase { max_concurrent_shard_requests?: long min_compatible_shard_node?: VersionString preference?: string - pre_filter_shard_size?: long request_cache?: boolean routing?: Routing search_type?: SearchType diff --git a/specification/async_search/submit/AsyncSearchSubmitRequest.ts b/specification/async_search/submit/AsyncSearchSubmitRequest.ts index 28798b2ee5..ad6f95179a 100644 --- a/specification/async_search/submit/AsyncSearchSubmitRequest.ts +++ b/specification/async_search/submit/AsyncSearchSubmitRequest.ts @@ -68,8 +68,8 @@ import { Duration } from '@_types/Time' * @doc_tag search */ // NOTE: this is a SearchRequest with: -// * 3 added parameters: wait_for_completion_timeout, keep_on_completion and keep_alive -// * 1 removed parameters: scroll +// * 2 added parameters: wait_for_completion_timeout, keep_on_completion +// * 2 removed parameters: scroll, pre_filter_shard_size export interface Request extends RequestBase { path_parts: { index?: Indices @@ -86,12 +86,6 @@ export interface Request extends RequestBase { * @server_default false */ keep_on_completion?: boolean - /** - * Specifies how long the async search needs to be available. - * Ongoing async searches and any saved search results are deleted after this period. - * @server_default 5d - */ - keep_alive?: Duration allow_no_indices?: boolean allow_partial_search_results?: boolean analyzer?: string @@ -118,11 +112,6 @@ export interface Request extends RequestBase { max_concurrent_shard_requests?: long min_compatible_shard_node?: VersionString preference?: string - /** - * The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped. - * @server_default 1 - */ - pre_filter_shard_size?: long /** @server_default true */ request_cache?: boolean routing?: Routing