Add flow type to the execution response#982
Merged
ThaminduR merged 3 commits intowso2:masterfrom Sep 8, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds flow type support to the flow execution API by introducing the flowType property to both success and error responses, enabling better identification and categorization of different flow types.
Key changes:
- Added
flowTypeproperty toFlowExecutionResponsemodel with validation annotations - Created new
FlowExecutionErrorDTOclass extendingErrorDTOto include flow type in error responses - Updated utility methods to propagate flow type from exceptions to error responses
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| flow-execution.yaml | Added flowType as required property in OpenAPI schema with description and example |
| Utils.java | Updated error handling methods to accept and propagate flowType parameter |
| FlowExecutionErrorDTO.java | New error DTO class extending ErrorDTO with flowType property |
| FlowExecutionServiceCore.java | Set flowType in response object during flow execution |
| FlowExecutionResponse.java | Added flowType property with validation, updated equals/hashCode/toString methods |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
ImalshaD
approved these changes
Sep 2, 2025
DilshanSenarath
approved these changes
Sep 8, 2025
DilshanSenarath
approved these changes
Sep 8, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue
wso2/product-is#25509
This pull request introduces support for handling and exposing the flow type in the flow execution API. The main changes include adding the
flowTypeproperty to the flow execution response model, ensuring it is included in API responses and error DTOs, and updating related utility methods and OpenAPI documentation.Flow Execution Response Model Updates
flowTypeproperty to theFlowExecutionResponseclass, including its getter/setter, builder method, and validation annotations. Updatedequals,hashCode, andtoStringmethods to account forflowType. [1] [2] [3] [4]flowTypeproperty in the response object.Error Handling Enhancements
FlowExecutionErrorDTOclass extendingErrorDTO, with aflowTypeproperty for error responses.Utils.javato includeflowTypewhen constructing error DTOs and API error responses, and propagatedflowTypefrom exceptions. [1] [2] [3] [4] [5]API Documentation
flow-execution.yaml) to requireflowTypein the flow execution response schema and documented its purpose.