Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions output/openapi/elasticsearch-openapi.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion output/openapi/elasticsearch-serverless-openapi.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 13 additions & 11 deletions output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions specification/esql/_types/EsqlResult.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,17 @@ export class EsqlResult {
}

export class AsyncEsqlResult extends EsqlResult {
/**
* The ID of the async query, to be used in subsequent requests to check the status or retrieve results.
*
* Also available in the `X-Elasticsearch-Async-Id` HTTP header.
*/
id?: string
/**
* Indicates whether the async query is still running or has completed.
*
* Also available in the `X-Elasticsearch-Async-Is-Running` HTTP header.
*/
is_running: boolean
}

Expand Down
7 changes: 6 additions & 1 deletion specification/esql/async_query/AsyncQueryRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,12 @@ export interface Request extends RequestBase {
*/
drop_null_columns?: boolean
/**
* A short version of the Accept header, for example `json` or `yaml`.
* A short version of the Accept header, e.g. json, yaml.
*
* `csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.
*
* For async requests, nothing will be returned if the async query doesn't finish within the timeout.
* You should then take the query ID and status from the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers, respectively.
*/
format?: EsqlFormat
}
Expand Down
2 changes: 2 additions & 0 deletions specification/esql/query/QueryRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ export interface Request extends RequestBase {
query_parameters: {
/**
* A short version of the Accept header, e.g. json, yaml.
*
* `csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.
*/
format?: EsqlFormat
/**
Expand Down