Add API calls to Get, Delete Query Rulesets (#96849)

Author: kderusso

rest-api-spec/src/main/resources/rest-api-spec/api/query_ruleset.delete.json

@@ -0,0 +1,32 @@
+{
+  "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": "feature_flag",
+    "feature_flag": "es.query_rules_feature_flag_enabled",
+    "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"
+            }
+          }
+        }
+      ]
+    }
+  }
+}

rest-api-spec/src/main/resources/rest-api-spec/api/query_ruleset.get.json

@@ -0,0 +1,32 @@
+{
+  "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": "feature_flag",
+    "feature_flag": "es.query_rules_feature_flag_enabled",
+    "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"
+            }
+          }
+        }
+      ]
+    }
+  }
+}

rest-api-spec/src/main/resources/rest-api-spec/api/search_application.delete.json

@@ -1,7 +1,7 @@
 {
   "search_application.delete": {
     "documentation": {
-      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html",
+      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html",
       "description": "Deletes a search application."
     },
     "stability": "experimental",

x-pack/plugin/ent-search/qa/rest/src/yamlRestTest/resources/rest-api-spec/test/entsearch/200_query_ruleset_put.yml

@@ -1,4 +1,8 @@
 
+setup:
+  - skip:
+      version: " - 8.8.99"
+      reason: Introduced in 8.9.0
 
 ---
 'Create Query Ruleset':
@@ -33,6 +37,35 @@
 
   - match: { result: 'created' }
 
+  - do:
+      query_ruleset.get:
+        ruleset_id: test-ruleset
+  - match: { ruleset_id: test-ruleset }
+  - match:
+      rules:
+        - rule_id: query-rule-id1
+          type: pinned
+          criteria:
+            - type: exact
+              metadata: query_string
+              value: elastic
+          actions:
+            ids:
+              - 'id1'
+              - 'id2'
+        - rule_id: query-rule-id2
+          type: pinned
+          criteria:
+            - type: exact
+              metadata: query_string
+              value: kibana
+          actions:
+            docs:
+              - '_index': 'test-index1'
+                '_id': 'id3'
+              - '_index': 'test-index2'
+                '_id': 'id4'
+
 ---
 'Create Query Ruleset - Resource already exists':
   - do:

x-pack/plugin/ent-search/qa/rest/src/yamlRestTest/resources/rest-api-spec/test/entsearch/250_query_ruleset_delete.yml

@@ -0,0 +1,40 @@
+setup:
+  - skip:
+      version: " - 8.8.99"
+      reason: Introduced in 8.9.0
+  - do:
+      query_ruleset.put:
+        ruleset_id: test-query-ruleset-to-delete
+        body:
+          ruleset_id: test-query-ruleset-to-delete
+          rules:
+            - rule_id: query-rule-id1
+              type: pinned
+              criteria:
+                - type: exact
+                  metadata: query_string
+                  value: elastic
+              actions:
+                ids:
+                  - 'id1'
+                  - 'id2'
+
+---
+"Delete Query Ruleset":
+  - do:
+      query_ruleset.delete:
+        ruleset_id: test-query-ruleset-to-delete
+
+  - match: { acknowledged: true }
+
+  - do:
+      catch: "missing"
+      query_ruleset.get:
+        ruleset_id: test-query-ruleset-to-delete
+
+---
+"Delete Query Ruleset - Ruleset does not exist":
+  - do:
+      catch: "missing"
+      query_ruleset.delete:
+        ruleset_id: test-nonexistent-query-ruleset

x-pack/plugin/ent-search/src/main/java/module-info.java

@@ -30,5 +30,6 @@
 
     exports org.elasticsearch.xpack.application.search;
     exports org.elasticsearch.xpack.application.search.action;
+    exports org.elasticsearch.xpack.application.rules;
     exports org.elasticsearch.xpack.application.rules.action;
 }

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/EnterpriseSearch.java

@@ -53,8 +53,14 @@
 import org.elasticsearch.xpack.application.analytics.action.TransportPutAnalyticsCollectionAction;
 import org.elasticsearch.xpack.application.analytics.ingest.AnalyticsEventIngestConfig;
 import org.elasticsearch.xpack.application.rules.QueryRulesIndexService;
+import org.elasticsearch.xpack.application.rules.action.DeleteQueryRulesetAction;
+import org.elasticsearch.xpack.application.rules.action.GetQueryRulesetAction;
 import org.elasticsearch.xpack.application.rules.action.PutQueryRulesetAction;
+import org.elasticsearch.xpack.application.rules.action.RestDeleteQueryRulesetAction;
+import org.elasticsearch.xpack.application.rules.action.RestGetQueryRulesetAction;
 import org.elasticsearch.xpack.application.rules.action.RestPutQueryRulesetAction;
+import org.elasticsearch.xpack.application.rules.action.TransportDeleteQueryRulesetAction;
+import org.elasticsearch.xpack.application.rules.action.TransportGetQueryRulesetAction;
 import org.elasticsearch.xpack.application.rules.action.TransportPutQueryRulesetAction;
 import org.elasticsearch.xpack.application.search.SearchApplicationIndexService;
 import org.elasticsearch.xpack.application.search.action.DeleteSearchApplicationAction;
@@ -139,6 +145,8 @@ protected XPackLicenseState getLicenseState() {
         );
 
         if (QUERY_RULES_FEATURE_FLAG.isEnabled()) {
+            actionHandlers.add(new ActionHandler<>(DeleteQueryRulesetAction.INSTANCE, TransportDeleteQueryRulesetAction.class));
+            actionHandlers.add(new ActionHandler<>(GetQueryRulesetAction.INSTANCE, TransportGetQueryRulesetAction.class));
             actionHandlers.add(new ActionHandler<>(PutQueryRulesetAction.INSTANCE, TransportPutQueryRulesetAction.class));
         }
 
@@ -176,6 +184,8 @@ public List<RestHandler> getRestHandlers(
         );
 
         if (QUERY_RULES_FEATURE_FLAG.isEnabled()) {
+            restHandlers.add(new RestDeleteQueryRulesetAction(getLicenseState()));
+            restHandlers.add(new RestGetQueryRulesetAction(getLicenseState()));
             restHandlers.add(new RestPutQueryRulesetAction(getLicenseState()));
         }
 

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/rules/QueryRule.java

@@ -24,6 +24,7 @@
 
 import java.io.IOException;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 import java.util.Objects;
 
@@ -57,6 +58,11 @@ public static QueryRuleType queryRuleType(String type) {
             }
             throw new IllegalArgumentException("Unknown QueryRuleType: " + type);
         }
+
+        @Override
+        public String toString() {
+            return name().toLowerCase(Locale.ROOT);
+        }
     }
 
     /**

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/rules/QueryRuleCriteria.java

@@ -23,6 +23,7 @@
 import org.elasticsearch.xcontent.XContentType;
 
 import java.io.IOException;
+import java.util.Locale;
 import java.util.Objects;
 
 import static org.elasticsearch.xcontent.ConstructingObjectParser.constructorArg;
@@ -43,6 +44,11 @@ public static CriteriaType criteriaType(String criteriaType) {
             }
             throw new IllegalArgumentException("Unknown CriteriaType: " + criteriaType);
         }
+
+        @Override
+        public String toString() {
+            return name().toLowerCase(Locale.ROOT);
+        }
     }
 
     /**

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/rules/action/DeleteQueryRulesetAction.java

@@ -0,0 +1,79 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+package org.elasticsearch.xpack.application.rules.action;
+
+import org.elasticsearch.action.ActionRequest;
+import org.elasticsearch.action.ActionRequestValidationException;
+import org.elasticsearch.action.ActionType;
+import org.elasticsearch.action.support.master.AcknowledgedResponse;
+import org.elasticsearch.common.Strings;
+import org.elasticsearch.common.io.stream.StreamInput;
+import org.elasticsearch.common.io.stream.StreamOutput;
+
+import java.io.IOException;
+import java.util.Objects;
+
+import static org.elasticsearch.action.ValidateActions.addValidationError;
+
+public class DeleteQueryRulesetAction extends ActionType<AcknowledgedResponse> {
+
+    public static final DeleteQueryRulesetAction INSTANCE = new DeleteQueryRulesetAction();
+    public static final String NAME = "cluster:admin/xpack/query_rules/delete";
+
+    private DeleteQueryRulesetAction() {
+        super(NAME, AcknowledgedResponse::readFrom);
+    }
+
+    public static class Request extends ActionRequest {
+        private final String rulesetId;
+
+        public Request(StreamInput in) throws IOException {
+            super(in);
+            this.rulesetId = in.readString();
+        }
+
+        public Request(String rulesetId) {
+            this.rulesetId = rulesetId;
+        }
+
+        @Override
+        public ActionRequestValidationException validate() {
+            ActionRequestValidationException validationException = null;
+
+            if (Strings.isNullOrEmpty(rulesetId)) {
+                validationException = addValidationError("ruleset_id missing", validationException);
+            }
+
+            return validationException;
+        }
+
+        public String rulesetId() {
+            return rulesetId;
+        }
+
+        @Override
+        public void writeTo(StreamOutput out) throws IOException {
+            super.writeTo(out);
+            out.writeString(rulesetId);
+        }
+
+        @Override
+        public boolean equals(Object o) {
+            if (this == o) return true;
+            if (o == null || getClass() != o.getClass()) return false;
+            Request that = (Request) o;
+            return Objects.equals(rulesetId, that.rulesetId);
+        }
+
+        @Override
+        public int hashCode() {
+            return Objects.hash(rulesetId);
+        }
+    }
+
+}