From 57869fff3505ad3c33398cf8ba4a8c6e24156537 Mon Sep 17 00:00:00 2001
From: Owais Kazi <owaiskazi19@gmail.com>
Date: Wed, 1 Nov 2023 15:30:52 -0700
Subject: [PATCH] Added javadoc

Signed-off-by: Owais Kazi <owaiskazi19@gmail.com>
---
 .../flowframework/FlowFrameworkPlugin.java       |  7 ++++++-
 .../rest/AbstractSearchWorkflowAction.java       | 16 ++++++++++++++++
 .../rest/RestCreateWorkflowAction.java           |  2 +-
 .../rest/RestSearchWorkflowAction.java           |  6 ++++++
 .../transport/CreateWorkflowAction.java          |  2 +-
 .../transport/SearchWorkflowAction.java          |  3 +++
 .../transport/SearchWorkflowTransportAction.java |  9 +++++++++
 .../flowframework/util/RestHandlerUtils.java     | 10 ++++++++++
 .../flowframework/FlowFrameworkPluginTests.java  |  4 ++--
 9 files changed, 54 insertions(+), 5 deletions(-)

diff --git a/src/main/java/org/opensearch/flowframework/FlowFrameworkPlugin.java b/src/main/java/org/opensearch/flowframework/FlowFrameworkPlugin.java
index 1f88ae29c..dac37ea98 100644
--- a/src/main/java/org/opensearch/flowframework/FlowFrameworkPlugin.java
+++ b/src/main/java/org/opensearch/flowframework/FlowFrameworkPlugin.java
@@ -28,7 +28,12 @@
 import org.opensearch.flowframework.rest.RestCreateWorkflowAction;
 import org.opensearch.flowframework.rest.RestProvisionWorkflowAction;
 import org.opensearch.flowframework.rest.RestSearchWorkflowAction;
-import org.opensearch.flowframework.transport.*;
+import org.opensearch.flowframework.transport.CreateWorkflowAction;
+import org.opensearch.flowframework.transport.CreateWorkflowTransportAction;
+import org.opensearch.flowframework.transport.ProvisionWorkflowAction;
+import org.opensearch.flowframework.transport.ProvisionWorkflowTransportAction;
+import org.opensearch.flowframework.transport.SearchWorkflowAction;
+import org.opensearch.flowframework.transport.SearchWorkflowTransportAction;
 import org.opensearch.flowframework.workflow.WorkflowProcessSorter;
 import org.opensearch.flowframework.workflow.WorkflowStepFactory;
 import org.opensearch.ml.client.MachineLearningNodeClient;
diff --git a/src/main/java/org/opensearch/flowframework/rest/AbstractSearchWorkflowAction.java b/src/main/java/org/opensearch/flowframework/rest/AbstractSearchWorkflowAction.java
index 53675462a..bc7fc9d62 100644
--- a/src/main/java/org/opensearch/flowframework/rest/AbstractSearchWorkflowAction.java
+++ b/src/main/java/org/opensearch/flowframework/rest/AbstractSearchWorkflowAction.java
@@ -29,6 +29,9 @@
 import static org.opensearch.core.xcontent.ToXContent.EMPTY_PARAMS;
 import static org.opensearch.flowframework.util.RestHandlerUtils.getSourceContext;
 
+/**
+ * Abstract class to handle search request.
+ */
 public class AbstractSearchWorkflowAction<T extends ToXContentObject> extends BaseRestHandler {
 
     protected final List<String> urlPaths;
@@ -36,6 +39,13 @@ public class AbstractSearchWorkflowAction<T extends ToXContentObject> extends Ba
     protected final Class<T> clazz;
     protected final ActionType<SearchResponse> actionType;
 
+    /**
+     * Instantiates a new AbstractSearchWorkflowAction
+     * @param urlPaths urlPaths to create routes
+     * @param index index the search should be done on
+     * @param clazz model class
+     * @param actionType from which action abstract class is called
+     */
     public AbstractSearchWorkflowAction(List<String> urlPaths, String index, Class<T> clazz, ActionType<SearchResponse> actionType) {
         this.urlPaths = urlPaths;
         this.index = index;
@@ -58,6 +68,12 @@ protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient cli
         return channel -> client.execute(actionType, searchRequest, search(channel));
     }
 
+    /**
+     * Builds the action response for the Search Request
+     *
+     * @param channel the REST channel
+     * @return the action response
+     */
     protected RestResponseListener<SearchResponse> search(RestChannel channel) {
         return new RestResponseListener<SearchResponse>(channel) {
             @Override
diff --git a/src/main/java/org/opensearch/flowframework/rest/RestCreateWorkflowAction.java b/src/main/java/org/opensearch/flowframework/rest/RestCreateWorkflowAction.java
index b5400e247..90c0e5d12 100644
--- a/src/main/java/org/opensearch/flowframework/rest/RestCreateWorkflowAction.java
+++ b/src/main/java/org/opensearch/flowframework/rest/RestCreateWorkflowAction.java
@@ -41,7 +41,7 @@ public class RestCreateWorkflowAction extends BaseRestHandler {
     private static final String CREATE_WORKFLOW_ACTION = "create_workflow_action";
 
     /**
-     * Intantiates a new RestCreateWorkflowAction
+     * Instantiates a new RestCreateWorkflowAction
      */
     public RestCreateWorkflowAction() {}
 
diff --git a/src/main/java/org/opensearch/flowframework/rest/RestSearchWorkflowAction.java b/src/main/java/org/opensearch/flowframework/rest/RestSearchWorkflowAction.java
index 876c38451..98455db10 100644
--- a/src/main/java/org/opensearch/flowframework/rest/RestSearchWorkflowAction.java
+++ b/src/main/java/org/opensearch/flowframework/rest/RestSearchWorkflowAction.java
@@ -15,11 +15,17 @@
 import static org.opensearch.flowframework.common.CommonValue.GLOBAL_CONTEXT_INDEX;
 import static org.opensearch.flowframework.common.CommonValue.WORKFLOW_URI;
 
+/**
+ * Rest Action to facilitate requests to search workflows
+ */
 public class RestSearchWorkflowAction extends AbstractSearchWorkflowAction<Template> {
 
     private static final String SEARCH_WORKFLOW_ACTION = "search_workflow_action";
     private static final String SEARCH_WORKFLOW_PATH = WORKFLOW_URI + "/_search";
 
+    /**
+     * Instantiates a new RestCreateWorkflowAction
+     */
     public RestSearchWorkflowAction() {
         super(ImmutableList.of(SEARCH_WORKFLOW_PATH), GLOBAL_CONTEXT_INDEX, Template.class, SearchWorkflowAction.INSTANCE);
     }
diff --git a/src/main/java/org/opensearch/flowframework/transport/CreateWorkflowAction.java b/src/main/java/org/opensearch/flowframework/transport/CreateWorkflowAction.java
index 0f49c826f..ff626ffd0 100644
--- a/src/main/java/org/opensearch/flowframework/transport/CreateWorkflowAction.java
+++ b/src/main/java/org/opensearch/flowframework/transport/CreateWorkflowAction.java
@@ -13,7 +13,7 @@
 import static org.opensearch.flowframework.common.CommonValue.TRANSPORT_ACION_NAME_PREFIX;
 
 /**
- * External Action for public facing RestCreateWorkflowActiom
+ * External Action for public facing RestCreateWorkflowAction
  */
 public class CreateWorkflowAction extends ActionType<WorkflowResponse> {
 
diff --git a/src/main/java/org/opensearch/flowframework/transport/SearchWorkflowAction.java b/src/main/java/org/opensearch/flowframework/transport/SearchWorkflowAction.java
index 138a1a01b..7f29174d9 100644
--- a/src/main/java/org/opensearch/flowframework/transport/SearchWorkflowAction.java
+++ b/src/main/java/org/opensearch/flowframework/transport/SearchWorkflowAction.java
@@ -13,6 +13,9 @@
 
 import static org.opensearch.flowframework.common.CommonValue.TRANSPORT_ACION_NAME_PREFIX;
 
+/**
+ * External Action for public facing RestSearchWorkflowAction
+ */
 public class SearchWorkflowAction extends ActionType<SearchResponse> {
 
     /** The name of this action */
diff --git a/src/main/java/org/opensearch/flowframework/transport/SearchWorkflowTransportAction.java b/src/main/java/org/opensearch/flowframework/transport/SearchWorkflowTransportAction.java
index f271b6dd2..56290c8ba 100644
--- a/src/main/java/org/opensearch/flowframework/transport/SearchWorkflowTransportAction.java
+++ b/src/main/java/org/opensearch/flowframework/transport/SearchWorkflowTransportAction.java
@@ -19,9 +19,18 @@
 import org.opensearch.tasks.Task;
 import org.opensearch.transport.TransportService;
 
+/**
+ * Transport Action to search workflows created
+ */
 public class SearchWorkflowTransportAction extends HandledTransportAction<SearchRequest, SearchResponse> {
     private Client client;
 
+    /**
+     * Intantiates a new CreateWorkflowTransportAction
+     * @param transportService the TransportService
+     * @param actionFilters action filters
+     * @param client The client used to make the request to OS
+     */
     @Inject
     public SearchWorkflowTransportAction(TransportService transportService, ActionFilters actionFilters, Client client) {
         super(SearchWorkflowAction.NAME, transportService, actionFilters, SearchRequest::new);
diff --git a/src/main/java/org/opensearch/flowframework/util/RestHandlerUtils.java b/src/main/java/org/opensearch/flowframework/util/RestHandlerUtils.java
index 7d6f04d0f..6857952aa 100644
--- a/src/main/java/org/opensearch/flowframework/util/RestHandlerUtils.java
+++ b/src/main/java/org/opensearch/flowframework/util/RestHandlerUtils.java
@@ -14,12 +14,22 @@
 import org.opensearch.search.builder.SearchSourceBuilder;
 import org.opensearch.search.fetch.subphase.FetchSourceContext;
 
+/**
+ * Utility methods for Rest Handlers
+ */
 public class RestHandlerUtils {
 
     public static final String[] USER_EXCLUDE = new String[] { CommonValue.USER_FIELD };
 
     private RestHandlerUtils() {}
 
+    /**
+     * Creates a source context and include/exclude information to be shared based on the user
+     *
+     * @param request the REST request
+     * @param searchSourceBuilder the search request source builder
+     * @return modified sources
+     */
     public static FetchSourceContext getSourceContext(RestRequest request, SearchSourceBuilder searchSourceBuilder) {
         // TODO
         // 1. Move UI_METADATA to GC Index
diff --git a/src/test/java/org/opensearch/flowframework/FlowFrameworkPluginTests.java b/src/test/java/org/opensearch/flowframework/FlowFrameworkPluginTests.java
index cbbc6d7fe..871b97067 100644
--- a/src/test/java/org/opensearch/flowframework/FlowFrameworkPluginTests.java
+++ b/src/test/java/org/opensearch/flowframework/FlowFrameworkPluginTests.java
@@ -53,8 +53,8 @@ public void tearDown() throws Exception {
     public void testPlugin() throws IOException {
         try (FlowFrameworkPlugin ffp = new FlowFrameworkPlugin()) {
             assertEquals(3, ffp.createComponents(client, null, threadPool, null, null, null, null, null, null, null, null).size());
-            assertEquals(2, ffp.getRestHandlers(null, null, null, null, null, null, null).size());
-            assertEquals(2, ffp.getActions().size());
+            assertEquals(3, ffp.getRestHandlers(null, null, null, null, null, null, null).size());
+            assertEquals(3, ffp.getActions().size());
             assertEquals(1, ffp.getExecutorBuilders(settings).size());
         }
     }