From eb5e4b3c42f5b85e8407072855d6a346ed4cbc6d Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
 <41898282+github-actions[bot]@users.noreply.github.com>
Date: Wed, 24 Apr 2024 18:53:43 +0200
Subject: [PATCH] Add esql version (#2512) (#2525)

Adds a `version` parameter to the ESQL `_query` request endpoint. We'll
do some work to give this a default value in the generated clients soon,
but for 8.14+ this'll be a required parameter.

---------

Co-authored-by: Alexander Spies <alexander.spies@elastic.co>
(cherry picked from commit 947a1eaa08c00dd3e4444e44df087f2a6fca1e31)

Co-authored-by: Nik Everett <nik9000@gmail.com>
---
 output/schema/schema.json                | 28 ++++++++++++++++++++-
 output/typescript/types.ts               |  3 +++
 specification/esql/_types/Version.ts     | 31 ++++++++++++++++++++++++
 specification/esql/query/QueryRequest.ts |  5 ++++
 4 files changed, 66 insertions(+), 1 deletion(-)
 create mode 100644 specification/esql/_types/Version.ts

diff --git a/output/schema/schema.json b/output/schema/schema.json
index 52998dfd04..5568d5298b 100644
--- a/output/schema/schema.json
+++ b/output/schema/schema.json
@@ -111925,6 +111925,20 @@
       },
       "specLocation": "eql/search/types.ts#L20-L32"
     },
+    {
+      "kind": "enum",
+      "members": [
+        {
+          "description": "Run against the first version of ES|QL.",
+          "name": "2024.04.01"
+        }
+      ],
+      "name": {
+        "name": "Version",
+        "namespace": "esql._types"
+      },
+      "specLocation": "esql/_types/Version.ts#L23-L31"
+    },
     {
       "attachedBehaviors": [
         "CommonQueryParameters"
@@ -111995,6 +112009,18 @@
                 "namespace": "_builtins"
               }
             }
+          },
+          {
+            "description": "The version of the ES|QL language in which the \"query\" field was written.",
+            "name": "version",
+            "required": true,
+            "type": {
+              "kind": "instance_of",
+              "type": {
+                "name": "Version",
+                "namespace": "esql._types"
+              }
+            }
           }
         ]
       },
@@ -112037,7 +112063,7 @@
           }
         }
       ],
-      "specLocation": "esql/query/QueryRequest.ts#L24-L64"
+      "specLocation": "esql/query/QueryRequest.ts#L25-L69"
     },
     {
       "body": {
diff --git a/output/typescript/types.ts b/output/typescript/types.ts
index 918f0ac27c..1f0671d453 100644
--- a/output/typescript/types.ts
+++ b/output/typescript/types.ts
@@ -9768,6 +9768,8 @@ export type EqlSearchResponse<TEvent = unknown> = EqlEqlSearchResponseBase<TEven
 
 export type EqlSearchResultPosition = 'tail' | 'head'
 
+export type EsqlVersion = '2024.04.01'
+
 export interface EsqlQueryRequest extends RequestBase {
   format?: string
   delimiter?: string
@@ -9777,6 +9779,7 @@ export interface EsqlQueryRequest extends RequestBase {
     locale?: string
     params?: ScalarValue[]
     query: string
+    version: EsqlVersion
   }
 }
 
diff --git a/specification/esql/_types/Version.ts b/specification/esql/_types/Version.ts
new file mode 100644
index 0000000000..22fe3280be
--- /dev/null
+++ b/specification/esql/_types/Version.ts
@@ -0,0 +1,31 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { integer } from '@_types/Numeric'
+import { Duration } from '@_types/Time'
+
+/**
+ * The version of the ES|QL language in which the "query" field was written.
+ */
+export enum Version {
+  /**
+   * Run against the first version of ES|QL.
+   */
+  '2024.04.01'
+}
diff --git a/specification/esql/query/QueryRequest.ts b/specification/esql/query/QueryRequest.ts
index 0dae2525cb..8bcb1c466b 100644
--- a/specification/esql/query/QueryRequest.ts
+++ b/specification/esql/query/QueryRequest.ts
@@ -20,6 +20,7 @@
 import { RequestBase } from '@_types/Base'
 import { QueryContainer } from '@_types/query_dsl/abstractions'
 import { ScalarValue } from '@_types/common'
+import { Version } from '@esql/_types/Version'
 
 /**
  * Executes an ES|QL request
@@ -60,5 +61,9 @@ export interface Request extends RequestBase {
      * The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results.
      */
     query: string
+    /**
+     * The version of the ES|QL language in which the "query" field was written.
+     */
+    version: Version
   }
 }