Use an enum for ES|QL format parameter (#2873)

elastic · Sep 9, 2024 · 7f78698 · 7f78698
1 parent 3dc9de9
commit 7f78698
Show file tree

Hide file tree

Showing 6 changed files with 115 additions and 8 deletions.
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/output/typescript/types.ts b/output/typescript/types.ts
diff --git a/specification/esql/query/QueryRequest.ts b/specification/esql/query/QueryRequest.ts
@@ -35,7 +35,7 @@ export interface Request extends RequestBase {
     /**
      * A short version of the Accept header, e.g. json, yaml.
      */
-    format?: string
+    format?: EsqlFormat
     /**
      * The character to use between values within a CSV row. Only valid for the CSV format.
      */
@@ -87,3 +87,14 @@ export interface Request extends RequestBase {
     tables?: Dictionary<string, Dictionary<string, TableValuesContainer>>
   }
 }
+
+export enum EsqlFormat {
+  csv,
+  json,
+  tsv,
+  txt,
+  yaml,
+  cbor,
+  smile,
+  arrow
+}