forked from elastic/elasticsearch-specification
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update spec for ESQL async query stop (elastic#3643)
* Update spec for ESQL async query stop
- Loading branch information
Showing
7 changed files
with
261 additions
and
0 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
{ | ||
"esql.async_query_stop": { | ||
"documentation": { | ||
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-stop-api.html", | ||
"description": "Stops a previously submitted async query request given its ID and collects the results." | ||
}, | ||
"stability": "stable", | ||
"visibility": "public", | ||
"headers": { | ||
"accept": ["application/json"] | ||
}, | ||
"url": { | ||
"paths": [ | ||
{ | ||
"path": "/_query/async/{id}/stop", | ||
"methods": ["POST"], | ||
"parts": { | ||
"id": { | ||
"type": "string", | ||
"description": "The async query ID" | ||
} | ||
} | ||
} | ||
] | ||
} | ||
} | ||
} |
50 changes: 50 additions & 0 deletions
50
specification/esql/async_query_stop/AsyncQueryStopRequest.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
/* | ||
* Licensed to Elasticsearch B.V. under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch B.V. licenses this file to you under | ||
* the Apache License, Version 2.0 (the "License"); you may | ||
* not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
import { RequestBase } from '@_types/Base' | ||
import { Id } from '@_types/common' | ||
|
||
/** | ||
* Stop async ES|QL query. | ||
* | ||
* This API interrupts the query execution and returns the results so far. | ||
* If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it. | ||
* @rest_spec_name esql.async_query_stop | ||
* @availability stack since=8.18.0 stability=stable visibility=public | ||
* @doc_id esql-async-query-stop | ||
* @ext_doc_id esql | ||
*/ | ||
export interface Request extends RequestBase { | ||
path_parts: { | ||
/** | ||
* The unique identifier of the query. | ||
* A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time. | ||
* A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`. | ||
*/ | ||
id: Id | ||
} | ||
query_parameters: { | ||
/** | ||
* Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. | ||
* If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. | ||
* @server_default false | ||
*/ | ||
drop_null_columns?: boolean | ||
} | ||
} |
24 changes: 24 additions & 0 deletions
24
specification/esql/async_query_stop/AsyncQueryStopResponse.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
/* | ||
* Licensed to Elasticsearch B.V. under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch B.V. licenses this file to you under | ||
* the Apache License, Version 2.0 (the "License"); you may | ||
* not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
import { EsqlResult } from '@_types/Binary' | ||
|
||
export class Response { | ||
body: EsqlResult | ||
} |