opensearch-project / opensearch-project/flow-framework
[REFACTOR] Improve WorkflowRequest Class
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 62
- Forks
- 66
- Avg merge
- 3d 20h
- Merged PRs (30d)
- 20
Description
Is your feature request related to a problem?
Currently the Workflow Request class is used to handle several parameters such as provision, use_case, reprovision, etc, which is becoming unnecessarily complex and can lead to backwards compatibility issues with previous versions when serializing the requests.
What solution would you like?
Create subclasses of the WorkflowRequest class to handle each parameter
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the WorkflowRequest class and inspect how its provision, use_case, reprovision, and other parameters are serialized. Trace the existing request subclasses or serialization tests, if present, and define completion as separate subclasses that preserve compatibility with previous serialized requests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100