fixing checkstyle

Signed-off-by: Joshua Palis <[email protected]>
opensearch-project · Mar 27, 2024 · ba21474 · ba21474
1 parent ccda5a7
commit ba21474
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/src/main/java/org/opensearch/flowframework/rest/RestOrchestrateAction.java b/src/main/java/org/opensearch/flowframework/rest/RestOrchestrateAction.java
@@ -43,8 +43,8 @@ public class RestOrchestrateAction extends BaseRestHandler {
 
     private static final String ORCHESTRATE_ACTION = "orchestrate_action";
 
-    /*
-     * Creates a new RestOrchestrateAction
+    /**
+     * Creates a new RestOrchestrateAction instance
      */
     public RestOrchestrateAction() {}
 

diff --git a/src/main/java/org/opensearch/flowframework/transport/OrchestrateRequest.java b/src/main/java/org/opensearch/flowframework/transport/OrchestrateRequest.java
@@ -52,10 +52,18 @@ public OrchestrateRequest(StreamInput in) throws IOException {
         this.userInputs = in.readMap(StreamInput::readString, StreamInput::readString);
     }
 
+    /**
+     * Returns the workflow ID
+     * @return the workflow ID
+     */
     public String getWorkflowId() {
         return this.workflowId;
     }
 
+    /**
+     * Returns the user inputs map
+     * @return the user inputs map
+     */
     public Map<String, String> getUserInputs() {
         return this.userInputs;
     }

diff --git a/src/main/java/org/opensearch/flowframework/workflow/SearchResponseProcessorStep.java b/src/main/java/org/opensearch/flowframework/workflow/SearchResponseProcessorStep.java
@@ -39,6 +39,9 @@ public class SearchResponseProcessorStep implements WorkflowStep {
 
     private static final Logger logger = LogManager.getLogger(SearchResponseProcessorStep.class);
     private final SearchPipelineService searchPipelineService;
+    /**
+     * The name of the SearchResponseProcessor step
+     */
     public static final String NAME = "search_response_processor";
 
     /**