Add Query Rules API (#2207)

Author: kderusso

output/schema/schema.json

@@ -0,0 +1,27 @@
+{
+  "query_ruleset.delete": {
+    "documentation": {
+      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-ruleset.html",
+      "description": "Deletes a query ruleset."
+    },
+    "stability": "experimental",
+    "visibility": "public",
+    "headers": {
+      "accept": ["application/json"]
+    },
+    "url": {
+      "paths": [
+        {
+          "path": "/_query_rules/{ruleset_id}",
+          "methods": ["DELETE"],
+          "parts": {
+            "ruleset_id": {
+              "type": "string",
+              "description": "The unique identifier of the query ruleset to delete"
+            }
+          }
+        }
+      ]
+    }
+  }
+}

output/schema/validation-errors.json

@@ -0,0 +1,27 @@
+{
+  "query_ruleset.get": {
+    "documentation": {
+      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-ruleset.html",
+      "description": "Returns the details about a query ruleset."
+    },
+    "stability": "experimental",
+    "visibility": "public",
+    "headers": {
+      "accept": ["application/json"]
+    },
+    "url": {
+      "paths": [
+        {
+          "path": "/_query_rules/{ruleset_id}",
+          "methods": ["GET"],
+          "parts": {
+            "ruleset_id": {
+              "type": "string",
+              "description": "The unique identifier of the query ruleset"
+            }
+          }
+        }
+      ]
+    }
+  }
+}

output/typescript/types.ts

@@ -0,0 +1,33 @@
+{
+  "query_ruleset.list": {
+    "documentation": {
+      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-query-rulesets.html",
+      "description": "Lists query rulesets."
+    },
+    "stability": "experimental",
+    "visibility": "public",
+    "headers": {
+      "accept": ["application/json"]
+    },
+    "url": {
+      "paths": [
+        {
+          "path": "/_query_rules",
+          "methods": ["GET"]
+        }
+      ]
+    },
+    "params": {
+      "from": {
+        "type": "int",
+        "default": 0,
+        "description": "Starting offset (default: 0)"
+      },
+      "size": {
+        "type": "int",
+        "default": 100,
+        "description": "specifies a max number of results to get (default: 100)"
+      }
+    }
+  }
+}

specification/_json_spec/query_ruleset.delete.json

@@ -0,0 +1,32 @@
+{
+  "query_ruleset.put": {
+    "documentation": {
+      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-ruleset.html",
+      "description": "Creates or updates a query ruleset."
+    },
+    "stability": "experimental",
+    "visibility": "public",
+    "headers": {
+      "accept": ["application/json"],
+      "content_type": ["application/json"]
+    },
+    "url": {
+      "paths": [
+        {
+          "path": "/_query_rules/{ruleset_id}",
+          "methods": ["PUT"],
+          "parts": {
+            "ruleset_id": {
+              "type": "string",
+              "description": "The unique identifier of the ruleset to be created or updated."
+            }
+          }
+        }
+      ]
+    },
+    "body": {
+      "description": "The query ruleset configuration, including `rules`",
+      "required": true
+    }
+  }
+}

specification/_json_spec/query_ruleset.get.json

@@ -75,6 +75,7 @@ import {
   PercolateQuery,
   PinnedQuery,
   RankFeatureQuery,
+  RuleQuery,
   ScriptQuery,
   ScriptScoreQuery,
   ShapeQuery
@@ -188,6 +189,7 @@ export class QueryContainer {
   range?: SingleKeyDictionary<Field, RangeQuery>
   rank_feature?: RankFeatureQuery
   regexp?: SingleKeyDictionary<Field, RegexpQuery>
+  rule_query?: RuleQuery
   script?: ScriptQuery
   script_score?: ScriptScoreQuery
   shape?: ShapeQuery

specification/_json_spec/query_ruleset.list.json

@@ -201,3 +201,9 @@ export class ShapeFieldQuery {
   relation?: GeoShapeRelation
   shape?: GeoShape
 }
+
+export class RuleQuery extends QueryBase {
+  organic: QueryContainer
+  ruleset_id: Id
+  match_criteria: UserDefinedValue
+}

specification/_json_spec/query_ruleset.put.json

@@ -0,0 +1,70 @@
+/*
+ * 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 { Id, IndexName, Name } from '@_types/common'
+import { EpochTime, UnitMillis } from '@_types/Time'
+import { InlineScript } from '@_types/Scripting'
+import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
+import { PinnedDoc } from '../../_types/query_dsl/specialized'
+
+export class QueryRuleset {
+  /**
+   * Query Ruleset unique identifier
+   */
+  ruleset_id: Id
+  /**
+   * Rules associated with the query ruleset
+   */
+  rules: QueryRule[]
+}
+
+export class QueryRule {
+  rule_id: Id
+  type: QueryRuleType
+  criteria: QueryRuleCriteria[]
+  actions: QueryRuleActions
+}
+
+export enum QueryRuleType {
+  pinned
+}
+
+export class QueryRuleCriteria {
+  type: QueryRuleCriteriaType
+  metadata: string
+  values?: UserDefinedValue[]
+}
+
+export enum QueryRuleCriteriaType {
+  global,
+  exact,
+  exact_fuzzy,
+  prefix,
+  suffix,
+  contains,
+  lt,
+  lte,
+  gt,
+  gte
+}
+
+export class QueryRuleActions {
+  ids?: Id[]
+  docs?: PinnedDoc[]
+}

specification/_types/query_dsl/abstractions.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 { RequestBase } from '@_types/Base'
+import { Id } from '@_types/common'
+
+/**
+ * Deletes a query ruleset.
+ * @rest_spec_name query_ruleset.delete
+ * @availability stack since=8.10.0 stability=experimental
+ * @availability serverless stability=experimental visibility=public
+ */
+interface Request extends RequestBase {
+  path_parts: {
+    /**
+     * The unique identifier of the query ruleset to delete
+     */
+    ruleset_id: Id
+  }
+}

specification/_types/query_dsl/specialized.ts

@@ -0,0 +1,24 @@
+/*
+ * 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 { AcknowledgedResponseBase } from '@_types/Base'
+
+export class Response {
+  body: AcknowledgedResponseBase
+}