Skip to content

Commit b808c35

Browse files
authored
Fix AsyncQueryResuest - those parameters should be in the body (#4517) (#4531)
(cherry picked from commit 0ac4f3b)
1 parent 3b6a898 commit b808c35

File tree

5 files changed

+50
-100
lines changed

5 files changed

+50
-100
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 7 additions & 30 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 27 additions & 40 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/validation-errors.json

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -194,14 +194,6 @@
194194
],
195195
"response": []
196196
},
197-
"esql.async_query": {
198-
"request": [
199-
"Request: query parameter 'keep_alive' does not exist in the json spec",
200-
"Request: query parameter 'keep_on_completion' does not exist in the json spec",
201-
"Request: query parameter 'wait_for_completion_timeout' does not exist in the json spec"
202-
],
203-
"response": []
204-
},
205197
"get_source": {
206198
"request": [
207199
"Request: query parameter 'stored_fields' does not exist in the json spec"

output/typescript/types.ts

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/esql/async_query/AsyncQueryRequest.ts

Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -61,28 +61,6 @@ export interface Request extends RequestBase {
6161
* A short version of the Accept header, for example `json` or `yaml`.
6262
*/
6363
format?: EsqlFormat
64-
/**
65-
* The period for which the query and its results are stored in the cluster.
66-
* The default period is five days.
67-
* When this period expires, the query and its results are deleted, even if the query is still ongoing.
68-
* If the `keep_on_completion` parameter is false, Elasticsearch only stores async queries that do not complete within the period set by the `wait_for_completion_timeout` parameter, regardless of this value.
69-
* @server_default 5d
70-
*/
71-
keep_alive?: Duration
72-
/**
73-
* Indicates whether the query and its results are stored in the cluster.
74-
* If false, the query and its results are stored in the cluster only if the request does not complete during the period set by the `wait_for_completion_timeout` parameter.
75-
* @server_default false
76-
*/
77-
keep_on_completion?: boolean
78-
/**
79-
* The period to wait for the request to finish.
80-
* By default, the request waits for 1 second for the query results.
81-
* If the query completes during this period, results are returned
82-
* Otherwise, a query ID is returned that can later be used to retrieve the results.
83-
* @server_default 1s
84-
*/
85-
wait_for_completion_timeout?: Duration
8664
}
8765
/**
8866
* Use the `query` element to start a query. Use `time_zone` to specify an execution time zone and `columnar` to format the answer.
@@ -137,5 +115,19 @@ export interface Request extends RequestBase {
137115
* @server_default 1s
138116
*/
139117
wait_for_completion_timeout?: Duration
118+
/**
119+
* The period for which the query and its results are stored in the cluster.
120+
* The default period is five days.
121+
* When this period expires, the query and its results are deleted, even if the query is still ongoing.
122+
* If the `keep_on_completion` parameter is false, Elasticsearch only stores async queries that do not complete within the period set by the `wait_for_completion_timeout` parameter, regardless of this value.
123+
* @server_default 5d
124+
*/
125+
keep_alive?: Duration
126+
/**
127+
* Indicates whether the query and its results are stored in the cluster.
128+
* If false, the query and its results are stored in the cluster only if the request does not complete during the period set by the `wait_for_completion_timeout` parameter.
129+
* @server_default false
130+
*/
131+
keep_on_completion?: boolean
140132
}
141133
}

0 commit comments

Comments
 (0)