diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 109b990e80..26c8134d7e 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -10586,7 +10586,7 @@ { "in": "query", "name": "format", - "description": "A short version of the Accept header, for example `json` or `yaml`.", + "description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.\n\nFor async requests, nothing will be returned if the async query doesn't finish within the timeout.\nThe query ID and running status are available in the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively.", "deprecated": false, "schema": { "$ref": "#/components/schemas/esql._types.EsqlFormat" @@ -10886,7 +10886,7 @@ { "in": "query", "name": "format", - "description": "A short version of the Accept header, e.g. json, yaml.", + "description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.", "deprecated": false, "schema": { "$ref": "#/components/schemas/esql._types.EsqlFormat" @@ -81860,9 +81860,11 @@ "type": "object", "properties": { "id": { + "description": "The ID of the async query, to be used in subsequent requests to check the status or retrieve results.\n\nAlso available in the `X-Elasticsearch-Async-Id` HTTP header.", "type": "string" }, "is_running": { + "description": "Indicates whether the async query is still running or has completed.\n\nAlso available in the `X-Elasticsearch-Async-Is-Running` HTTP header.", "type": "boolean" } }, diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 93b7a920e1..e7a88b0204 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -6118,7 +6118,7 @@ { "in": "query", "name": "format", - "description": "A short version of the Accept header, e.g. json, yaml.", + "description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.", "deprecated": false, "schema": { "$ref": "#/components/schemas/esql._types.EsqlFormat" diff --git a/output/schema/schema.json b/output/schema/schema.json index a65079b0a0..09ededf598 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -136253,6 +136253,7 @@ }, "properties": [ { + "description": "The ID of the async query, to be used in subsequent requests to check the status or retrieve results.\n\nAlso available in the `X-Elasticsearch-Async-Id` HTTP header.", "name": "id", "required": false, "type": { @@ -136264,6 +136265,7 @@ } }, { + "description": "Indicates whether the async query is still running or has completed.\n\nAlso available in the `X-Elasticsearch-Async-Is-Running` HTTP header.", "name": "is_running", "required": true, "type": { @@ -136275,7 +136277,7 @@ } } ], - "specLocation": "esql/_types/EsqlResult.ts#L45-L48" + "specLocation": "esql/_types/EsqlResult.ts#L45-L58" }, { "kind": "interface", @@ -136352,7 +136354,7 @@ } } ], - "specLocation": "esql/_types/EsqlResult.ts#L65-L71" + "specLocation": "esql/_types/EsqlResult.ts#L75-L81" }, { "kind": "interface", @@ -136450,7 +136452,7 @@ } } ], - "specLocation": "esql/_types/EsqlResult.ts#L55-L63" + "specLocation": "esql/_types/EsqlResult.ts#L65-L73" }, { "kind": "enum", @@ -136475,7 +136477,7 @@ "name": "EsqlClusterStatus", "namespace": "esql._types" }, - "specLocation": "esql/_types/EsqlResult.ts#L73-L79" + "specLocation": "esql/_types/EsqlResult.ts#L83-L89" }, { "kind": "interface", @@ -136507,7 +136509,7 @@ } } ], - "specLocation": "esql/_types/EsqlResult.ts#L50-L53" + "specLocation": "esql/_types/EsqlResult.ts#L60-L63" }, { "kind": "enum", @@ -136713,7 +136715,7 @@ } } ], - "specLocation": "esql/_types/EsqlResult.ts#L88-L93" + "specLocation": "esql/_types/EsqlResult.ts#L98-L103" }, { "kind": "interface", @@ -136767,7 +136769,7 @@ } } ], - "specLocation": "esql/_types/EsqlResult.ts#L81-L86" + "specLocation": "esql/_types/EsqlResult.ts#L91-L96" }, { "kind": "interface", @@ -137197,7 +137199,7 @@ } }, { - "description": "A short version of the Accept header, for example `json` or `yaml`.", + "description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.\n\nFor async requests, nothing will be returned if the async query doesn't finish within the timeout.\nThe query ID and running status are available in the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively.", "name": "format", "required": false, "type": { @@ -137209,7 +137211,7 @@ } } ], - "specLocation": "esql/async_query/AsyncQueryRequest.ts#L28-L125" + "specLocation": "esql/async_query/AsyncQueryRequest.ts#L28-L130" }, { "kind": "response", @@ -137720,7 +137722,7 @@ "path": [], "query": [ { - "description": "A short version of the Accept header, e.g. json, yaml.", + "description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.", "name": "format", "required": false, "type": { @@ -137757,7 +137759,7 @@ } } ], - "specLocation": "esql/query/QueryRequest.ts#L27-L105" + "specLocation": "esql/query/QueryRequest.ts#L27-L107" }, { "kind": "response", diff --git a/specification/esql/_types/EsqlResult.ts b/specification/esql/_types/EsqlResult.ts index 649e323d2b..b3d37ed3f9 100644 --- a/specification/esql/_types/EsqlResult.ts +++ b/specification/esql/_types/EsqlResult.ts @@ -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 } diff --git a/specification/esql/async_query/AsyncQueryRequest.ts b/specification/esql/async_query/AsyncQueryRequest.ts index 8331428c90..663e47aa36 100644 --- a/specification/esql/async_query/AsyncQueryRequest.ts +++ b/specification/esql/async_query/AsyncQueryRequest.ts @@ -50,7 +50,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. + * The query ID and running status are available in the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively. */ format?: EsqlFormat } diff --git a/specification/esql/query/QueryRequest.ts b/specification/esql/query/QueryRequest.ts index 4b2110b903..8c65565116 100644 --- a/specification/esql/query/QueryRequest.ts +++ b/specification/esql/query/QueryRequest.ts @@ -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 /**