Add esql version (#2512)

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 <[email protected]>
elastic · Apr 17, 2024 · 947a1ea · 947a1ea
1 parent 2e1e7c4
commit 947a1ea
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 1 deletion.
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/_types/Version.ts 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
@@ -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
   }
 }