Skip to content

Commit b4d86f7

Browse files
committed
Update async docs around headers
1 parent 5a1a002 commit b4d86f7

File tree

4 files changed

+25
-10
lines changed

4 files changed

+25
-10
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 3 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

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

specification/esql/_types/EsqlResult.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,17 @@ export class EsqlResult {
4343
}
4444

4545
export class AsyncEsqlResult extends EsqlResult {
46+
/**
47+
* The ID of the async query, to be used in subsequent requests to check the status or retrieve results.
48+
*
49+
* Also available in the `X-Elasticsearch-Async-Id` HTTP header.
50+
*/
4651
id?: string
52+
/**
53+
* Indicates whether the async query is still running or has completed.
54+
*
55+
* Also available in the `X-Elasticsearch-Async-Is-Running` HTTP header.
56+
*/
4757
is_running: boolean
4858
}
4959

specification/esql/async_query/AsyncQueryRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ export interface Request extends RequestBase {
6363
* `csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.
6464
*
6565
* For async requests, nothing will be returned if the async query doesn't finish within the timeout.
66+
* You should then take the query ID and status from the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers, respectively.
6667
*/
6768
format?: EsqlFormat
6869
}

0 commit comments

Comments
 (0)