Skip to content

Latest commit

 

History

History
175 lines (156 loc) · 18.9 KB

README.md

File metadata and controls

175 lines (156 loc) · 18.9 KB

Specification Roadmap

Note: Items in tables for each milestone do not imply an order of implementation.

Note: Milestone entries include the most notable updates only. For list of all commits see link

Status description:

Completed In Progress In Planning On Hold
✏️ 🚩 ❗️

Releases

Next planned release

Status Description Comments
✔️ Fix support for workflow extensions spec doc
✔️ Fix state execution timeout spec doc
✔️ Update rules of retries increment and multiplier properties spec doc
✔️ Add clarification on mutually exclusive properties spec doc
✔️ Make the resultEventRef attribute in EventRef definition not required spec doc
✔️ Make the stateName attribute in start definition not required spec doc
✔️ Remove id attribute from actions and states. Now, the names from both attributes must be unique within the workflow definition spec doc
✔️ Update eventRef props toproduceEventRef and consumeEventRef spec doc
✔️ Update eventRef props toresultEventTimeout and consumeEventTimeout spec doc
✔️ Apply fixes to auth spec schema workflow schema
✔️ Update the dataInputSchema top-level property by supporting the assignment of a JSON schema object workflow schema
✔️ Add the new WORKFLOW reserved keyword to workflow expressions
✔️ Update ForEach state iteration parameter example. This parameter is an expression variable, not a JSON property
✏️️ Add inline state defs in branches
✏️️ Update rest function definition
✏️️ Add "completedBy" functionality
✏️️ Define workflow context
✏️️ Start work on TCK
✏️️ Add integration with open-source runtimes
✏️️ Add SDKs for more languages (Python, PHP, Rust, etc)
✏️️ Add more samples
✏️️ Enforce SemVer version

Released version v0.8

Status Description Comments
✔️ Support custom function type definition spec doc
✔️ Workflow "name" no longer a required property spec doc
✔️ Workflow "start" no longer a required property spec doc
✔️ ForEach state "iterationParam" no longer a required property spec doc
✔️ Added "useData" for eventDataFilter, and "useResults" for actionDataFilter spec doc
✔️ Added "resultEventTimeout" for action eventref spec doc
✔️ Added example for "continueAs" examples doc
✔️️ Support for async action invocation spec doc
✔️️ Support for action condition spec doc

Released version v0.7

Status Description Comments
✔️ Add workflow key and annotations properties spec doc
✔️ Replaced SubFlow state with subflow action type spec doc
✔️ Add workflow dataInputSchema property spec doc
✔️ Rename switch state default to defaultCondition to avoid keyword conflicts for SDK's spec doc
✔️ Add description of additional properties spec doc
✔️ Rename Parallel completionType values spec doc
✔️ Removed workflowId from ParallelState and ForEach states (use subFlow action instead) spec doc
✔️ Add subflow actions version property spec doc
✔️ Renamed schemaVersion to specVersion and it is now a required parameter spec doc
✔️ Add GraphQL support for function definitions spec doc
✔️ Added "dataOnly" property to Event Definitions (allow event data filters to access entire event) spec doc
✔️ Added support for Secrets and Constants spec doc
✔️ Changed default value of execution timeout interrupt property. This is a non-backwards compatible changes. spec doc
✔️ Updated workflow timeouts spec doc
✔️ Added Workflow Auth definitions spec doc
✔️ Added State execution timeouts spec doc
✔️ Temporarily removed waitForCompletion for subflows spec doc
✔️ Added function definition support for OData spec doc
✔️ Added function definition support for AsyncAPI spec doc
✔️ Rename Delay state to Sleep state spec doc
✔️ Added 'sleep' property to action definition spec doc
✔️ Added Rate Limiting extension spec doc
✔️ Update ForEach state - adding sequential exec option and batch size for parallel option spec doc
✔️ Update to error handling and retries. Retries are now per action rather than per state. Added option of automatic retries for actions spec doc
✔️ Added "continueAs" property to end definitions spec doc

Released version v0.6

Status Description Comments
✔️ Adding Workflow Compensation capabilities (cmp Compensating Transaction, SAGA pattern) spec doc
✔️ Adding comparison examples with Google Cloud Workflow language comparisons doc
✔️ Updates to retry functionality retries: exponential backoff & max backoff retries: max-attempts & interval
✔️ Update "directInvoke" property type spec doc
✔️ Data schema input/output update spec doc
✔️ Updating start and end state definitions spec doc
✔️ Update cron definition (adding validUntil parameter) spec doc
✔️ Adding comparison examples with Temporal comparison doc
✔️ Simplified functionRef and transition properties spec doc
✔️ Adding comparison examples with Cadence comparison doc
✔️ Adding workflow execTimeout and keepActive properties spec doc
✔️ Adding SubFlow state repeat (loop) ability spec doc
✔️ Adding comparison examples with BPMN comparison doc
✔️ Adding RPC type to function definitions (gRPC) spec doc
✔️ Change function definition 'parameters' to 'arguments' spec doc
✔️ Replace JsonPath with jq spec doc
✔️ Update start definition (move to top-level worklow param) spec doc
✔️ Updated schedule definition spec doc
✔️ Update data filters spec doc

Released version v0.5

Status Description Comments
Update Switch State spec doc
Rename Relay to Inject state spec doc
✔️ Update waitForCompletion property of Parallel State spec doc
✔️ Add timeout property to actions spec doc
✔️ Add examples comparing Argo workflow and spec markups examples doc
✔️ Add ability to produce events during state transitions spec doc
✔️ Add event-based condition capabilities to Switch State spec doc
✔️ Add examples comparing Brigade workflow and spec markups examples doc
✔️ Update produceEvent data property spec doc
✔️ Change uppercase property and enum types to lowercase spec doc
✔️ Add Parallel State Exception Handling section spec doc
✔️ Add Go SDK sdk repo
✔️ Add Java SDK sdk repo
✔️ Allow to define events as produced or consumed spec doc
✔️ Add "triggered" start definition spec doc
✔️ Update scheduled start definition - adding cron def spec doc
✔️ Add ability to reference trigger and result events in actions spec doc
✔️ Expand event correlation capabilities spec doc
✔️ Only use JsonPath expressions ( remove need for expression languages other than JsonPath) spec doc
✔️ Update workflow extensions spec doc
✔️ Add Workflow KPIs extension spec doc
✔️ Add Workflow Validation to Java SDK sdk repo
✔️ Update Switch state conditions and default definition spec doc
✔️ Update transitions and end definition 'produceEvents' definition spec doc
✔️ Events definition update - add convenience way to define multiple events that share properties spec doc
✔️ Update to function and events definitions - allow inline array def as well as uri reference to external resource spec doc
✔️ Enforce use of OpenAPI specification in function definitions for portability spec doc
✔️ Update workflow Error Handling spec doc

Released version v0.1

Status Description Comments
Establish governance, contributing guidelines and initial stakeholder governance doc
Define specification goals spec doc
Define specification functional scope spec doc
Include set of use-cases for Serverless Workflow usecases doc
Include set of examples for Serverless Workflow examples doc
Define specification JSON Schema spec doc
Add SubFlow state spec doc
Add Relay state spec doc
Add ForEach state spec doc
Update Event state spec doc
Define Workflow data input/output spec doc
Update state data filtering spec doc
Clearly define workflow info passing spec doc
Add Workflow error handling spec doc
Add reusable function definitions spec doc
Add support for YAML definitions spec doc
Update workflow end definition spec doc
Add Callback state spec doc
Add workflow metadata spec doc
✔️ Update workflow start definition spec doc
✔️ Prepare github branch and docs for v0.1 branch