Skip to content

Commit d5611a2

Browse files
committed
Add esql.async_query_delete
1 parent 069a905 commit d5611a2

File tree

7 files changed

+230
-0
lines changed

7 files changed

+230
-0
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 37 additions & 0 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: 89 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/typescript/types.ts

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

specification/_doc_ids/table.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,7 @@ eql-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-
161161
eql,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html
162162
esql,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql.html
163163
esql-async-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-async-query-api.html
164+
esql-async-query-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-async-query-delete-api.html
164165
esql-async-query-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-async-query-get-api.html
165166
esql-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html
166167
esql-query-params,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html#esql-rest-params
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"esql.async_query_delete": {
3+
"documentation": {
4+
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-delete-api.html",
5+
"description": "Delete an async query request given its ID."
6+
},
7+
"stability": "stable",
8+
"visibility": "public",
9+
"headers": {
10+
"accept": ["application/json"]
11+
},
12+
"url": {
13+
"paths": [
14+
{
15+
"path": "/_query/async/{id}",
16+
"methods": ["DELETE"],
17+
"parts": {
18+
"id": {
19+
"type": "string",
20+
"description": "The async query ID"
21+
}
22+
}
23+
}
24+
]
25+
}
26+
}
27+
}
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
/*
2+
* Licensed to Elasticsearch B.V. under one or more contributor
3+
* license agreements. See the NOTICE file distributed with
4+
* this work for additional information regarding copyright
5+
* ownership. Elasticsearch B.V. licenses this file to you under
6+
* the Apache License, Version 2.0 (the "License"); you may
7+
* not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
import { RequestBase } from '@_types/Base'
21+
import { Id } from '@_types/common'
22+
23+
/**
24+
* Delete an async ES|QL query.
25+
* If the query is still running, it is cancelled.
26+
* Otherwise, the stored results are deleted.
27+
*
28+
* If the Elasticsearch security features are enabled, only the following users can use this API to delete a query:
29+
*
30+
* * The authenticated user that submitted the original query request
31+
* * Users with the `cancel_task` cluster privilege
32+
* @rest_spec_name esql.async_query_delete
33+
* @availability stack since=8.13.0 stability=stable visibility=public
34+
* @doc_id esql-async-query-delete
35+
* @ext_doc_id esql
36+
*/
37+
export interface Request extends RequestBase {
38+
path_parts: {
39+
/**
40+
* The unique identifier of the query.
41+
* A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.
42+
* A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`.
43+
*/
44+
id: Id
45+
}
46+
}
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/*
2+
* Licensed to Elasticsearch B.V. under one or more contributor
3+
* license agreements. See the NOTICE file distributed with
4+
* this work for additional information regarding copyright
5+
* ownership. Elasticsearch B.V. licenses this file to you under
6+
* the Apache License, Version 2.0 (the "License"); you may
7+
* not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
import { AcknowledgedResponseBase } from '@_types/Base'
21+
22+
export class Response {
23+
body: AcknowledgedResponseBase
24+
}

0 commit comments

Comments
 (0)