Skip to content

Commit 17a6964

Browse files
authored
[DOCS] Add SQL operation summaries (#3221)
1 parent 8c4e5ee commit 17a6964

File tree

9 files changed

+61
-37
lines changed

9 files changed

+61
-37
lines changed

output/openapi/elasticsearch-openapi.json

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

output/openapi/elasticsearch-serverless-openapi.json

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

specification/sql/clear_cursor/ClearSqlCursorRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
import { RequestBase } from '@_types/Base'
2121

2222
/**
23+
* Clear an SQL search cursor.
2324
* @rest_spec_name sql.clear_cursor
2425
* @availability stack since=6.3.0 stability=stable
2526
* @availability serverless stability=stable visibility=public

specification/sql/delete_async/SqlDeleteAsyncRequest.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ import { RequestBase } from '@_types/Base'
2121
import { Id } from '@_types/common'
2222

2323
/**
24+
* Delete an async SQL search.
25+
* Delete an async SQL search or a stored synchronous SQL search.
26+
* If the search is still running, the API cancels it.
2427
* @rest_spec_name sql.delete_async
2528
* @availability stack since=7.15.0 stability=stable
2629
* @availability serverless stability=stable visibility=public

specification/sql/get_async/SqlGetAsyncRequest.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ import { Id } from '@_types/common'
2222
import { Duration } from '@_types/Time'
2323

2424
/**
25+
* Get async SQL search results.
26+
* Get the current status and available results for an async SQL search or stored synchronous SQL search.
2527
* @rest_spec_name sql.get_async
2628
* @availability stack since=7.15.0 stability=stable
2729
* @availability serverless stability=stable visibility=public

specification/sql/get_async_status/SqlGetAsyncStatusRequest.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ import { RequestBase } from '@_types/Base'
2121
import { Id } from '@_types/common'
2222

2323
/**
24+
* Get the async SQL search status.
25+
* Get the current status of an async SQL search or a stored synchronous SQL search.
2426
* @rest_spec_name sql.get_async_status
2527
* @availability stack since=7.15.0 stability=stable
2628
* @availability serverless stability=stable visibility=public

specification/sql/query/QuerySqlRequest.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ import { QueryContainer } from '@_types/query_dsl/abstractions'
2626
import { Duration, TimeZone } from '@_types/Time'
2727

2828
/**
29+
* Get SQL search results.
30+
* Run an SQL request.
2931
* @rest_spec_name sql.query
3032
* @availability stack since=6.3.0 stability=stable
3133
* @availability serverless stability=stable visibility=public

specification/sql/translate/TranslateSqlRequest.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ import { QueryContainer } from '@_types/query_dsl/abstractions'
2323
import { TimeZone } from '@_types/Time'
2424

2525
/**
26+
* Translate SQL into Elasticsearch queries.
27+
* Translate an SQL search into a search API request containing Query DSL.
2628
* @rest_spec_name sql.translate
2729
* @availability stack since=6.3.0 stability=stable
2830
* @availability serverless stability=stable visibility=public

0 commit comments

Comments
 (0)