Synonyms API - GET Request

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

@@ -0,0 +1,42 @@
+{
+  "synonyms.get": {
+    "documentation": {
+      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonyms.html",
+      "description": "Retrieves a synonym set"
+    },
+    "stability": "experimental",
+    "visibility": "feature_flag",
+    "feature_flag": "es.synonyms_feature_flag_enabled",
+    "headers": {
+      "accept": [
+        "application/json"
+      ]
+    },
+    "url": {
+      "paths": [
+        {
+          "path": "/_synonyms/{synonyms_set}",
+          "methods": [
+            "GET"
+          ],
+          "parts": {
+            "synonyms_set": {
+              "type": "string",
+              "description": "The name of the synonyms set to be retrieved"
+            }
+          }
+        }
+      ]
+    },
+    "params": {
+      "from": {
+        "type": "int",
+        "description": "Starting offset (default: 0)"
+      },
+      "size": {
+        "type": "int",
+        "description": "specifies a max number of results to get"
+      }
+    }
+  }
+}

rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/synonyms/20_synonyms_get.yml

@@ -0,0 +1,80 @@
+setup:
+  - do:
+      synonyms.put:
+        synonyms_set: test-get-synonyms
+        body:
+          synonyms_set:
+            - synonyms: "hello, hi"
+              id: "test-id-1"
+            - synonyms: "bye => goodbye"
+              id: "test-id-2"
+            - synonyms: "test => check"
+              id: "test-id-3"
+
+---
+"Get synonyms set":
+  - skip:
+      version: " - 8.8.99"
+      reason: Introduced in 8.9.0
+  - do:
+      synonyms.get:
+        synonyms_set: test-get-synonyms
+
+  - match:
+      count: 3
+  - match:
+      synonyms_set:
+        - synonyms: "hello, hi"
+          id: "test-id-1"
+        - synonyms: "bye => goodbye"
+          id: "test-id-2"
+        - synonyms: "test => check"
+          id: "test-id-3"
+
+---
+"Get synonyms set - not found":
+  - skip:
+      version: " - 8.8.99"
+      reason: Introduced in 8.9.0
+  - do:
+      catch: missing
+      synonyms.get:
+        synonyms_set: unknown-synonym-set
+
+---
+"Pagination - size":
+  - skip:
+      version: " - 8.8.99"
+      reason: Introduced in 8.9.0
+  - do:
+      synonyms.get:
+        synonyms_set: test-get-synonyms
+        size: 2
+
+  - match:
+      count: 3
+  - match:
+      synonyms_set:
+        - synonyms: "hello, hi"
+          id: "test-id-1"
+        - synonyms: "bye => goodbye"
+          id: "test-id-2"
+
+---
+"Pagination - from":
+  - skip:
+      version: " - 8.8.99"
+      reason: Introduced in 8.9.0
+  - do:
+      synonyms.get:
+        synonyms_set: test-get-synonyms
+        from: 1
+
+  - match:
+      count: 3
+  - match:
+      synonyms_set:
+        - synonyms: "bye => goodbye"
+          id: "test-id-2"
+        - synonyms: "test => check"
+          id: "test-id-3"

server/src/main/java/org/elasticsearch/action/ActionModule.java

@@ -249,7 +249,9 @@
 import org.elasticsearch.action.support.AutoCreateIndex;
 import org.elasticsearch.action.support.DestructiveOperations;
 import org.elasticsearch.action.support.TransportAction;
+import org.elasticsearch.action.synonyms.GetSynonymsAction;
 import org.elasticsearch.action.synonyms.PutSynonymsAction;
+import org.elasticsearch.action.synonyms.TransportGetSynonymsAction;
 import org.elasticsearch.action.synonyms.TransportPutSynonymsAction;
 import org.elasticsearch.action.termvectors.MultiTermVectorsAction;
 import org.elasticsearch.action.termvectors.TermVectorsAction;
@@ -434,6 +436,7 @@
 import org.elasticsearch.rest.action.search.RestMultiSearchAction;
 import org.elasticsearch.rest.action.search.RestSearchAction;
 import org.elasticsearch.rest.action.search.RestSearchScrollAction;
+import org.elasticsearch.rest.action.synonyms.RestGetSynonymsAction;
 import org.elasticsearch.rest.action.synonyms.RestPutSynonymsAction;
 import org.elasticsearch.synonyms.SynonymsAPI;
 import org.elasticsearch.tasks.Task;
@@ -779,6 +782,7 @@ public <Request extends ActionRequest, Response extends ActionResponse> void reg
         // Synonyms
         if (SynonymsAPI.isEnabled()) {
             actions.register(PutSynonymsAction.INSTANCE, TransportPutSynonymsAction.class);
+            actions.register(GetSynonymsAction.INSTANCE, TransportGetSynonymsAction.class);
         }
 
         return unmodifiableMap(actions.getRegistry());
@@ -992,6 +996,7 @@ public void initRestHandlers(Supplier<DiscoveryNodes> nodesInCluster) {
         // Synonyms
         if (SynonymsAPI.isEnabled()) {
             registerHandler.accept(new RestPutSynonymsAction());
+            registerHandler.accept(new RestGetSynonymsAction());
         }
     }
 

server/src/main/java/org/elasticsearch/action/synonyms/GetSynonymsAction.java

@@ -0,0 +1,147 @@
+/*
+ * 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 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+package org.elasticsearch.action.synonyms;
+
+import org.elasticsearch.action.ActionRequest;
+import org.elasticsearch.action.ActionRequestValidationException;
+import org.elasticsearch.action.ActionResponse;
+import org.elasticsearch.action.ActionType;
+import org.elasticsearch.common.io.stream.StreamInput;
+import org.elasticsearch.common.io.stream.StreamOutput;
+import org.elasticsearch.synonyms.SynonymsManagementAPIService;
+import org.elasticsearch.synonyms.SynonymsSet;
+import org.elasticsearch.xcontent.ToXContentObject;
+import org.elasticsearch.xcontent.XContentBuilder;
+
+import java.io.IOException;
+import java.util.Objects;
+
+import static org.elasticsearch.action.ValidateActions.addValidationError;
+
+public class GetSynonymsAction extends ActionType<GetSynonymsAction.Response> {
+
+    public static final GetSynonymsAction INSTANCE = new GetSynonymsAction();
+    public static final String NAME = "cluster:admin/synonyms/get";
+
+    public GetSynonymsAction() {
+        super(NAME, Response::new);
+    }
+
+    public static class Request extends ActionRequest {
+        private final String SynonymsSetId;
+        private final int from;
+        private final int size;
+
+        public Request(StreamInput in) throws IOException {
+            super(in);
+            this.SynonymsSetId = in.readString();
+            this.from = in.readInt();
+            this.size = in.readInt();
+        }
+
+        public Request(String SynonymsSetId, int from, int size) {
+            Objects.requireNonNull(SynonymsSetId, "Synonym set ID cannot be null");
+            this.SynonymsSetId = SynonymsSetId;
+            this.from = from;
+            this.size = size;
+        }
+
+        @Override
+        public ActionRequestValidationException validate() {
+            ActionRequestValidationException validationException = null;
+            if (from < 0) {
+                validationException = addValidationError("from must be a positive integer", validationException);
+            }
+            if (size < 0) {
+                validationException = addValidationError("size must be a positive integer", validationException);
+            }
+            return validationException;
+        }
+
+        @Override
+        public void writeTo(StreamOutput out) throws IOException {
+            super.writeTo(out);
+            out.writeString(SynonymsSetId);
+            out.writeInt(from);
+            out.writeInt(size);
+        }
+
+        public String synonymsSetId() {
+            return SynonymsSetId;
+        }
+
+        public int from() {
+            return from;
+        }
+
+        public int size() {
+            return size;
+        }
+
+        @Override
+        public boolean equals(Object o) {
+            if (this == o) return true;
+            if (o == null || getClass() != o.getClass()) return false;
+            Request request = (Request) o;
+            return from == request.from && size == request.size && Objects.equals(SynonymsSetId, request.SynonymsSetId);
+        }
+
+        @Override
+        public int hashCode() {
+            return Objects.hash(SynonymsSetId, from, size);
+        }
+    }
+
+    public static class Response extends ActionResponse implements ToXContentObject {
+
+        private final SynonymsManagementAPIService.SynonymsSetResult synonymsSetResults;
+
+        public Response(StreamInput in) throws IOException {
+            super(in);
+            this.synonymsSetResults = new SynonymsManagementAPIService.SynonymsSetResult(in.readLong(), new SynonymsSet(in));
+        }
+
+        public Response(SynonymsManagementAPIService.SynonymsSetResult synonymsSetResult) {
+            super();
+            Objects.requireNonNull(synonymsSetResult, "Synonyms set result must not be null");
+            this.synonymsSetResults = synonymsSetResult;
+        }
+
+        @Override
+        public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
+            builder.startObject();
+            {
+                builder.field("count", synonymsSetResults.totalSynonymRules());
+                synonymsSetResults.synonymsSet().toXContent(builder, params);
+            }
+            builder.endObject();
+
+            return builder;
+        }
+
+        @Override
+        public void writeTo(StreamOutput out) throws IOException {
+            out.writeLong(synonymsSetResults.totalSynonymRules());
+            synonymsSetResults.synonymsSet().writeTo(out);
+        }
+
+        @Override
+        public boolean equals(Object o) {
+            if (this == o) return true;
+            if (o == null || getClass() != o.getClass()) return false;
+            Response response = (Response) o;
+            return Objects.equals(this.synonymsSetResults, response.synonymsSetResults);
+        }
+
+        @Override
+        public int hashCode() {
+            return Objects.hash(synonymsSetResults);
+        }
+    }
+}

server/src/main/java/org/elasticsearch/action/synonyms/PutSynonymsAction.java

@@ -20,6 +20,7 @@
 import org.elasticsearch.common.xcontent.StatusToXContentObject;
 import org.elasticsearch.common.xcontent.XContentHelper;
 import org.elasticsearch.rest.RestStatus;
+import org.elasticsearch.synonyms.SynonymsManagementAPIService;
 import org.elasticsearch.synonyms.SynonymsSet;
 import org.elasticsearch.xcontent.ToXContent;
 import org.elasticsearch.xcontent.XContentBuilder;
@@ -103,14 +104,14 @@ public int hashCode() {
 
     public static class Response extends ActionResponse implements StatusToXContentObject {
 
-        private final Result result;
+        private final SynonymsManagementAPIService.UpdateSynonymsResult result;
 
         public Response(StreamInput in) throws IOException {
             super(in);
-            this.result = in.readEnum((Result.class));
+            this.result = in.readEnum((SynonymsManagementAPIService.UpdateSynonymsResult.class));
         }
 
-        public Response(Result result) {
+        public Response(SynonymsManagementAPIService.UpdateSynonymsResult result) {
             super();
             Objects.requireNonNull(result, "Result must not be null");
             this.result = result;
@@ -151,9 +152,5 @@ public int hashCode() {
             return Objects.hash(result);
         }
 
-        public enum Result {
-            CREATED,
-            UPDATED
-        }
     }
 }

server/src/main/java/org/elasticsearch/action/synonyms/TransportGetSynonymsAction.java

@@ -0,0 +1,40 @@
+/*
+ * 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 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+package org.elasticsearch.action.synonyms;
+
+import org.elasticsearch.action.ActionListener;
+import org.elasticsearch.action.support.ActionFilters;
+import org.elasticsearch.action.support.HandledTransportAction;
+import org.elasticsearch.client.internal.Client;
+import org.elasticsearch.common.inject.Inject;
+import org.elasticsearch.synonyms.SynonymsManagementAPIService;
+import org.elasticsearch.tasks.Task;
+import org.elasticsearch.transport.TransportService;
+
+public class TransportGetSynonymsAction extends HandledTransportAction<GetSynonymsAction.Request, GetSynonymsAction.Response> {
+
+    private final SynonymsManagementAPIService synonymsManagementAPIService;
+
+    @Inject
+    public TransportGetSynonymsAction(TransportService transportService, ActionFilters actionFilters, Client client) {
+        super(GetSynonymsAction.NAME, transportService, actionFilters, GetSynonymsAction.Request::new);
+
+        this.synonymsManagementAPIService = new SynonymsManagementAPIService(client);
+    }
+
+    @Override
+    protected void doExecute(Task task, GetSynonymsAction.Request request, ActionListener<GetSynonymsAction.Response> listener) {
+        synonymsManagementAPIService.getSynonymsSet(
+            request.synonymsSetId(),
+            request.from(),
+            request.size(),
+            listener.map(GetSynonymsAction.Response::new)
+        );
+    }
+}

server/src/main/java/org/elasticsearch/action/synonyms/TransportPutSynonymsAction.java

@@ -30,6 +30,10 @@ public TransportPutSynonymsAction(TransportService transportService, ActionFilte
 
     @Override
     protected void doExecute(Task task, PutSynonymsAction.Request request, ActionListener<PutSynonymsAction.Response> listener) {
-        synonymsManagementAPIService.putSynonymsset(request.synonymsSetId(), request.synonymsset(), listener);
+        synonymsManagementAPIService.putSynonymsSet(
+            request.synonymsSetId(),
+            request.synonymsset(),
+            listener.map(PutSynonymsAction.Response::new)
+        );
     }
 }