Adding javadocs

Signed-off-by: Joshua Palis <[email protected]>

src/main/java/org/opensearch/flowframework/rest/RestOrchestrateAction.java

@@ -43,6 +43,9 @@ public class RestOrchestrateAction extends BaseRestHandler {
 
     private static final String ORCHESTRATE_ACTION = "orchestrate_action";
 
+    /*
+     * Creates a new RestOrchestrateAction
+     */
     public RestOrchestrateAction() {}
 
     @Override

src/main/java/org/opensearch/flowframework/transport/OrchestrateRequest.java

@@ -31,11 +31,21 @@ public class OrchestrateRequest extends ActionRequest {
      */
     private Map<String, String> userInputs;
 
+    /**
+     * Creates a new orchestrate request
+     * @param workflowId the workflow ID
+     * @param userInputs the user inputs to substitute values for in the template
+     */
     public OrchestrateRequest(String workflowId, Map<String, String> userInputs) {
         this.workflowId = workflowId;
         this.userInputs = userInputs;
     }
 
+    /**
+     * Creates a new orchestrate request from stream input
+     * @param in the stream input
+     * @throws IOException on error reading from the stream input
+     */
     public OrchestrateRequest(StreamInput in) throws IOException {
         super(in);
         this.workflowId = in.readString();

src/main/java/org/opensearch/flowframework/transport/OrchestrateTransportAction.java

@@ -54,6 +54,16 @@ public class OrchestrateTransportAction extends HandledTransportAction<Orchestra
     private final PluginsService pluginsService;
     private final SearchPipelineService searchPipelineService;
 
+    /**
+     * Creates a new Orchestrate Transport Action instance
+     * @param transportService the transport service
+     * @param actionFilters action filters
+     * @param threadPool the thread pool
+     * @param client the opensearch client
+     * @param workflowProcessSorter the workflow process sorter
+     * @param pluginsService the plugins service
+     * @param searchPipelineService the search pipeline service
+     */
     @Inject
     public OrchestrateTransportAction(
         TransportService transportService,

src/main/java/org/opensearch/flowframework/workflow/SearchResponseProcessorStep.java

@@ -41,6 +41,10 @@ public class SearchResponseProcessorStep implements WorkflowStep {
     private final SearchPipelineService searchPipelineService;
     public static final String NAME = "search_response_processor";
 
+    /**
+     * Creates a new SearchResponseProcessorStep
+     * @param searchPipelineService the search pipeline service
+     */
     public SearchResponseProcessorStep(SearchPipelineService searchPipelineService) {
         this.searchPipelineService = searchPipelineService;
     }

src/main/java/org/opensearch/flowframework/workflow/WorkflowProcessSorter.java

@@ -84,6 +84,10 @@ public WorkflowProcessSorter(
         this.client = client;
     }
 
+    /**
+     * Updates the workflow step factory
+     * @param searchPipelineService the search pipeline service
+     */
     public void updateWorkflowStepFactory(SearchPipelineService searchPipelineService) {
         this.workflowStepFactory.updateWorkflowStepFactory(searchPipelineService);
     }

src/main/java/org/opensearch/flowframework/workflow/WorkflowStepFactory.java

@@ -118,6 +118,10 @@ public WorkflowStepFactory(
         stepMap.put(CreateSearchPipelineStep.NAME, () -> new CreateSearchPipelineStep(client, flowFrameworkIndicesHandler));
     }
 
+    /**
+     * Updates the step map with search response processors
+     * @param searchPipelineService the search pipeline service
+     */
     public void updateWorkflowStepFactory(SearchPipelineService searchPipelineService) {
         if (!this.stepMap.containsKey(SearchResponseProcessorStep.NAME)) {
             this.stepMap.put(SearchResponseProcessorStep.NAME, () -> new SearchResponseProcessorStep(searchPipelineService));

src/test/java/org/opensearch/flowframework/FlowFrameworkPluginTests.java

@@ -82,8 +82,8 @@ public void testPlugin() throws IOException {
                 5,
                 ffp.createComponents(client, clusterService, threadPool, null, null, null, environment, null, null, null, null).size()
             );
-            assertEquals(9, ffp.getRestHandlers(settings, null, null, null, null, null, null).size());
-            assertEquals(9, ffp.getActions().size());
+            assertEquals(10, ffp.getRestHandlers(settings, null, null, null, null, null, null).size());
+            assertEquals(10, ffp.getActions().size());
             assertEquals(3, ffp.getExecutorBuilders(settings).size());
             assertEquals(5, ffp.getSettings().size());
         }

src/test/java/org/opensearch/flowframework/model/WorkflowValidatorTests.java

@@ -14,6 +14,7 @@
 import org.opensearch.flowframework.workflow.WorkflowStepFactory;
 import org.opensearch.flowframework.workflow.WorkflowStepFactory.WorkflowSteps;
 import org.opensearch.ml.client.MachineLearningNodeClient;
+import org.opensearch.search.pipeline.SearchPipelineService;
 import org.opensearch.test.OpenSearchTestCase;
 import org.opensearch.threadpool.ThreadPool;
 
@@ -46,7 +47,7 @@ public void testParseWorkflowValidator() throws IOException {
 
         WorkflowValidator validator = new WorkflowValidator(workflowStepValidators);
 
-        assertEquals(17, validator.getWorkflowStepValidators().size());
+        assertEquals(18, validator.getWorkflowStepValidators().size());
 
         assertTrue(validator.getWorkflowStepValidators().keySet().contains("create_connector"));
         assertEquals(7, validator.getWorkflowStepValidators().get("create_connector").getInputs().size());
@@ -118,6 +119,7 @@ public void testWorkflowStepFactoryHasValidators() throws IOException {
             flowFrameworkSettings,
             client
         );
+        workflowStepFactory.updateWorkflowStepFactory(mock(SearchPipelineService.class));
 
         WorkflowValidator workflowValidator = workflowStepFactory.getWorkflowValidator();