Skip to content

Commit 3aca1d5

Browse files
committed
Add SQL API examples
1 parent ce298fc commit 3aca1d5

File tree

3 files changed

+11
-3
lines changed

3 files changed

+11
-3
lines changed

specification/_doc_ids/table.csv

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,6 @@ ccs-network-delays,https://www.elastic.co/guide/en/elasticsearch/reference/{bran
6767
clean-up-snapshot-repo,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-register-repository.html#snapshots-repository-cleanup
6868
clear-repositories-metering-archive-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-repositories-metering-archive-api.html
6969
clear-scroll-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-scroll-api.html
70-
clear-sql-cursor-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-sql-cursor-api.html
7170
cluster-allocation-explain,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-allocation-explain.html
7271
cluster-get-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-get-settings.html
7372
cluster-health,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-health.html
@@ -129,7 +128,6 @@ data-streams,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/da
129128
date-index-name-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-index-name-processor.html
130129
dcg,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_discounted_cumulative_gain_dcg
131130
defining-roles,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/defining-roles.html
132-
delete-async-sql-search-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-async-sql-search-api.html
133131
delete-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-enrich-policy-api.html
134132
delete-license,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-license.html
135133
delete-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-pipeline-api.html
@@ -477,6 +475,8 @@ reroute-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branc
477475
render-search-template-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/render-search-template-api.html
478476
reset-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/reset-transform.html
479477
restore-snapshot,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-restore-snapshot.html
478+
sql-delete-async-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-async-sql-search-api.html
479+
sql-clear-cursor-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-sql-cursor-api.html
480480
rollup-agg-limitations,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-agg-limitations.html
481481
rollup-delete-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-delete-job.html
482482
rollup-get-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-get-job.html

specification/sql/clear_cursor/ClearSqlCursorRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ import { RequestBase } from '@_types/Base'
2424
* @rest_spec_name sql.clear_cursor
2525
* @availability stack since=6.3.0 stability=stable
2626
* @availability serverless stability=stable visibility=public
27+
* @doc_id sql-clear-cursor-api
2728
*/
2829
export interface Request extends RequestBase {
2930
body: {

specification/sql/delete_async/SqlDeleteAsyncRequest.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,21 @@ import { Id } from '@_types/common'
2424
* Delete an async SQL search.
2525
* Delete an async SQL search or a stored synchronous SQL search.
2626
* If the search is still running, the API cancels it.
27+
*
28+
* If the Elasticsearch security features are enabled, only the following users can use this API to delete a search:
29+
*
30+
* * Users with the `cancel_task` cluster privilege.
31+
* * The user who first submitted the search.
2732
* @rest_spec_name sql.delete_async
2833
* @availability stack since=7.15.0 stability=stable
2934
* @availability serverless stability=stable visibility=public
35+
* @cluster_privileges cancel_task
36+
* @doc_id sql-delete-async-api
3037
*/
3138
export interface Request extends RequestBase {
3239
path_parts: {
3340
/**
34-
* Identifier for the search.
41+
* The identifier for the search.
3542
*/
3643
id: Id
3744
}

0 commit comments

Comments
 (0)