+[
-
-
+
+
| Argo | -Serverless Workflow | -
|---|---|
| - -```yaml -apiVersion: argoproj.io/v1alpha1 -kind: Workflow -metadata: - generateName: hello-world-parameters- -spec: - entrypoint: whalesay - arguments: - parameters: - - name: message - value: hello world - - templates: - - name: whalesay - inputs: - parameters: - - name: message - container: - image: docker/whalesay - command: [cowsay] - args: ["{{inputs.parameters.message}}"] -``` - - | -- -```yaml -id: hello-world-parameters -name: Hello World with parameters -version: '1.0.0' -specVersion: '0.8' -start: whalesay -functions: -- name: whalesayimage - metadata: - image: docker/whalesay - command: cowsay -states: -- name: whalesay - type: operation - actions: - - functionRef: - refName: whalesayimage - arguments: - message: "${ .message }" - end: true -``` - - | -
| Argo | -Serverless Workflow | -
|---|---|
| - -```yaml -apiVersion: argoproj.io/v1alpha1 -kind: Workflow -metadata: - generateName: steps- -spec: - entrypoint: hello-hello-hello - templates: - - name: hello-hello-hello - steps: - - - name: hello1 # hello1 is run before the following steps - template: whalesay - arguments: - parameters: - - name: message - value: "hello1" - - - name: hello2a # double dash => run after previous step - template: whalesay - arguments: - parameters: - - name: message - value: "hello2a" - - name: hello2b # single dash => run in parallel with previous step - template: whalesay - arguments: - parameters: - - name: message - value: "hello2b" - - name: whalesay - inputs: - parameters: - - name: message - container: - image: docker/whalesay - command: [cowsay] - args: ["{{inputs.parameters.message}}"] -``` - - | -- -```yaml -id: hello-hello-hello -name: Multi Step Hello -version: '1.0.0' -specVersion: '0.8' -start: hello1 -functions: -- name: whalesayimage - metadata: - image: docker/whalesay - command: cowsay -states: -- name: hello1 - type: operation - actions: - - functionRef: - refName: whalesayimage - arguments: - message: hello1 - transition: parallelhello -- name: parallelhello - type: parallel - completionType: allOf - branches: - - name: hello2a-branch - actions: - - functionRef: - refName: whalesayimage - arguments: - message: hello2a - - name: hello2b-branch - actions: - - functionRef: - refName: whalesayimage - arguments: - message: hello2b - end: true -``` - - | -
| Argo | -Serverless Workflow | -
|---|---|
| - -```yaml -apiVersion: argoproj.io/v1alpha1 -kind: Workflow -metadata: - generateName: dag-diamond- -spec: - entrypoint: diamond - templates: - - name: echo - inputs: - parameters: - - name: message - container: - image: alpine:3.7 - command: [echo, "{{inputs.parameters.message}}"] - - name: diamond - dag: - tasks: - - name: A - template: echo - arguments: - parameters: [{name: message, value: A}] - - name: B - dependencies: [A] - template: echo - arguments: - parameters: [{name: message, value: B}] - - name: C - dependencies: [A] - template: echo - arguments: - parameters: [{name: message, value: C}] - - name: D - dependencies: [B, C] - template: echo - arguments: - parameters: [{name: message, value: D}] -``` - - | -- -```yaml -id: dag-diamond- -name: DAG Diamond Example -version: '1.0.0' -specVersion: '0.8' -start: A -functions: -- name: echo - metadata: - image: alpine:3.7 - command: '[echo, "{{inputs.parameters.message}}"]' -states: -- name: A - type: operation - actions: - - functionRef: - refName: echo - arguments: - message: A - transition: parallelecho -- name: parallelecho - type: parallel - completionType: allOf - branches: - - name: B-branch - actions: - - functionRef: - refName: echo - arguments: - message: B - - name: C-branch - actions: - - functionRef: - refName: echo - arguments: - message: C - transition: D -- name: D - type: operation - actions: - - functionRef: - refName: echo - arguments: - message: D - end: true -``` - - | -
| Argo | -Serverless Workflow | -
|---|---|
| - -```yaml -apiVersion: argoproj.io/v1alpha1 -kind: Workflow -metadata: - generateName: scripts-bash- -spec: - entrypoint: bash-script-example - templates: - - name: bash-script-example - steps: - - - name: generate - template: gen-random-int-bash - - - name: print - template: print-message - arguments: - parameters: - - name: message - value: "{{steps.generate.outputs.result}}" # The result of the here-script - - - name: gen-random-int-bash - script: - image: debian:9.4 - command: [bash] - source: | # Contents of the here-script - cat /dev/urandom | od -N2 -An -i | awk -v f=1 -v r=100 '{printf "%i\n", f + r * $1 / 65536}' - - - name: gen-random-int-python - script: - image: python:alpine3.6 - command: [python] - source: | - import random - i = random.randint(1, 100) - print(i) - - - name: gen-random-int-javascript - script: - image: node:9.1-alpine - command: [node] - source: | - var rand = Math.floor(Math.random() * 100); - console.log(rand); - - - name: print-message - inputs: - parameters: - - name: message - container: - image: alpine:latest - command: [sh, -c] - args: ["echo result was: {{inputs.parameters.message}}"] -``` - - | -- -```yaml -id: scripts-bash- -name: Scripts and Results Example -version: '1.0.0' -specVersion: '0.8' -start: generate -functions: -- name: gen-random-int-bash - metadata: - image: debian:9.4 - command: bash - source: |- - cat /dev/urandom | od -N2 -An -i | awk -v f=1 -v r=100 '{printf "%i - ", f + r * $1 / 65536}' -- name: gen-random-int-python - metadata: - image: python:alpine3.6 - command: python - source: "import random \ni = random.randint(1, 100) \nprint(i)\n" -- name: gen-random-int-javascript - metadata: - image: node:9.1-alpine - command: node - source: "var rand = Math.floor(Math.random() * 100); \nconsole.log(rand);\n" -- name: printmessagefunc - metadata: - image: alpine:latest - command: sh, -c - source: 'echo result was: ${ .inputs.parameters.message }' -states: -- name: generate - type: operation - actions: - - functionRef: gen-random-int-bash - actionDataFilter: - results: "${ .results }" - transition: print-message -- name: print-message - type: operation - actions: - - functionRef: - refName: printmessagefunc - arguments: - message: "${ .results }" - end: true -``` - - | -
| Argo | -Serverless Workflow | -
|---|---|
| - -```yaml -apiVersion: argoproj.io/v1alpha1 -kind: Workflow -metadata: - generateName: loops- -spec: - entrypoint: loop-example - templates: - - name: loop-example - steps: - - - name: print-message - template: whalesay - arguments: - parameters: - - name: message - value: "{{item}}" - withItems: # invoke whalesay once for each item in parallel - - hello world # item 1 - - goodbye world # item 2 - - - name: whalesay - inputs: - parameters: - - name: message - container: - image: docker/whalesay:latest - command: [cowsay] - args: ["{{inputs.parameters.message}}"] -``` - - | -- -```yaml -id: loops- -name: Loop over data example -version: '1.0.0' -specVersion: '0.8' -start: injectdata -functions: -- name: whalesay - metadata: - image: docker/whalesay:latest - command: cowsay -states: -- name: injectdata - type: inject - data: - greetings: - - hello world - - goodbye world - transition: printgreetings -- name: printgreetings - type: foreach - inputCollection: "${ .greetings }" - iterationParam: greeting - actions: - - name: print-message - functionRef: - refName: whalesay - arguments: - message: "${ .greeting }" - end: true -``` - - | -
| Argo | -Serverless Workflow | -
|---|---|
| - -```yaml -apiVersion: argoproj.io/v1alpha1 -kind: Workflow -metadata: - generateName: coinflip- -spec: - entrypoint: coinflip - templates: - - name: coinflip - steps: - # flip a coin - - - name: flip-coin - template: flip-coin - # evaluate the result in parallel - - - name: heads - template: heads # call heads template if "heads" - when: "{{steps.flip-coin.outputs.result}} == heads" - - name: tails - template: tails # call tails template if "tails" - when: "{{steps.flip-coin.outputs.result}} == tails" - - # Return heads or tails based on a random number - - name: flip-coin - script: - image: python:alpine3.6 - command: [python] - source: | - import random - result = "heads" if random.randint(0,1) == 0 else "tails" - print(result) - - - name: heads - container: - image: alpine:3.6 - command: [sh, -c] - args: ["echo \"it was heads\""] - - - name: tails - container: - image: alpine:3.6 - command: [sh, -c] - args: ["echo \"it was tails\""] -``` - - | -- -```yaml -id: coinflip- -name: Conditionals Example -version: '1.0.0' -specVersion: '0.8' -start: flip-coin -functions: -- name: flip-coin-function - metadata: - image: python:alpine3.6 - command: python - source: import random result = "heads" if random.randint(0,1) == 0 else "tails" - print(result) -- name: echo - metadata: - image: alpine:3.6 - command: sh, -c -states: -- name: flip-coin - type: operation - actions: - - functionRef: flip-coin-function - actionDataFilter: - results: "${ .flip.result }" - transition: show-flip-results -- name: show-flip-results - type: switch - dataConditions: - - condition: "${ .flip | .result == \"heads\" }" - transition: show-results-heads - - condition: "${ .flip | .result == \"tails\" }" - transition: show-results-tails -- name: show-results-heads - type: operation - actions: - - functionRef: echo - actionDataFilter: - results: it was heads - end: true -- name: show-results-tails - type: operation - actions: - - functionRef: echo - actionDataFilter: - results: it was tails - end: true -``` - - | -
| Argo | -Serverless Workflow | -
|---|---|
| - -```yaml -apiVersion: argoproj.io/v1alpha1 -kind: Workflow -metadata: - generateName: retry-backoff- -spec: - entrypoint: retry-backoff - templates: - - name: retry-backoff - retryStrategy: - limit: 10 - retryPolicy: "Always" - backoff: - duration: "1" # Must be a string. Default unit is seconds. Could also be a Duration, e.g.: "2m", "6h", "1d" - factor: 2 - maxDuration: "1m" # Must be a string. Default unit is seconds. Could also be a Duration, e.g.: "2m", "6h", "1d" - affinity: - nodeAntiAffinity: {} - container: - image: python:alpine3.6 - command: ["python", -c] - # fail with a 66% probability - args: ["import random; import sys; exit_code = random.choice([0, 1, 1]); sys.exit(exit_code)"] -``` - - | -- -```yaml -id: retry-backoff- -name: Retry Example -version: '1.0.0' -specVersion: '0.8' -start: retry-backoff -functions: -- name: fail-function - metadata: - image: python:alpine3.6 - command: python -retries: -- name: All workflow errors retry strategy - maxAttempts: 10 - delay: PT1S - maxDelay: PT1M - multiplier: 2 -states: -- name: retry-backoff - type: operation - actions: - - functionRef: - refName: flip-coin-function - arguments: - args: - - import random; import sys; exit_code = random.choice([0, 1, 1]); sys.exit(exit_code) - end: true -``` - - | -
| Argo | -Serverless Workflow | -
|---|---|
| - -```yaml -apiVersion: argoproj.io/v1alpha1 -kind: Workflow -metadata: - generateName: coinflip-recursive- -spec: - entrypoint: coinflip - templates: - - name: coinflip - steps: - # flip a coin - - - name: flip-coin - template: flip-coin - # evaluate the result in parallel - - - name: heads - template: heads # call heads template if "heads" - when: "{{steps.flip-coin.outputs.result}} == heads" - - name: tails # keep flipping coins if "tails" - template: coinflip - when: "{{steps.flip-coin.outputs.result}} == tails" - - - name: flip-coin - script: - image: python:alpine3.6 - command: [python] - source: | - import random - result = "heads" if random.randint(0,1) == 0 else "tails" - print(result) - - - name: heads - container: - image: alpine:3.6 - command: [sh, -c] - args: ["echo \"it was heads\""] -``` - - | -- -```yaml -id: coinflip-recursive- -name: Recursion Example -version: '1.0.0' -specVersion: '0.8' -start: flip-coin-state -functions: -- name: heads-function - metadata: - image: alpine:3.6 - command: echo "it was heads" -- name: flip-coin-function - metadata: - image: python:alpine3.6 - command: python - source: import random result = "heads" if random.randint(0,1) == 0 else "tail" print(result) -states: -- name: flip-coin-state - type: operation - actions: - - functionRef: flip-coin-function - actionDataFilter: - results: "${ .steps.flip-coin.outputs.result }" - transition: flip-coin-check -- name: flip-coin-check - type: switch - dataConditions: - - condition: "${ .steps.flip-coin.outputs | .result == \"tails\" }" - transition: flip-coin-state - - condition: "${ .steps.flip-coin.outputs | .result == \"heads\" }" - transition: heads-state -- name: heads-state - type: operation - actions: - - functionRef: - refName: heads-function - arguments: - args: echo "it was heads" - end: true -``` - - | -
| Argo | -Serverless Workflow | -
|---|---|
| - -```yaml -apiVersion: argoproj.io/v1alpha1 -kind: Workflow -metadata: - generateName: exit-handlers- -spec: - entrypoint: intentional-fail - onExit: exit-handler # invoke exit-handler template at end of the workflow - templates: - # primary workflow template - - name: intentional-fail - container: - image: alpine:latest - command: [sh, -c] - args: ["echo intentional failure; exit 1"] - - name: exit-handler - steps: - - - name: notify - template: send-email - - name: celebrate - template: celebrate - when: "{{workflow.status}} == Succeeded" - - name: cry - template: cry - when: "{{workflow.status}} != Succeeded" - - name: send-email - container: - image: alpine:latest - command: [sh, -c] - args: ["echo send e-mail: {{workflow.name}} {{workflow.status}}"] - - name: celebrate - container: - image: alpine:latest - command: [sh, -c] - args: ["echo hooray!"] - - name: cry - container: - image: alpine:latest - command: [sh, -c] - args: ["echo boohoo!"] -``` - - | -- -```yaml -id: exit-handlers- -name: Exit/Error Handling Example -version: '1.0.0' -specVersion: '0.8' -autoRetries: true -start: intentional-fail-state -functions: - - name: intentional-fail-function - metadata: - image: alpine:latest - command: "[sh, -c]" - - name: send-email-function - metadata: - image: alpine:latest - command: "[sh, -c]" - - name: celebrate-cry-function - metadata: - image: alpine:latest - command: "[sh, -c]" -errors: - - name: IntentionalError - code: '404' -states: - - name: intentional-fail-state - type: operation - actions: - - functionRef: - refName: intentional-fail-function - arguments: - args: echo intentional failure; exit 1 - nonRetryableErrors: - - IntentionalError - onErrors: - - errorRef: IntentionalError - transition: send-email-state - end: true - - name: send-email-state - type: operation - actions: - - functionRef: - refName: send-email-function - arguments: - args: 'echo send e-mail: ${ .workflow.name } ${ .workflow.status }' - transition: emo-state - - name: emo-state - type: switch - dataConditions: - - condition: ${ .workflow| .status == "Succeeded" } - transition: celebrate-state - - condition: ${ .workflow| .status != "Succeeded" } - transition: cry-state - - name: celebrate-state - type: operation - actions: - - functionRef: - refName: celebrate-cry-function - arguments: - args: echo hooray! - end: true - - name: cry-state - type: operation - actions: - - functionRef: - refName: celebrate-cry-function - arguments: - args: echo boohoo! - end: true -``` - - | -
| BPMN2 Diagram | -Serverless Workflow | -
|---|---|
|
-
- |
-- -```yaml -id: processfile -name: Process File Workflow -version: '1.0.0' -specVersion: '0.8' -start: Process File -states: -- name: Process File - type: operation - actions: - - functionRef: processFile - end: true -functions: -- name: processFile - operation: file://myservice.json#process -``` - - | -
-| BPMN2 Diagram | -Serverless Workflow | -
|---|---|
|
-
- |
-- -```yaml -id: processapplication -name: Process Application -version: '1.0.0' -specVersion: '0.8' -start: ProcessNewApplication -states: -- name: ProcessNewApplication - type: event - onEvents: - - eventRefs: - - ApplicationReceivedEvent - actions: - - functionRef: processApplicationFunction - - functionRef: acceptApplicantFunction - - functionRef: depositFeesFunction - end: - produceEvents: - - eventRef: NotifyApplicantEvent -functions: -- name: processApplicationFunction - operation: file://myservice.json#process -- name: acceptApplicantFunction - operation: file://myservice.json#accept -- name: depositFeesFunction - operation: file://myservice.json#deposit -events: -- name: ApplicationReceivedEvent - type: application - source: "/applications/new" -- name: NotifyApplicantEvent - type: notifications - source: "/applicants/notify" -``` - - | -
-| BPMN2 Diagram | -Serverless Workflow | -
|---|---|
|
-
- |
-- -```yaml -id: simplecompensation -name: Simple Compensation -version: '1.0.0' -specVersion: '0.8' -start: Step 1 -states: -- name: Step 1 - type: operation - actions: - - functionRef: step1function - compensatedBy: Cancel Step 1 - transition: Step 2 -- name: Step 2 - type: operation - actions: - - functionRef: step2function - transition: OK? -- name: OK? - type: switch - dataConditions: - - name: 'yes' - condition: ${ .outcome | .ok == "yes" } - end: true - - name: 'no' - condition: ${ .outcome | .ok == "no" } - end: - compensate: true -- name: Cancel Step 1 - type: operation - usedForCompensation: true - actions: - - functionRef: undostep1 -functions: -- name: step1function - operation: file://myservice.json#step1 -- name: step2function - operation: file://myservice.json#step2 -- name: undostep1function - operation: file://myservice.json#undostep1 -``` - - | -
-| BPMN2 Diagram | -Serverless Workflow | -
|---|---|
|
-
- |
-- -```yaml ---- -id: errorwithretries -name: Error Handling With Retries Workflow -version: '1.0.0' -specVersion: '0.8' -start: Make Coffee -states: - - name: Make Coffee - type: operation - actions: - - functionRef: makeCoffee - transition: Add Milk - - name: Add Milk - type: operation - actions: - - functionRef: addMilk - retryRef: noMilkRetries - retryableErrors: - - D'oh! No more Milk! - onErrors: - - errorRef: D'oh! No more Milk! - end: true - transition: Drink Coffee - - name: Drink Coffee - type: operation - actions: - - functionRef: drinkCoffee - end: true -retries: - - name: noMilkRetries - delay: PT1M - maxAttempts: 10 -errors: - - name: D'oh! No more Milk! - code: '123' -functions: - - name: makeCoffee - operation: file://myservice.json#make - - name: addMilk - operation: file://myservice.json#add - - name: drinkCoffee - operation: file://myservice.json#drink - -``` - - | -
-| BPMN2 Diagram | -Serverless Workflow | -
|---|---|
|
-
- |
-- -```yaml -id: executiontimeout -name: Execution Timeout Workflow -version: '1.0.0' -specVersion: '0.8' -start: Purchase Parts -timeouts: - workflowExecTimeout: - duration: PT7D - interrupt: true - runBefore: Handle timeout -states: -- name: Purchase Parts - type: operation - actions: - - functionRef: purchasePartsFunction - transition: Unpack Parts -- name: Unpack Parts - type: operation - actions: - - functionRef: unpackPartsFunction - end: true -- name: Handle timeout - type: operation - actions: - - functionRef: handleTimeoutFunction -functions: -- name: purchasePartsFunction - operation: file://myservice.json#purchase -- name: unpackPartsFunction - operation: file://myservice.json#unpack -- name: handleTimeoutFunction - operation: file://myservice.json#handle -``` - - | -
-| BPMN2 Diagram | -Serverless Workflow | -
|---|---|
|
-
- |
-- -```yaml -id: foreachWorkflow -name: ForEach State Workflow -version: '1.0.0' -specVersion: '0.8' -start: ForEachItem -states: -- name: ForEachItem - type: foreach - inputCollection: "${ .inputsArray }" - iterationParam: "${ .inputItem }" - outputCollection: "${ .outputsArray }" - actions: - - subFlowRef: doSomethingAndWaitForMessage - end: true -``` - - | -
-| BPMN2 Diagram | -Serverless Workflow | -
|---|---|
|
-
- |
-- -```yaml -id: subflowloop -name: SubFlow Loop Workflow -version: '1.0.0' -specVersion: '0.8' -start: SubflowRepeat -states: -- name: SubflowRepeat - type: operation - actions: - - functionRef: checkAndReplyToEmail - actionDataFilter: - fromStateData: ${ .someInput } - toStateData: ${ .someInput } - stateDataFilter: - output: ${ .maxChecks -= 1 } - transition: CheckCount -- name: CheckCount - type: switch - dataConditions: - - condition: ${ .maxChecks > 0 } - transition: SubflowRepeat - defaultCondition: - end: true -``` - - | -
-| BPMN2 Diagram | -Serverless Workflow | -
|---|---|
|
-
- |
-- -```yaml -id: approvereport -name: Approve Report Workflow -version: '1.0.0' -specVersion: '0.8' -start: Approve Report -states: -- name: Approve Report - type: callback - action: - functionRef: managerDecideOnReport - eventRef: ReportDecisionMadeEvent - transition: Evaluate Report Decision -- name: Evaluate Report Decision - type: switch - dataConditions: - - name: Approve - condition: "${ .decision | .approved == true }" - end: true - - name: Reject - condition: "${ .decision | .approved != true }" - transition: Update Report -- name: Update Report - type: callback - action: - functionRef: workerUpdateReport - eventRef: ReportUpdatedEvent - transition: Approve Report -events: -- name: ReportDecisionMadeEvent - type: report.decisions - source: reports/decision -- name: ReportUpdatedEvent - type: report.updated - source: reports/updated -functions: -- name: managerDecideOnReport - operation: file://myservice.json#managerapproval -- name: workerUpdateReport - operation: file://myservice.json#workerupdate -``` - - | -
-| BPMN2 Diagram | -Serverless Workflow | -
|---|---|
|
-
- |
-- -```yaml -id: eventdecision -name: Event Decision workflow -version: '1.0.0' -specVersion: '0.8' -start: A -states: -- name: A - type: operation - actions: - - subFlowRef: asubflowid - transition: Event Decision -- name: Event Decision - type: switch - eventConditions: - - eventRef: EventB - transition: B - - eventRef: EventC - transition: C -- name: B - type: operation - actions: - - name: doSomething - functionRef: doSomethingFunction - end: true -- name: C - type: operation - actions: - - name: doSomething - functionRef: doSomethingFunction - end: true -events: -- name: EventB - type: my.events.b - source: "/events/+" -- name: EventC - type: my.events.c - source: "/events/+" -functions: -- name: doSomethingFunction - operation: file://myservice.json#dosomething -``` - - | -
-| Brigade | -Serverless Workflow | -
|---|---|
| - -```javascript -const { events, Job } = require("brigadier"); - -events.on("exec", exec); - -function exec(e, p) { - let j1 = new Job("j1", "alpine:3.7", ["echo hello"]); - let j2 = new Job("j2", "alpine:3.7", ["echo goodbye"]); - - j1.run() - .then(() => { - return j2.run() - }) - .then(() => { - console.log("done"); - }); -}; -``` - - | -- -```yaml -id: greeting -name: Greeting Workflow -version: '1.0.0' -specVersion: '0.8' -start: GreetingState -events: -- name: execEvent - type: exec -functions: -- name: greetingFunction - metadata: - image: alpine:3.7 - command: echo -- name: consoleLogFunction - type: console -states: -- name: GreetingState - type: event - onEvents: - - eventRefs: - - execEvent - actions: - - name: sayHelloAction - functionRef: - refName: greetingFunction - arguments: - greeting: hello - - name: sayGoodbyeAction - functionRef: - refName: greetingFunction - arguments: - greeting: hello - - name: logDoneAction - functionRef: - refName: consoleLogFunction - arguments: - log: done - end: true -``` - - | -
| Brigade | -Serverless Workflow | -
|---|---|
| - -```javascript -const { events, Job } = require("brigadier"); - -events.on("exec", exec); - -async function exec(e, p) { - let j1 = new Job("j1", "alpine:3.7", ["echo hello"]); - // This will fail - let j2 = new Job("j2", "alpine:3.7", ["exit 1"]); - - try { - await j1.run(); - await j2.run(); - console.log("done"); - } catch (e) { - console.log(`Caught Exception ${e}`); - } -}; -``` - - | -- -```yaml -id: greetingwitherrorcheck -name: Greeting Workflow With Error Check -version: '1.0.0' -specVersion: '0.8' -autoRetries: true -start: GreetingState -events: -- name: execEvent - type: exec -errors: -- name: CommonError - code: '123' -functions: -- name: greetingFunction - metadata: - image: alpine:3.7 - command: echo -- name: consoleLogFunction - metadata: - type: console -states: -- name: GreetingState - type: event - onEvents: - - eventRefs: - - execEvent - actions: - - name: sayHelloAction - functionRef: - refName: greetingFunction - arguments: - greeting: hello - nonRetryableErrors: - - CommonError - - name: sayGoodbyeAction - functionRef: - refName: greetingFunction - arguments: - greeting: hello - nonRetryableErrors: - - CommonError - - name: logDoneAction - functionRef: - refName: consoleLogFunction - arguments: - log: done - nonRetryableErrors: - - CommonError - onErrors: - - errorRef: CommonError - transition: HandleErrorState - end: true -- name: HandleErrorState - type: operation - actions: - - name: logErrorAction - functionRef: - refName: consoleLogFunction - arguments: - log: Caught Exception ${ .exception } - end: true -``` - - | -
| Brigade | -Serverless Workflow | -
|---|---|
| - -```javascript -const { events } = require("brigadier") - -events.on("exec", () => { - console.log("==> handling an 'exec' event") -}) - -events.on("push", () => { - console.log(" **** I'm a GitHub 'push' handler") -}) -``` - - | -- -```yaml -id: multieventworkflow -name: Multiple Events Workflow -version: '1.0.0' -specVersion: '0.8' -start: GreetingState -events: -- name: execEvent - type: exec -- name: pushEvent - type: push -functions: -- name: consoleLogFunction - type: console -states: -- name: GreetingState - type: event - onEvents: - - eventRefs: - - execEvent - actions: - - name: logExecEventAction - functionRef: - refName: consoleLogFunction - arguments: - log: "==> handling an 'exec' event" - - eventRefs: - - pushEvent - actions: - - name: logPushEventAction - functionRef: - refName: consoleLogFunction - arguments: - log: "**** I'm a GitHub 'push' handler" - end: true -``` - - | -
| Brigade | -Serverless Workflow | -
|---|---|
| - -```javascript -const { events, Job, Group } = require("brigadier") - -events.on("exec", () => { - var hello = new Job("hello", "alpine:3.4", ["echo hello"]) - var goodbye = new Job("goodbye", "alpine:3.4", ["echo goodbye"]) - - var helloAgain = new Job("hello-again", "alpine:3.4", ["echo hello again"]) - var goodbyeAgain = new Job("bye-again", "alpine:3.4", ["echo bye again"]) - - - var first = new Group() - first.add(hello) - first.add(goodbye) - - var second = new Group() - second.add(helloAgain) - second.add(goodbyeAgain) - - first.runAll().then( () => second.runAll() ) -}) -``` - - | -- -```yaml -id: groupActionsWorkflow -name: Group Actions Workflow -version: '1.0.0' -specVersion: '0.8' -start: FirstGreetGroup -events: -- name: execEvent - type: exec -functions: -- name: echoFunction - metadata: - image: alpine:3.7 - command: echo -states: -- name: FirstGreetGroup - type: event - onEvents: - - eventRefs: - - execEvent - actions: - - name: firstHelloAction - functionRef: - refName: echoFunction - arguments: - message: hello - - name: firstGoodbyeAction - functionRef: - refName: echoFunction - arguments: - message: goodbye - transition: SecondGreetGroup -- name: SecondGreetGroup - type: operation - actions: - - name: secondHelloAction - functionRef: - refName: echoFunction - arguments: - message: hello-again - - name: secondGoodbyeAction - functionRef: - refName: echoFunction - arguments: - message: bye-again - end: true -``` - - | -
| Brigade | -Serverless Workflow | -
|---|---|
| - -```javascript -const { events } = require("brigadier") - -events.on("exec", (e, p) => { - console.log(">>> event " + e.type + " caused by " + e.provider) - console.log(">>> project " + p.name + " clones the repo at " + p.repo.cloneURL) -}) -``` - - | -- -```yaml -id: eventDataWorkflow -name: Event Data Workflow -version: '1.0.0' -specVersion: '0.8' -start: LogEventData -events: -- name: execEvent - type: exec - dataOnly: false -functions: -- name: consoleFunction - type: console -states: -- name: LogEventData - type: event - onEvents: - - eventRefs: - - execEvent - eventDataFilter: - toStateData: "${ .event }" - actions: - - name: eventInfoAction - functionRef: - refName: consoleFunction - arguments: - log: ">>> event ${ .event.type } caused by ${ .event.data.provider }" - - name: projectInfoAction - functionRef: - refName: consoleFunction - arguments: - log: ">>> project ${ .event.data.project.name } clones the repo at by ${ .event.data.repo.cloneURL }" - end: true - -``` - - | -
| Brigade | -Serverless Workflow | -
|---|---|
| - -```javascript -const { events, Job, Group } = require("brigadier") - -events.on("exec", (e, p) => { - var dest = "/mnt/brigade/share/hello.txt" - var one = new Job("one", "alpine:3.4", ["echo hello > " + dest]) - var two = new Job("two", "alpine:3.4", ["echo world >> " + dest]) - var three = new Job("three", "alpine:3.4", ["cat " + dest]) - - one.storage.enabled = true - two.storage.enabled = true - three.storage.enabled = true - - Group.runEach([one, two, three]) -}) -``` - - | -- -```yaml -id: actionResultsWorkflow -name: Action Results Workflow -version: '1.0.0' -specVersion: '0.8' -start: ExecActionsAndStoreResults -events: -- name: execEvent - type: exec -functions: -- name: greetingFunction - metadata: - image: alpine:3.7 - command: echo -- name: storeToFileFunction - metadata: - image: alpine:3.7 - command: filestore -states: -- name: ExecActionsAndStoreResults - type: event - onEvents: - - eventRefs: - - execEvent - eventDataFilter: - toStateData: "${ .event }" - actions: - - name: helloAction - actionDataFilter: - results: "${ .helloResult }" - functionRef: - refName: greetingFunction - arguments: - message: hello - - name: worldAction - actionDataFilter: - results: "${ .worldResults }" - functionRef: - refName: greetingAction - arguments: - message: world - - name: storeToFileAction - functionRef: - refName: storeToFileFunction - arguments: - destination: "${ .event.destination }" - value: "${ .helloResult } ${ .worldResults }" - end: true - -``` - - | -
| Brigade | -Serverless Workflow | -
|---|---|
| - -```javascript -const {events} = require("brigadier") - -events.on("exec", function(e, project) { - const e2 = { - type: "next", - provider: "exec-handler", - buildID: e.buildID, - workerID: e.workerID, - cause: {event: e} - } - events.fire(e2, project) -}) - -events.on("next", (e) => { - console.log(`fired ${e.type} caused by ${e.cause.event.type}`) -}) -``` - - | -- -```yaml -id: eventDataWorkflow -name: Event Data Workflow -version: '1.0.0' -specVersion: '0.8' -start: ExecEventState -events: -- name: execEvent - type: exec - dataOnly: false -- name: nextEvent - type: next - kind: produced -functions: -- name: consoleLogFunction - type: console -states: -- name: ExecEventState - type: event - onEvents: - - eventRefs: - - execEvent - actions: [] - eventDataFilter: - toStateData: "${ .execEvent }" - transition: - nextState: NextEventState - produceEvents: - - eventRef: nextEvent - data: - type: next - provider: exec-handler - buildID: "${ .execEvent.data.buildID }" - workerID: "${ .execEvent.data.workerID }" - cause: - event: "${ .execEvent }" -- name: NextEventState - type: event - onEvents: - - eventRefs: - - nextEvent - eventDataFilter: - toStateData: "${ .nextEvent }" - actions: - - name: consoleLogAction - functionRef: - refName: consoleLogFunction - arguments: - log: "fired ${ .nextEvent.data.type } caused by ${ .nextEvent.data.cause.event }" - end: true -``` - - | -
| Serverless Workflow | -|
|---|---|
| - -```json -{ - "main": { - "params": [ - "args" - ], - "steps": [ - { - "step1": { - "assign": [ - { - "outputVar": "${\"Hello \" + args.firstName + \" \" + args.lastName}" - } - ] - } - }, - { - "step2": { - "return": "${outputVar}" - } - } - ] - } -} -``` - - | -- -```json -{ - "id": "greetingwithargs", - "name": "Greeting With Args", - "specVersion": "0.8", - "start": "Set Output", - "states": [ - { - "name": "Set Output", - "type": "inject", - "data": { - "outputVar": "Hello ${ .firstname + \" \" + .lastname }" - }, - "stateDataFilter": { - "output": "${ .outputVar }" - }, - "end": true - } - ] -} -``` - - | -
| Serverless Workflow | -|
|---|---|
| - -```json -[ - { - "define": { - "assign": [ - { - "array": [ - "foo", - "ba", - "r" - ] - }, - { - "result": "" - }, - { - "i": 0 - } - ] - } - }, - { - "check_condition": { - "switch": [ - { - "condition": "${len(array) > i}", - "next": "iterate" - } - ], - "next": "exit_loop" - } - }, - { - "iterate": { - "assign": [ - { - "result": "${result + array[i]}" - }, - { - "i": "${i+1}" - } - ], - "next": "check_condition" - } - }, - { - "exit_loop": { - "return": { - "concat_result": "${result}" - } - } - } -] -``` - - | -- -```json -{ - "id": "concatarray", - "name": "Concatenating array values", - "start": "DoConcat", - "specVersion": "0.8", - "states": [ - { - "name": "DoConcat", - "type": "inject", - "data": { - "array": [ - "foo", - "ba", - "r" - ] - }, - "stateDataFilter": { - "output": "${ .array | join(\"\") }" - }, - "end": true - } - ] -} -``` - - | -
| Serverless Workflow | -|
|---|---|
| - -```json -[ - { - "initialize": { - "assign": [ - { - "project": "${sys.get_env(\"GOOGLE_CLOUD_PROJECT_NUMBER\")}" - }, - { - "zone": "us-central1-a" - }, - { - "vmToStop": "examplevm" - } - ] - } - }, - { - "stopInstance": { - "call": "http.post", - "args": { - "url": "${\"https://compute.googleapis.com/compute/v1/projects/\"+project+\"/zones/\"+zone+\"/instances/\"+vmToStop+\"/stop\"}", - "auth": { - "type": "OAuth2" - } - }, - "result": "stopResult" - } - } -] -``` - - | -- -```json -{ - "id": "stopcomputeengine", - "name": "Stop Compute Engine", - "specVersion": "0.8", - "start": "DoStop", - "states": [ - { - "name": "DoStop", - "type": "operation", - "actions": [ - { - "functionRef": { - "refName": "StopComputeEngine", - "arguments": { - "project": "${ .project }", - "zone": "${ .zone }", - "vmToStop": "${ .vmToStop }" - } - } - } - ], - "end": true - } - ], - "functions": [ - { - "name": "StopComputeEngine", - "operation": "computeengineopenapi.json#stopengine" - } - ] -} -``` - - | -
| Serverless Workflow | -|
|---|---|
| - -```json -[ - { - "initVariables": { - "assign": [ - { - "project": "${sys.get_env(\"GOOGLE_CLOUD_PROJECT_ID\")}" - }, - { - "topic": "mytopic1" - }, - { - "message": "Hello world!" - } - ] - } - }, - { - "publish": { - "try": { - "call": "googleapis.pubsub.v1.projects.topics.publish", - "args": { - "topic": "${\"projects/\" + project + \"/topics/\" + topic}", - "body": { - "messages": [ - { - "data": "${base64.encode(text.encode(message))}" - } - ] - } - }, - "result": "publishResult" - }, - "except": { - "as": "e", - "steps": [ - { - "handlePubSubError": { - "switch": [ - { - "condition": "${e.code == 404}", - "raise": "PubSub Topic not found" - }, - { - "condition": "${e.code == 403}", - "raise": "Error authenticating to PubSub" - } - ] - } - }, - { - "unhandledException": { - "raise": "${e}" - } - } - ] - } - } - }, - { - "last": { - "return": "${publishResult}" - } - } -] -``` - - | -- -```json -{ - "id": "publishtotopicwitherrorhandling", - "name": "Publish To Topic With Error Handling", - "specVersion": "0.8", - "start": "DoPublish", - "errors": [ - { - "name": "PubSub Topic not found", - "code": "404" - }, - { - "name": "Error authenticating to PubSub", - "code": "403" - } - ], - "states": [ - { - "name": "DoPublish", - "type": "operation", - "actions": [ - { - "functionRef": { - "refName": "PublishToTopic", - "arguments": { - "project": "${ .project }", - "topic": "${ .topic }", - "message": "${ .message }" - } - } - } - ], - "onErrors": [ - { - "errorRef": "PubSub Topic not found", - "end": { - "produceEvents": [ - { - "eventRef": "TopicError", - "data": { "message": "PubSub Topic not found"} - } - ] - } - }, - { - "errorRef": "Error authenticating to PubSub", - "end": { - "produceEvents": [ - { - "eventRef": "TopicError", - "data": { "message": "Error authenticating to PubSub"} - } - ] - } - } - ], - "end": true - } - ], - "functions": [ - { - "name": "PublishToTopic", - "operation": "pubsubapi.json#publish" - } - ], - "events": [ - { - "name": "TopicError", - "source": "pubsub.topic.events", - "type": "pubsub/events" - } - ] -} -``` - - | -
| Serverless Workflow | -|
|---|---|
| - -```json -{ - "main": { - "steps": [ - { - "read_item": { - "try": { - "call": "http.get", - "args": { - "url": "https://host.com/api" - }, - "result": "api_response" - }, - "retry": { - "predicate": "${custom_predicate}", - "max_retries": 5, - "backoff": { - "initial_delay": 2, - "max_delay": 60, - "multiplier": 2 - } - } - } - }, - { - "last_step": { - "return": "OK" - } - } - ] - }, - "custom_predicate": { - "params": [ - "e" - ], - "steps": [ - { - "what_to_repeat": { - "switch": [ - { - "condition": "${e.code == 500}", - "return": true - } - ] - } - }, - { - "otherwise": { - "return": false - } - } - ] - } -} -``` - - | -- -```json -{ - "id": "errorhandlingwithretries", - "name": "Error Handling with Retries", - "start": "ReadItem", - "specVersion": "0.8", - "states": [ - { - "name": "ReadItem", - "type": "operation", - "actions": [ - { - "functionRef": "ReadItemFromApi", - "retryRef": "ServiceNotAvailableRetryPolicy", - "retryableErrors": ["Service Not Available"] - } - ], - "onErrors": [ - { - "errorRef": "Service Not Available", - "end": true - } - ], - "end": true - } - ], - "functions": [ - { - "name": "ReadItemFromApi", - "operation": "someapi.json#read" - } - ], - "errors": [ - { - "name": "Service Not Available", - "code": "500" - } - ], - "retries": [ - { - "name": "ServiceNotAvailableRetryPolicy", - "maxAttempts": 5, - "delay": "PT2S", - "maxDelay": "PT60S", - "multiplier": 2 - } - ] -} -``` - - | -
| Serverless Workflow | -|
|---|---|
| - -```json -{ - "main": { - "steps": [ - { - "first": { - "call": "hello", - "args": { - "input": "Kristof" - }, - "result": "someOutput" - } - }, - { - "second": { - "return": "${someOutput}" - } - } - ] - }, - "hello": { - "params": [ - "input" - ], - "steps": [ - { - "first": { - "return": "${\"Hello \"+input}" - } - } - ] - } -} -``` - - | -- -```json -{ - "id": "callsubflow", - "name": "Call SubFlow", - "start": "CallSub", - "states": [ - { - "name": "CallSub", - "type":"operation", - "actions": [ - { - "subFlowRef": "calledsubflow" - } - ], - "end": true - } - ] -} -``` - - | -
| Serverless Workflow | -|
|---|---|
| - -```json -[ - { - "firstStep": { - "call": "http.get", - "args": { - "url": "https://www.example.com/callA" - }, - "result": "firstResult" - } - }, - { - "whereToJump": { - "switch": [ - { - "condition": "${firstResult.body.SomeField < 10}", - "next": "small" - }, - { - "condition": "${firstResult.body.SomeField < 100}", - "next": "medium" - } - ], - "next": "large" - } - }, - { - "small": { - "call": "http.get", - "args": { - "url": "https://www.example.com/SmallFunc" - }, - "next": "end" - } - }, - { - "medium": { - "call": "http.get", - "args": { - "url": "https://www.example.com/MediumFunc" - }, - "next": "end" - } - }, - { - "large": { - "call": "http.get", - "args": { - "url": "https://www.example.com/LargeFunc" - }, - "next": "end" - } - } -] -``` - - | -- -```json -{ - "id": "databasedconditions", - "name": "Data Based Conditions", - "start": "CallA", - "states": [ - { - "name": "CallA", - "type":"operation", - "actions": [ - { - "functionRef": "callFunctionA" - } - ], - "transition": "EvaluateAResults" - }, - { - "name": "EvaluateAResults", - "type": "switch", - "dataConditions": [ - { - "name": "Less than 10", - "condition": "${ .body | .SomeField < 10 }", - "transition": "CallSmall" - }, - { - "name": "Less than 100", - "condition": "${ .body | .SomeField < 100 }", - "transition": "CallMedium" - } - ], - "defaultCondition": { - "transition": "CallLarge" - } - }, - { - "name": "CallSmall", - "type":"operation", - "actions": [ - { - "functionRef": "callFunctionSmall" - } - ], - "end": true - }, - { - "name": "CallMedium", - "type":"operation", - "actions": [ - { - "functionRef": "callFunctionMedium" - } - ], - "end": true - }, - { - "name": "CallLarge", - "type":"operation", - "actions": [ - { - "functionRef": "callFunctionMedium" - } - ], - "end": true - } - ], - "functions": [ - { - "name": "callFunctionA", - "operation": "myapi.json#calla" - }, - { - "name": "callFunctionSmall", - "operation": "myapi.json#callsmall" - }, - { - "name": "callFunctionMedium", - "operation": "myapi.json#callmedium" - }, - { - "name": "callFunctionLarge", - "operation": "myapi.json#calllarge" - } - ] -} -``` - - | -
| Temporal | -Serverless Workflow | -
|---|---|
| - -```java -// Workflow implementation -public static class GreetingWorkflowImpl implements GreetingWorkflow { - private final GreetingActivities activities = - Workflow.newActivityStub( - GreetingActivities.class, - ActivityOptions.newBuilder().setScheduleToCloseTimeout(Duration.ofSeconds(2)).build()); - - // Workflow method - @Override - public String getGreeting(String name) { - return activities.composeGreeting("Hello", name); - } -} -``` - - | -- -```json -{ - "id": "greetingworkflow", - "name": "Greeting Workflow", - "version": "1.0.0", - "specVersion": "0.8", - "autoRetries": true, - "states": [ - { - "name": "Greet", - "type": "operation", - "actions": [ - { - "name": "Greet Action", - "functionRef": { - "refName": "GreetingFunction", - "arguments": { - "prefix": "Hello", - "name": "${ .name }" - } - } - } - ], - "timeouts": { - "actionExecTimeout": "PT2S" - }, - "end": true - } - ], - "functions": [ - { - "name": "GreetingFunction", - "operation": "myactionsapi.json#composeGreeting" - } - ] -} -``` - - | -
| Temporal | -Serverless Workflow | -
|---|---|
| - -```java -// Workflow implementation -public static class GreetingWorkflowImpl implements GreetingWorkflow { - private final GreetingActivities activities = - Workflow.newActivityStub( - GreetingActivities.class, - ActivityOptions.newBuilder().setScheduleToCloseTimeout(Duration.ofSeconds(10)).build()); - - @Override - public String greet(String name) { - activities.greet("Hello " + name + "!"); - } -} - -// Client code Workflow Options (cron) -WorkflowOptions workflowOptions = - WorkflowOptions.newBuilder() - .setWorkflowId(CRON_WORKFLOW_ID) - .setTaskQueue(TASK_QUEUE) - .setCronSchedule("* * * * *") - .setWorkflowExecutionTimeout(Duration.ofMinutes(10)) - .build(); - -``` - - | -- -```json -{ - "id": "greetingworkflow", - "name": "Greeting Workflow", - "version": "1.0.0", - "specVersion": "0.8", - "autoRetries": true, - "timeouts": { - "workflowExecTimeout": "PT10M" - } - "start": { - "stateName": "GreetingState", - "schedule": { - "cron": { - "expression": "* * * * *" - } - } - }, - "states": [ - { - "name": "GreetingState", - "type": "operation", - "actions": [ - { - "name": "Greet", - "functionRef": { - "refName": "GreetingFunction", - "arguments": { - "prefix": "Hello", - "name": "${ .name }" - } - } - } - ], - "timeouts": { - "actionExecTimeout": "PT2S" - }, - "end": true - } - ], - "functions": [ - { - "name": "GreetingFunction", - "operation": "myactionsapi.json#greet" - } - ] -} -``` - - | -
| Temporal | -Serverless Workflow | -
|---|---|
|
-
-```java
-// Workflow implementation
- public static class SagaWorkflowImpl implements SagaWorkflow {
- ActivityOperation activity =
- Workflow.newActivityStub(
- ActivityOperation.class,
- ActivityOptions.newBuilder().setScheduleToCloseTimeout(Duration.ofSeconds(2)).build());
-
- // Workflow Method
- @Override
- public void execute() {
- Saga saga = new Saga(new Saga.Options.Builder().setParallelCompensation(false).build());
- try {
- // The following demonstrate how to compensate sync invocations.
- ChildWorkflowOperation op1 = Workflow.newChildWorkflowStub(ChildWorkflowOperation.class);
- op1.execute(10);
- ChildWorkflowCompensation c1 =
- Workflow.newChildWorkflowStub(ChildWorkflowCompensation.class);
- saga.addCompensation(c1::compensate, -10);
-
- // The following demonstrate how to compensate async invocations.
- Promise |
-- -```json -{ - "id": "HelloSaga", - "name": "Hello SAGA compensation Workflow", - "version": "1.0.0", - "specVersion": "0.8", - "states": [ - { - "name": "ExecuteState", - "type": "operation", - "compensatedBy": "CompensateState", - "actions": [ - { - "name": "Execute", - "functionRef": { - "refName": "ExecuteFunction", - "arguments": { - "amount": 10 - } - } - } - ], - "end": { - "compensate": true - } - }, - { - "name": "CompensateState", - "type": "operation", - "usedForCompensation": true, - "actions": [ - { - "name": "Compensate", - "functionRef": { - "refName": "CompensateFunction", - "arguments": { - "amount": -10 - } - } - } - ] - } - ], - "functions": [ - { - "name": "ExecuteFunction", - "operation": "myactionsapi.json#execute" - }, - { - "name": "CompensateFunction", - "operation": "myactionsapi.json#compensate" - } - ] -} -``` - - | -
| Temporal | -Serverless Workflow | -
|---|---|
| - -```java -// Workflow Implementation -public static class GreetingWorkflowImpl implements GreetingWorkflow { - private final GreetingActivities activities = - Workflow.newActivityStub( - GreetingActivities.class, - ActivityOptions.newBuilder() - .setScheduleToCloseTimeout(Duration.ofSeconds(10)) - .setRetryOptions( - RetryOptions.newBuilder() - .setInitialInterval(Duration.ofSeconds(1)) - .setDoNotRetry(IllegalArgumentException.class.getName()) - .build()) - .build()); - @Override - public String getGreeting(String name) { - // This is a blocking call that returns only after activity is completed. - return activities.composeGreeting("Hello", name); - } -} - -// Activity Implementation -static class GreetingActivitiesImpl implements GreetingActivities { - private int callCount; - private long lastInvocationTime; - - @Override - public synchronized String composeGreeting(String greeting, String name) { - if (lastInvocationTime != 0) { - long timeSinceLastInvocation = System.currentTimeMillis() - lastInvocationTime; - System.out.print(timeSinceLastInvocation + " milliseconds since last invocation. "); - } - lastInvocationTime = System.currentTimeMillis(); - if (++callCount < 4) { - System.out.println("composeGreeting activity is going to fail"); - throw new IllegalStateException("not yet"); - } - System.out.println("composeGreeting activity is going to complete"); - return greeting + " " + name + "!"; - } -} -``` - - | -- -```json -{ - "id": "HelloActivityRetry", - "name": "Hello Activity with Retries Workflow", - "version": "1.0.0", - "specVersion": "0.8", - "autoRetries": true, - "start": "GreetingState", - "states": [ - { - "name": "GreetingState", - "type": "operation", - "actions": [ - { - "name": "Greet", - "functionRef": { - "refName": "GreetingFunction", - "arguments": { - "name": "World" - }, - "retryRef": "GreetingRetry", - "nonRetryableErrors": ["IllegalArgumentException"] - } - } - ], - "timeouts": { - "actionExecTimeout": "PT10S" - }, - "onErrors": [ - { - "errorRefs": ["IllegalStateException", "IllegalArgumentException"], - "end": true - } - ], - "end": true - } - ], - "functions": [ - { - "name": "GreetingFunction", - "operation": "myactionsapi.json#composeGreeting" - } - ], - "errors": [ - { - "name": "IllegalStateException" - }, - { - "name": "IllegalArgumentException" - } - ], - "retries": [ - { - "name": "GreetingRetry", - "delay": "PT1S" - } - ] -} -``` - - | -
[`timeout`](#timeout) | `no` | The configuration, if any, of the workflow's timeout.
*If a `string`, must be the name of a [timeout](#timeout) defined in the [workflow's reusable components](#use).* | +| output | [`output`](#output) | `no` | Configures the workflow's output. | +| schedule | [`schedule`](#schedule) | `no` | Configures the workflow's schedule, if any. | +| evaluate | [`evaluate`](#evaluate) | `no` | Configures runtime expression evaluation. | + +#### Document + +Documents the workflow definition. + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| dsl | `string` | `yes` | The version of the DSL used to define the workflow. | +| namespace | `string` | `yes` | The workflow's namespace.
| +| name | `string` | `yes` | The workflow's name.
| +| version | `string` | `yes` | The workflow's [semantic version](https://semver.org/) | +| title | `string` | `no` | The workflow's title. | +| summary | `string` | `no` | The workflow's Markdown summary. | +| tags | `map[string, string]` | `no` | A key/value mapping of the workflow's tags, if any. | +| metadata | `map` | `no` | Additional information about the workflow. | + +#### Use + +Defines the workflow's reusable components. + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| authentications | [`map[string, authentication]`](#authentication) | `no` | A name/value mapping of the workflow's reusable authentication policies. | +| catalogs | [`map[string, catalog]`(#catalog)] | `no` | A name/value mapping of the workflow's reusable resource catalogs. | +| errors | [`map[string, error]`](#error) | `no` | A name/value mapping of the workflow's reusable errors. | +| extensions | [`map[string, extension][]`](#extension) | `no` | A list of the workflow's reusable extensions. | +| functions | [`map[string, task]`](#task) | `no` | A name/value mapping of the workflow's reusable tasks. | +| retries | [`map[string, retryPolicy]`](#retry) | `no` | A name/value mapping of the workflow's reusable retry policies. | +| secrets | `string[]` | `no` | A list containing the workflow's secrets. | +| timeouts | [`map[string, timeout]`](#timeout) | `no` | A name/value mapping of the workflow's reusable timeouts. | + +#### Schedule + +Configures the schedule of a workflow. + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| every | [`duration`](#duration) | `no` | Specifies the duration of the interval at which the workflow should be executed. Unlike `after`, this option will run the workflow regardless of whether the previous run is still in progress.
*Required when no other property has been set.* | +| cron | `string` | `no` | Specifies the schedule using a CRON expression, e.g., '0 0 * * *' for daily at midnight.
*Required when no other property has been set.* | +| after | [`duration`](#duration) | `no` | Specifies a delay duration that the workflow must wait before starting again after it completes. In other words, when this workflow completes, it should run again after the specified amount of time.
*Required when no other property has been set.* | +| on | [`eventConsumptionStrategy`](#event-consumption-strategy) | `no` | Specifies the events that trigger the workflow execution.
*Required when no other property has been set.* | + +#### Evaluate + +Configures a workflow's runtime expression evaluation. + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| language | `string` | `yes` | The language used for writting runtime expressions.
*Defaults to `jq`.* | +| mode | `string` | `yes` | The runtime expression evaluation mode.
*Supported values are:*
- `strict`: requires all expressions to be enclosed within `${ }` for proper identification and evaluation.
- `loose`: evaluates any value provided. If the evaluation fails, it results in a string with the expression as its content.
*Defaults to `strict`.* + +#### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: order-pet + version: '0.1.0' + title: Order Pet - 1.0.0 + summary: > + # Order Pet - 1.0.0 + ## Table of Contents + - [Description](#description) + - [Requirements](#requirements) + ## Description + A sample workflow used to process an hypothetic pet order using the [PetStore API](https://petstore.swagger.io/) + ## Requirements + ### Secrets + - my-oauth2-secret +use: + authentications: + petStoreOAuth2: + oauth2: + authority: https://petstore.swagger.io/.well-known/openid-configuration + grant: client_credentials + client: + id: workflow-runtime + secret: "**********" + scopes: [ api ] + audiences: [ runtime ] + extensions: + - externalLogging: + extend: all + before: + - sendLog: + call: http + with: + method: post + endpoint: https://fake.log.collector.com + body: + message: ${ "Executing task '\($task.reference)'..." } + after: + - sendLog: + call: http + with: + method: post + endpoint: https://fake.log.collector.com + body: + message: ${ "Executed task '\($task.reference)'..." } + functions: + getAvailablePets: + call: openapi + with: + document: + endpoint: https://petstore.swagger.io/v2/swagger.json + operationId: findByStatus + parameters: + status: available + secrets: + - my-oauth2-secret +do: + - getAvailablePets: + call: getAvailablePets + output: + as: "$input + { availablePets: [.[] | select(.category.name == \"dog\" and (.tags[] | .breed == $input.order.breed))] }" + - submitMatchesByMail: + call: http + with: + method: post + endpoint: + uri: https://fake.smtp.service.com/email/send + authentication: + use: petStoreOAuth2 + body: + from: noreply@fake.petstore.com + to: ${ .order.client.email } + subject: Candidates for Adoption + body: > + Hello ${ .order.client.preferredDisplayName }! + + Following your interest to adopt a dog, here is a list of candidates that you might be interested in: + + ${ .pets | map("-\(.name)") | join("\n") } + + Please do not hesistate to contact us at info@fake.petstore.com if your have questions. + + Hope to hear from you soon! + + ---------------------------------------------------------------------------------------------- + DO NOT REPLY + ---------------------------------------------------------------------------------------------- +``` + +### Task + +A task within a [workflow](#workflow) represents a discrete unit of work that contributes to achieving the overall objectives defined by the [workflow](#workflow). + +It encapsulates a specific action or set of actions that need to be executed in a predefined order to advance the workflow towards its completion. + +[Tasks](#task) are designed to be modular and focused, each serving a distinct purpose within the broader context of the [workflow](#workflow). + +By breaking down the [workflow](#workflow) into manageable [tasks](#task), organizations can effectively coordinate and track progress, enabling efficient collaboration and ensuring that work is completed in a structured and organized manner. + +The Serverless Workflow DSL defines a list of [tasks](#task) that **must be** supported by all runtimes: + +- [Call](#call), used to call services and/or functions. +- [Do](#do), used to define one or more subtasks to perform in sequence. +- [Fork](#fork), used to define one or more subtasks to perform concurrently. +- [Emit](#emit), used to emit [events](#event-properties). +- [For](#for), used to iterate over a collection of items, and conditionally perform a task for each of them. +- [Listen](#listen), used to listen for an [event](#event-properties) or more. +- [Raise](#raise), used to raise an [error](#error) and potentially fault the [workflow](#workflow). +- [Run](#run), used to run a [container](#container-process), a [script](#script-process) , a [shell](#shell-process) command or even another [workflow](#workflow-process). +- [Switch](#switch), used to dynamically select and execute one of multiple alternative paths based on specified conditions +- [Set](#set), used to dynamically set the [workflow](#workflow)'s data during the its execution. +- [Try](#try), used to attempt executing a specified [task](#task), and to handle any resulting [errors](#error) gracefully, allowing the [workflow](#workflow) to continue without interruption. +- [Wait](#wait), used to pause or wait for a specified duration before proceeding to the next task. + +#### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| if | `string` | `no` | A [`runtime expression`](dsl.md#runtime-expressions), if any, used to determine whether or not the task should be run.
The task is considered skipped if not run, and the *raw* task input becomes the task's output. The expression is evaluated against the *raw* task input before any other expression of the task. | +| input | [`input`](#input) | `no` | An object used to customize the task's input and to document its schema, if any. | +| output | [`output`](#output) | `no` | An object used to customize the task's output and to document its schema, if any. | +| export | [`export`](#export) | `no` | An object used to customize the content of the workflow context. | +| timeout | `string`
[`timeout`](#timeout) | `no` | The configuration of the task's timeout, if any.
*If a `string`, must be the name of a [timeout](#timeout) defined in the [workflow's reusable components](#use).* | +| then | [`flowDirective`](#flow-directive) | `no` | The flow directive to execute next.
*If not set, defaults to `continue`.* | +| metadata | `map` | `no` | Additional information about the task. | + +#### Call + +Enables the execution of a specified function within a workflow, allowing seamless integration with custom business logic or external services. + +##### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| call | `string` | `yes` | The name of the function to call. | +| with | `map` | `no` | A name/value mapping of the parameters to call the function with | + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: call-example + version: '0.1.0' +do: + - getPet: + call: http + with: + method: get + endpoint: https://petstore.swagger.io/v2/pet/{petId} +``` + +Serverless Workflow defines several default functions that **MUST** be supported by all implementations and runtimes: + +- [AsyncAPI](#asyncapi-call) +- [gRPC](#grpc-call) +- [HTTP](#http-call) +- [OpenAPI](#openapi-call) + +##### AsyncAPI Call + +The [AsyncAPI Call](#asyncapi-call) enables workflows to interact with external services described by [AsyncAPI](https://www.asyncapi.com/). + +###### Properties + +| Name | Type | Required | Description | +|:-----|:----:|:--------:|:------------| +| document | [`externalResource`](#external-resource) | `yes` | The AsyncAPI document that defines the [operation](https://www.asyncapi.com/docs/reference/specification/v3.0.0#operationObject) to call. | +| channel | `string` | `yes` | The name of the channel on which to perform the operation. The operation to perform is defined by declaring either `message`, in which case the [channel](https://v2.asyncapi.com/docs/reference/specification/v2.6.0#channelItemObject)'s `publish` operation will be executed, or `subscription`, in which case the [channel](https://v2.asyncapi.com/docs/reference/specification/v2.6.0#channelItemObject)'s `subscribe` operation will be executed.
*Used only in case the referenced document uses AsyncAPI `v2.6.0`.* | +| operation | `string` | `yes` | A reference to the AsyncAPI [operation](https://www.asyncapi.com/docs/reference/specification/v3.0.0#operationObject) to call.
*Used only in case the referenced document uses AsyncAPI `v3.0.0`.* | +| server | [`asyncApiServer`](#asyncapi-server) | `no` | An object used to configure to the [server](https://www.asyncapi.com/docs/reference/specification/v3.0.0#serverObject) to call the specified AsyncAPI [operation](https://www.asyncapi.com/docs/reference/specification/v3.0.0#operationObject) on.
If not set, default to the first [server](https://www.asyncapi.com/docs/reference/specification/v3.0.0#serverObject) matching the operation's channel. | +| protocol | `string` | `no` | The [protocol](https://www.asyncapi.com/docs/reference/specification/v3.0.0#definitionsProtocol) to use to select the target [server](https://www.asyncapi.com/docs/reference/specification/v3.0.0#serverObject).
Ignored if `server` has been set.
*Supported values are: `amqp`, `amqp1`, `anypointmq`, `googlepubsub`, `http`, `ibmmq`, `jms`, `kafka`, `mercure`, `mqtt`, `mqtt5`, `nats`, `pulsar`, `redis`, `sns`, `solace`, `sqs`, `stomp` and `ws`* | +| message | [`asyncApiMessage`](#asyncapi-outbound-message) | `no` | An object used to configure the message to publish using the target operation.
*Required if `subscription` has not been set.* | +| subscription | [`asyncApiSubscription`](#asyncapi-subscription) | `no` | An object used to configure the subscription to messages consumed using the target operation.
*Required if `message` has not been set.* | +| authentication | `string`
[`authentication`](#authentication) | `no` | The authentication policy, or the name of the authentication policy, to use when calling the AsyncAPI operation. | + +###### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: asyncapi-example + version: '0.1.0' +do: + - publishGreetings: + call: asyncapi + with: + document: + endpoint: https://fake.com/docs/asyncapi.json + operation: greet + server: + name: greetingsServer + variables: + environment: dev + message: + payload: + greetings: Hello, World! + headers: + foo: bar + bar: baz + - subscribeToChatInbox: + call: asyncapi + with: + document: + endpoint: https://fake.com/docs/asyncapi.json + operation: chat-inbox + protocol: http + subscription: + filter: ${ . == $workflow.input.chat.roomId } + consume: + amount: 5 + for: + seconds: 10 +``` + +##### gRPC Call + +The [gRPC Call](#grpc-call) enables communication with external systems via the gRPC protocol, enabling efficient and reliable communication between distributed components. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| proto | [`externalResource`](#external-resource) | `yes` | The proto resource that describes the GRPC service to call. | +| service.name | `string` | `yes` | The name of the GRPC service to call. | +| service.host | `string` | `yes` | The hostname of the GRPC service to call. | +| service.port | `integer` | `no` | The port number of the GRPC service to call. | +| service.authentication | [`authentication`](#authentication) | `no` | The authentication policy, or the name of the authentication policy, to use when calling the GRPC service. | +| method | `string` | `yes` | The name of the GRPC service method to call. | +| arguments | `map` | `no` | A name/value mapping of the method call's arguments, if any. | + +###### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: grpc-example + version: '0.1.0' +do: + - greet: + call: grpc + with: + proto: + endpoint: file://app/greet.proto + service: + name: GreeterApi.Greeter + host: localhost + port: 5011 + method: SayHello + arguments: + name: ${ .user.preferredDisplayName } +``` + +##### HTTP Call + +The [HTTP Call](#http-call) enables workflows to interact with external services over HTTP. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| method | `string` | `yes` | The HTTP request method. | +| endpoint | `string`\|[`endpoint`](#endpoint) | `yes` | An URI or an object that describes the HTTP endpoint to call. | +| headers | `map` | `no` | A name/value mapping of the HTTP headers to use, if any. | +| body | `any` | `no` | The HTTP request body, if any. | +| query | `map[string, any]` | `no` | A name/value mapping of the query parameters to use, if any. | +| output | `string` | `no` | The http call's output format.
*Supported values are:*
*- `raw`, which output's the base-64 encoded [http response](#http-response) content, if any.*
*- `content`, which outputs the content of [http response](#http-response), possibly deserialized.*
*- `response`, which outputs the [http response](#http-response).*
*Defaults to `content`.* | +| redirect | `boolean` | `no` | Specifies whether redirection status codes (`300ā399`) should be treated as errors.
*If set to `false`, runtimes must raise an error for response status codes outside the `200ā299` range.*
*If set to `true`, they must raise an error for status codes outside the `200ā399` range.*
*Defaults to `false`.* | + +###### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: http-example + version: '0.1.0' +do: + - getPet: + call: http + with: + method: get + endpoint: https://petstore.swagger.io/v2/pet/{petId} +``` + +##### OpenAPI Call + +The [OpenAPI Call](#openapi-call) enables workflows to interact with external services described by [OpenAPI](https://www.openapis.org). + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| document | [`externalResource`](#external-resource) | `yes` | The OpenAPI document that defines the operation to call. | +| operationId | `string` | `yes` | The id of the OpenAPI operation to call. | +| parameters | `map` | `no` | A name/value mapping of the parameters, if any, of the OpenAPI operation to call. | +| authentication | [`authentication`](#authentication) | `no` | The authentication policy, or the name of the authentication policy, to use when calling the OpenAPI operation. | +| output | `string` | `no` | The OpenAPI call's output format.
*Supported values are:*
*- `raw`, which output's the base-64 encoded [http response](#http-response) content, if any.*
*- `content`, which outputs the content of [http response](#http-response), possibly deserialized.*
*- `response`, which outputs the [http response](#http-response).*
*Defaults to `content`.* | +| redirect | `boolean` | `no` | Specifies whether redirection status codes (`300ā399`) should be treated as errors.
*If set to `false`, runtimes must raise an error for response status codes outside the `200ā299` range.*
*If set to `true`, they must raise an error for status codes outside the `200ā399` range.*
*Defaults to `false`.* | + +###### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: openapi-example + version: '0.1.0' +do: + - findPet: + call: openapi + with: + document: + endpoint: https://petstore.swagger.io/v2/swagger.json + operationId: findPetsByStatus + parameters: + status: available +``` + +#### Do + +Serves as a fundamental building block within workflows, enabling the sequential execution of multiple subtasks. By defining a series of subtasks to perform in sequence, the Do task facilitates the efficient execution of complex operations, ensuring that each subtask is completed before the next one begins. + +##### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| do | [`map[string, task][]`](#task) | `no` | The tasks to perform sequentially. | + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: do-example + version: '0.1.0' +use: + authentications: + fake-booking-agency-oauth2: + oauth2: + authority: https://fake-booking-agency.com + grant: client_credentials + client: + id: serverless-workflow-runtime + secret: secret0123456789 +do: + - bookHotel: + call: http + with: + method: post + endpoint: + uri: https://fake-booking-agency.com/hotels/book + authentication: + use: fake-booking-agency-oauth2 + body: + name: Four Seasons + city: Antwerp + country: Belgium + - bookFlight: + call: http + with: + method: post + endpoint: + uri: https://fake-booking-agency.com/flights/book + authentication: + use: fake-booking-agency-oauth2 + body: + departure: + date: '01/01/26' + time: '07:25:00' + from: + airport: BRU + city: Zaventem + country: Belgium + arrival: + date: '01/01/26' + time: '11:12:00' + to: + airport: LIS + city: Lisbon + country: Portugal +``` + +#### Emit + +Allows workflows to publish events to event brokers or messaging systems, facilitating communication and coordination between different components and services. With the Emit task, workflows can seamlessly integrate with event-driven architectures, enabling real-time processing, event-driven decision-making, and reactive behavior based on incoming events. + +##### Properties + +| Name | Type | Required | Description | +|:--|:---:|:---:|:---| +| emit.event | [`eventProperties`](#event-properties) | `yes` | Defines the event to emit. | + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: emit-example + version: '0.1.0' +do: + - emitEvent: + emit: + event: + with: + source: https://petstore.com + type: com.petstore.order.placed.v1 + data: + client: + firstName: Cruella + lastName: de Vil + items: + - breed: dalmatian + quantity: 101 +``` + +#### For + +Allows workflows to iterate over a collection of items, executing a defined set of subtasks for each item in the collection. This task type is instrumental in handling scenarios such as batch processing, data transformation, and repetitive operations across datasets. + +##### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| for.each | `string` | `no` | The name of the variable used to store the current item being enumerated.
Defaults to `item`. | +| for.in | `string` | `yes` | A [runtime expression](dsl.md#runtime-expressions) used to get the collection to enumerate. | +| for.at | `string` | `no` | The name of the variable used to store the index of the current item being enumerated.
Defaults to `index`. | +| while | `string` | `no` | A [runtime expression](dsl.md#runtime-expressions) that represents the condition, if any, that must be met for the iteration to continue. | +| do | [`task`](#task) | `yes` | The task to perform for each item in the collection. | + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: for-example + version: '0.1.0' +do: + - checkup: + for: + each: pet + in: .pets + at: index + while: .vet != null + do: + - waitForCheckup: + listen: + to: + one: + with: + type: com.fake.petclinic.pets.checkup.completed.v2 + output: + as: '.pets + [{ "id": $pet.id }]' +``` + +#### Fork + +Allows workflows to execute multiple subtasks concurrently, enabling parallel processing and improving the overall efficiency of the workflow. By defining a set of subtasks to perform concurrently, the Fork task facilitates the execution of complex operations in parallel, ensuring that multiple tasks can be executed simultaneously. + +##### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| fork.branches | [`map[string, task][]`](#task) | `no` | The tasks to perform concurrently. | +| fork.compete | `boolean` | `no` | Indicates whether or not the concurrent [`tasks`](#task) are racing against each other, with a single possible winner, which sets the composite task's output.
*If set to `false`, the task returns an array that includes the outputs from each branch, preserving the order in which the branches are declared.*
*If to `true`, the task returns only the output of the winning branch.*
*Defaults to `false`.* | + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: fork-example + version: '0.1.0' +do: + - raiseAlarm: + fork: + compete: true + branches: + - callNurse: + call: http + with: + method: put + endpoint: https://fake-hospital.com/api/v3/alert/nurses + body: + patientId: ${ .patient.fullName } + room: ${ .room.number } + - callDoctor: + call: http + with: + method: put + endpoint: https://fake-hospital.com/api/v3/alert/doctor + body: + patientId: ${ .patient.fullName } + room: ${ .room.number } +``` + +#### Listen + +Provides a mechanism for workflows to await and react to external events, enabling event-driven behavior within workflow systems. + +##### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| listen.to | [`eventConsumptionStrategy`](#event-consumption-strategy) | `yes` | Configures the [event(s)](https://cloudevents.io/) the workflow must listen to. | +| listen.read | `string` | `no` | Specifies how [events](https://cloudevents.io/) are read during the listen operation.
*Supported values are:*
*- `data`: Reads the [event's](https://cloudevents.io/) data.*
*- `envelope`: Reads the [event's](https://cloudevents.io/) envelope, including its [context attributes](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#context-attributes).*
*- `raw`: Reads the [event's](https://cloudevents.io/) raw data.*
*Defaults to `data`.*| +| foreach | [`subscriptionIterator`](#subscription-iterator) | `no` | Configures the iterator, if any, for processing each consumed [event](https://cloudevents.io/). | + +> [!NOTE] +> A `listen` task produces a sequentially ordered array of all the [events](https://cloudevents.io/) it has consumed, and potentially transformed using `foreach.output.as`. + +> [!NOTE] +> When `foreach` is set, the configured operations for a [events](https://cloudevents.io/) must complete before moving on to the next one. As a result, consumed [events](https://cloudevents.io/) should be stored in a First-In-First-Out (FIFO) queue while awaiting iteration. + +> [!WARNING] +> [Events](https://cloudevents.io/) consumed by an `until` clause should not be included in the task's output. These [events](https://cloudevents.io/) are used solely to determine when the until condition has been met, and they do not contribute to the result or data produced by the task itself + + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: listen-example + version: '0.1.0' +do: + - callDoctor: + listen: + to: + any: + - with: + type: com.fake-hospital.vitals.measurements.temperature + data: ${ .temperature > 38 } + - with: + type: com.fake-hospital.vitals.measurements.bpm + data: ${ .bpm < 60 or .bpm > 100 } +``` + +#### Raise + +Intentionally triggers and propagates errors. By employing the "Raise" task, workflows can deliberately generate error conditions, allowing for explicit error handling and fault management strategies to be implemented. + +##### Properties + +| Name | Type | Required | Description | +|:--|:---:|:---:|:---| +| raise.error | `string`
[`error`](#error) | `yes` | Defines the [error](#error) to raise.
*If a `string`, must be the name of an [error](#error) defined in the [workflow's reusable components](#use).* | + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: raise-example + version: '0.1.0' +do: + - processTicket: + switch: + - highPriority: + when: .ticket.priority == "high" + then: escalateToManager + - mediumPriority: + when: .ticket.priority == "medium" + then: assignToSpecialist + - lowPriority: + when: .ticket.priority == "low" + then: resolveTicket + - default: + then: raiseUndefinedPriorityError + - raiseUndefinedPriorityError: + raise: + error: + type: https://fake.com/errors/tickets/undefined-priority + status: 400 + instance: /raiseUndefinedPriorityError + title: Undefined Priority + - escalateToManager: + call: http + with: + method: post + endpoint: https://fake-ticketing-system.com/tickets/escalate + body: + ticketId: ${ .ticket.id } + - assignToSpecialist: + call: http + with: + method: post + endpoint: https://fake-ticketing-system.com/tickets/assign + body: + ticketId: ${ .ticket.id } + - resolveTicket: + call: http + with: + method: post + endpoint: https://fake-ticketing-system.com/tickets/resolve + body: + ticketId: ${ .ticket.id } +``` + +#### Run + +Provides the capability to execute external [containers](#container-process), [shell commands](#shell-process), [scripts](#script-process), or [workflows](#workflow-process). + +##### Properties + +| Name | Type | Required | Description | +|:--|:---:|:---:|:---| +| run.container | [`container`](#container-process) | `no` | The definition of the container to run.
*Required if `script`, `shell` and `workflow` have not been set.* | +| run.script | [`script`](#script-process) | `no` | The definition of the script to run.
*Required if `container`, `shell` and `workflow` have not been set.* | +| run.shell | [`shell`](#shell-process) | `no` | The definition of the shell command to run.
*Required if `container`, `script` and `workflow` have not been set.* | +| run.workflow | [`workflow`](#workflow-process) | `no` | The definition of the workflow to run.
*Required if `container`, `script` and `shell` have not been set.* | +| await | `boolean` | `no` | Determines whether or not the process to run should be awaited for.
*When set to `false`, the task cannot wait for the process to complete and thus cannot output the processās result. In this case, it should simply output its transformed input.*
*Defaults to `true`.* | +| return | `string` | `no` | Configures the output of the process.
*Supported values are:*
*- `stdout`: Outputs the content of the process **STDOUT**.*
*- `stderr`: Outputs the content of the process **STDERR**.*
*- `code`: Outputs the process's **exit code**.*
*- `all`: Outputs the **exit code**, the **STDOUT** content and the **STDERR** content, wrapped into a new [processResult](#process-result) object.*
*- `none`: Does not output anything.*
*Defaults to `stdout`.* | + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: run-example + version: '0.1.0' +do: + - runContainer: + run: + container: + image: fake-image + + - runScript: + run: + script: + language: js + code: > + Some cool multiline script + + - runShell: + run: + shell: + command: 'echo "Hello, ${ .user.name }"' + + - runWorkflow: + run: + workflow: + namespace: another-one + name: do-stuff + version: '0.1.0' + input: {} +``` + +##### Container Process + +Enables the execution of external processes encapsulated within a containerized environment, allowing workflows to interact with and execute complex operations using containerized applications, scripts, or commands. + +###### Properties + +| Name | Type | Required | Description | +|:--|:---:|:---:|:---| +| image | `string` | `yes` | The name of the container image to run | +| name | `string` | `no` | A [runtime expression](dsl.md#runtime-expressions), if any, used to give specific name to the container. | +| command | `string` | `no` | The command, if any, to execute on the container | +| ports | `map` | `no` | The container's port mappings, if any | +| volumes | `map` | `no` | The container's volume mappings, if any | +| environment | `map` | `no` | A key/value mapping of the environment variables, if any, to use when running the configured process | +| lifetime | [`containerLifetime`](#container-lifetime) | `no` | An object used to configure the container's lifetime. | + +###### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: run-container-example + version: '0.1.0' +do: + - runContainer: + run: + container: + image: fake-image +``` + +> [!NOTE] +> When a `container process` is executed, runtime implementations are recommended to follow a predictable naming convention for the container name. This can improve monitoring, logging, and container lifecycle management. +> +> The Serverless Workflow specification recommends using the following convention: `{workflow.name}-{uuid}.{workflow.namespace}-{task.name}` + +##### Script Process + +Enables the execution of custom scripts or code within a workflow, empowering workflows to perform specialized logic, data processing, or integration tasks by executing user-defined scripts written in various programming languages. + +###### Properties + +| Name | Type | Required | Description | +|:--|:---:|:---:|:---| +| language | `string` | `yes` | The language of the script to run.
*Supported values are: [`js`](https://tc39.es/ecma262/2024/) and [`python`](https://www.python.org/downloads/release/python-3131/).* | +| code | `string` | `no` | The script's code.
*Required if `source` has not been set.* | +| source | [externalResource](#external-resource) | `no` | The script's resource.
*Required if `code` has not been set.* | +| arguments | `map` | `no` | A list of the arguments, if any, of the script to run | +| environment | `map` | `no` | A key/value mapping of the environment variables, if any, to use when running the configured script process | + +> [!WARNING] +> To ensure cross-compatibility, Serverless Workflow strictly limits the versions of supported scripting languages. These versions may evolve with future releases. If you wish to use a different version of a language, you may do so by utilizing the [`container process`](#container-process). + +**Supported languages** +| Language | Version | +|:-----------|:---------:| +| `JavaScript` | [`ES2024`](https://tc39.es/ecma262/2024/) | +| `Python` | [`3.13.x`](https://www.python.org/downloads/release/python-3131/) | + +###### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: run-script-example + version: '0.1.0' +do: + - runScript: + run: + script: + language: js + arguments: + greetings: Hello, world! + code: > + console.log(greetings) +``` + +##### Shell Process + +Enables the execution of shell commands within a workflow, enabling workflows to interact with the underlying operating system and perform system-level operations, such as file manipulation, environment configuration, or system administration tasks. + +###### Properties + +| Name | Type | Required | Description | +|:--|:---:|:---:|:---| +| command | `string` | `yes` | The shell command to run | +| arguments | `map` | `no` | A list of the arguments of the shell command to run | +| environment | `map` | `no` | A key/value mapping of the environment variables, if any, to use when running the configured process | + +###### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: run-shell-example + version: '0.1.0' +do: + - runShell: + run: + shell: + command: 'echo "Hello, ${ .user.name }"' +``` + +##### Workflow Process + +Enables the invocation and execution of nested workflows within a parent workflow, facilitating modularization, reusability, and abstraction of complex logic or business processes by encapsulating them into standalone workflow units. + +###### Properties + +| Name | Type | Required | Description | +|:--|:---:|:---:|:---| +| name | `string` | `yes` | The name of the workflow to run | +| version | `string` | `yes` | The version of the workflow to run. Defaults to `latest` | +| input | `any` | `no` | The data, if any, to pass as input to the workflow to execute. The value should be validated against the target workflow's input schema, if specified | + +###### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: run-workflow-example + version: '0.1.0' +do: + - startWorkflow: + run: + workflow: + namespace: another-one + name: do-stuff + version: '0.1.0' + input: + foo: bar +``` + +#### Set + +A task used to set data. + +##### Properties + +| Name | Type | Required | Description | +|:--|:---:|:---:|:---| +| set | `object` | `yes` | A name/value mapping of the data to set. | + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: default + name: set-example + version: '0.1.0' +do: + - setShape: + set: + shape: circle + size: ${ .configuration.size } + fill: ${ .configuration.fill } +``` + +#### Switch + +Enables conditional branching within workflows, allowing them to dynamically select different paths based on specified conditions or criteria + +##### Properties + +| Name | Type | Required | Description | +|:--|:---:|:---:|:---| +| switch | [`case[]`](#switch-case) | `yes` | A name/value map of the cases to switch on | + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: switch-example + version: '0.1.0' +do: + - processOrder: + switch: + - case1: + when: .orderType == "electronic" + then: processElectronicOrder + - case2: + when: .orderType == "physical" + then: processPhysicalOrder + - default: + then: handleUnknownOrderType + - processElectronicOrder: + do: + - validatePayment: + call: http + with: + method: post + endpoint: https://fake-payment-service.com/validate + - fulfillOrder: + call: http + with: + method: post + endpoint: https://fake-fulfillment-service.com/fulfill + then: exit + - processPhysicalOrder: + do: + - checkInventory: + call: http + with: + method: get + endpoint: https://fake-inventory-service.com/inventory + - packItems: + call: http + with: + method: post + endpoint: https://fake-packaging-service.com/pack + - scheduleShipping: + call: http + with: + method: post + endpoint: https://fake-shipping-service.com/schedule + then: exit + - handleUnknownOrderType: + do: + - logWarning: + call: http + with: + method: post + endpoint: https://fake-logging-service.com/warn + - notifyAdmin: + call: http + with: + method: post + endpoint: https://fake-notification-service.com/notify +``` + +##### Switch Case + +Defines a switch case, encompassing a condition for matching and an associated action to execute upon a match. + +| Name | Type | Required | Description | +|:--|:---:|:---:|:---| +| when | `string` | `no` | A runtime expression used to determine whether or not the case matches.
*If not set, the case will be matched by default if no other case match.*
*Note that there can be only one default case, all others **MUST** set a condition.* +| then | [`flowDirective`](#flow-directive) | `yes` | The flow directive to execute when the case matches. | + +#### Try + +Serves as a mechanism within workflows to handle errors gracefully, potentially retrying failed tasks before proceeding with alternate ones. + +##### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| try | [`map[string, task][]`](#task) | `yes` | The task(s) to perform. | +| catch | [`catch`](#catch) | `yes` | Configures the errors to catch and how to handle them. | + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: try-example + version: '0.1.0' +do: + - trySomething: + try: + - invalidHttpCall: + call: http + with: + method: get + endpoint: https:// + catch: + errors: + with: + type: https://serverlessworkflow.io.io/dsl/errors/types/communication + status: 503 + as: error + retry: + delay: + seconds: 3 + backoff: + exponential: {} + limit: + attempt: + count: 5 +``` + +##### Catch + +Defines the configuration of a catch clause, which a concept used to catch errors. + +###### Properties + +| Name | Type | Required | Description | +|:--|:---:|:---:|:---| +| errors | [`errorFilter`](#retry) | `no` | The definition of the errors to catch. | +| as | `string` | `no` | The name of the runtime expression variable to save the error as. Defaults to 'error'. | +| when | `string`| `no` | A runtime expression used to determine whether or not to catch the filtered error. | +| exceptWhen | `string` | `no` | A runtime expression used to determine whether or not to catch the filtered error. | +| retry | `string`
[`retryPolicy`](#retry) | `no` | The [`retry policy`](#retry) to use, if any, when catching [`errors`](#error).
*If a `string`, must be the name of a [retry policy](#retry) defined in the [workflow's reusable components](#use).* | +| do | [`map[string, task][]`](#task) | `no` | The definition of the task(s) to run when catching an error. | + +#### Wait + +Allows workflows to pause or delay their execution for a specified period of time. + +##### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| wait | `string`
[`duration`](#duration) | `yes` | The amount of time to wait.
If a `string`, must be a valid [ISO 8601](#) duration expression. | + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: wait-example + version: '0.1.0' +do: + - waitAWhile: + wait: + seconds: 10 +``` + +### Flow Directive + +Flow Directives are commands within a workflow that dictate its progression. + +| Directive | Description | +| --------- | ----------- | +| `"continue"` | Instructs the workflow to proceed with the next task in line. This action may conclude the execution of a particular workflow or branch if there are not task defined after the continue one. | +| `"exit"` | Halts the current branch's execution, potentially terminating the entire workflow if the current task resides within the main branch. | +| `"end"` | Provides a graceful conclusion to the workflow execution, signaling its completion explicitly. | +| `string` | Continues the workflow at the task with the specified name | + +### Lifecycle Events + +Lifecycle events are [cloud events](https://github.com/cloudevents/spec) used to notify users and external services about key state changes in workflows and tasks. + +#### Workflow Lifecycle Events + +##### Workflow Started Event + +The data carried by the cloud event that notifies that a workflow has started. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| name | `string` | `yes` | The qualified name of the workflow that has started. | +| definition | [`workflowDefinitionReference`](#workflow-definition-reference) | `yes` | An object that describes the definition of the workflow that has started. | +| startedAt | `dateTime` | `yes` | The date and time at which the workflow has started. | + +###### Examples + +```yaml +name: orderPetWorkflow-ix7iryakiem8j.samples +definition: + name: orderPetWorkflow + namespace: samples + version: '1.0.0' +startedAt: '2024-07-26T16:59:57-05:00' +``` + +##### Workflow Suspended Event + +The data carried by the cloud event that notifies that the execution of a workflow has been suspended. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| name | `string` | `yes` | The qualified name of the workflow that has been suspended. | +| suspendedAt | `dateTime` | `yes` | The date and time at which the workflow has been suspended. | + +###### Examples + +```yaml +name: orderPetWorkflow-ix7iryakiem8j.samples +suspendedAt: '2024-07-26T16:59:57-05:00' +``` + +##### Workflow Resumed Event + +The data carried by the cloud event that notifies that notifies that a workflow has been resumed. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| name | `string` | `yes` | The qualified name of the workflow that has been resumed. | +| resumedAt | `dateTime` | `yes` | The date and time at which the workflow has been resumed. | + +###### Examples + +```yaml +name: orderPetWorkflow-ix7iryakiem8j.samples +resumedAt: '2024-07-26T16:59:57-05:00' +``` + +##### Workflow Correlation Started Event + +The data carried by the cloud event that notifies that a workflow has started correlating events. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| name | `string` | `yes` | The qualified name of the workflow that has started correlating events. | +| startedAt | `dateTime` | `yes` | The date and time at which the workflow has started correlating events. | + +###### Examples + +```yaml +name: orderPetWorkflow-ix7iryakiem8j.samples +startedAt: '2024-07-26T16:59:57-05:00' +``` + +##### Workflow Correlation Completed Event + +The data carried by the cloud event that notifies that a workflow has completed correlating events. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| name | `string` | `yes` | The qualified name of the workflow that has completed correlating events. | +| completedAt | `dateTime` | `yes` | The date and time at which the workflow has completed correlating events. | +| correlationKeys | `map` | `no` | A key/value mapping, if any, of the resolved correlation keys. | + +###### Examples + +```yaml +name: orderPetWorkflow-ix7iryakiem8j.samples +completedAt: '2024-07-26T16:59:57-05:00' +correlationKeys: + petId: xt84hj202q14s + orderId: '0a7f8581-acb9-4133-a378-0460c98ea60c' +``` + +##### Workflow Cancelled Event + +The data carried by the cloud event that notifies that a workflow has been cancelled. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| name | `string` | `yes` | The qualified name of the workflow that has been cancelled. | +| cancelledAt | `dateTime` | `yes` | The date and time at which the workflow has been cancelled. | + +###### Examples + +```yaml +name: orderPetWorkflow-ix7iryakiem8j.samples +cancelledAt: '2024-07-26T16:59:57-05:00' +``` + +##### Workflow Faulted Event + +The data carried by the cloud event that notifies that a workflow has faulted. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| name | `string` | `yes` | The qualified name of the workflow that has faulted. | +| faultedAt | `dateTime` | `yes` | The date and time at which the workflow has faulted. | +| error | [`error`](#error) | `yes` | The error that has cause the workflow to fault. | + +###### Examples + +```yaml +name: orderPetWorkflow-ix7iryakiem8j.samples +faultedAt: '2024-07-26T16:59:57-05:00' +error: + type: https://serverlessworkflow.io/spec/1.0.0/errors/communication + title: Service Not Available + status: 503 +``` + +##### Workflow Completed Event + +The data carried by the cloud event that notifies that a workflow ran to completion. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| name | `string` | `yes` | The qualified name of the workflow ran to completion. | +| completedAt | `dateTime` | `yes` | The date and time at which the workflow ran to completion. | +| output | `map` | `no` | The workflow's output, if any. | + +###### Examples + +```yaml +name: orderPetWorkflow-ix7iryakiem8j.samples +completedAt: '2024-07-26T16:59:57-05:00' +output: + orderId: '0a7f8581-acb9-4133-a378-0460c98ea60c' + petId: xt84hj202q14s + status: placed +``` + +##### Workflow Status Changed Event + +The data carried by the cloud event that notifies that the status phase of a workflow has changed. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| name | `string` | `yes` | The qualified name of the workflow which's status phase has changed. | +| updatedAt | `dateTime` | `yes` | The date and time at which the workflow's status phase has changed. | +| status | `string` | The workflow's current [status phase](https://github.com/serverlessworkflow/specification/blob/main/dsl.md#status-phases). | + +###### Examples + +```yaml +name: orderPetWorkflow-ix7iryakiem8j.samples +updatedAt: '2024-07-26T16:59:57-05:00' +status: completed +``` + +#### Task Lifecycle Events + +##### Task Created Event + +The data carried by the cloud event that notifies that a task has been created. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| workflow | `string` | `yes` | The qualified name of the workflow the task that has been created belongs to. | +| task | `uri` | `yes` | A JSON Pointer that references the task that has been created. | +| createdAt | `dateTime` | `yes` | The date and time at which the task has been created. | + +###### Examples + +```yaml +workflow: orderPetWorkflow-ix7iryakiem8j.samples +task: '/do/1/initialize' +createdAt: '2024-07-26T16:59:57-05:00' +``` + +##### Task Started Event + +The data carried by the cloud event that notifies that a task has started. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| workflow | `string` | `yes` | The qualified name of the workflow the task that has started belongs to. | +| task | `uri` | `yes` | A JSON Pointer that references the task that has started. | +| startedAt | `dateTime` | `yes` | The date and time at which the task has started. | + +###### Examples + +```yaml +workflow: orderPetWorkflow-ix7iryakiem8j.samples +task: '/do/1/initialize' +startedAt: '2024-07-26T16:59:57-05:00' +``` + +##### Task Suspended Event + +The data carried by the cloud event that notifies that the execution of a task has been suspended. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| workflow | `string` | `yes` | The qualified name of the workflow the task that has been suspended belongs to. | +| task | `uri` | `yes` | A JSON Pointer that references the task that has been suspended. | +| suspendedAt | `dateTime` | `yes` | The date and time at which the task has been suspended. | + +###### Examples + +```yaml +workflow: orderPetWorkflow-ix7iryakiem8j.samples +task: '/do/1/initialize' +suspendedAt: '2024-07-26T16:59:57-05:00' +``` + +##### Task Resumed Event + +The data carried by the cloud event that notifies that notifies that a task has been resumed. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| workflow | `string` | `yes` | The qualified name of the workflow the task that has been resumed belongs to. | +| task | `uri` | `yes` | A JSON Pointer that references the task that has been resumed. | +| resumedAt | `dateTime` | `yes` | The date and time at which the task has been resumed. | + +###### Examples + +```yaml +workflow: orderPetWorkflow-ix7iryakiem8j.samples +task: '/do/1/initialize' +resumedAt: '2024-07-26T16:59:57-05:00' +``` + +##### Task Retried Event + +The data carried by the cloud event that notifies that notifies that a task is being retried. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| workflow | `string` | `yes` | The qualified name of the workflow the task that is being retried belongs to. | +| task | `uri` | `yes` | A JSON Pointer that references the task that is being retried. | +| retriedAt | `dateTime` | `yes` | The date and time at which the task has been retried. | + +###### Examples + +```yaml +workflow: orderPetWorkflow-ix7iryakiem8j.samples +task: '/do/1/initialize' +retriedAt: '2024-07-26T16:59:57-05:00' +``` + +##### Task Cancelled Event + +The data carried by the cloud event that notifies that a task has been cancelled. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| workflow | `string` | `yes` | The qualified name of the workflow the task that has been cancelled belongs to. | +| task | `uri` | `yes` | A JSON Pointer that references the task that has been cancelled. | +| cancelledAt | `dateTime` | `yes` | The date and time at which the task has been cancelled. | + +###### Examples + +```yaml +workflow: orderPetWorkflow-ix7iryakiem8j.samples +task: '/do/1/initialize' +cancelledAt: '2024-07-26T16:59:57-05:00' +``` + +##### Task Faulted Event + +The data carried by the cloud event that notifies that a task has been faulted. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| workflow | `string` | `yes` | The qualified name of the workflow the task that has faulted belongs to. | +| task | `uri` | `yes` | A JSON Pointer that references the task that has faulted. | +| faultedAt | `dateTime` | `yes` | The date and time at which the task has faulted. | +| error | [`error`](#error) | `yes` | The error that has cause the task to fault. | + +###### Examples + +```yaml +workflow: orderPetWorkflow-ix7iryakiem8j.samples +task: '/do/1/initialize' +faultedAt: '2024-07-26T16:59:57-05:00' +error: + type: https://serverlessworkflow.io/spec/1.0.0/errors/communication + title: Service Not Available + status: 503 +``` + +##### Task Completed Event + +The data carried by the cloud event that notifies that a task ran to completion. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| workflow | `string` | `yes` | The qualified name of the workflow the task that ran to completion belongs to. | +| task | `uri` | `yes` | A JSON Pointer that references the task that ran to completion. | +| completedAt | `dateTime` | `yes` | The date and time at which the task ran to completion. | +| output | `map` | `no` | The task's output, if any. | + +###### Examples + +```yaml +workflow: orderPetWorkflow-ix7iryakiem8j.samples +task: '/do/1/initialize' +completedAt: '2024-07-26T16:59:57-05:00' +output: + orderId: '0a7f8581-acb9-4133-a378-0460c98ea60c' + petId: xt84hj202q14s + status: placed +``` + +##### Task Status Changed Event + +The data carried by the cloud event that notifies that the status phase of a task has changed. + +###### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| workflow | `string` | `yes` | The qualified name of the workflow the task which's status phase has changed belongs to. | +| task | `uri` | `yes` | A JSON Pointer that references the task which's status phase has changed. | +| updatedAt | `dateTime` | `yes` | The date and time at which the task's status phase has changed. | +| status | `string` | The task's current [status phase](https://github.com/serverlessworkflow/specification/blob/main/dsl.md#status-phases). | + +###### Examples + +```yaml +workflow: orderPetWorkflow-ix7iryakiem8j.samples +task: '/do/1/initialize' +updatedAt: '2024-07-26T16:59:57-05:00' +status: completed +``` + +> [!WARNING] +> Flow directives may only redirect to tasks declared within their own scope. In other words, they cannot target tasks at a different depth. + +### External Resource + +Defines an external resource. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| name | `string` | `no` | The name, if any, of the defined resource. | +| endpoint | [`endpoint`](#endpoint) | `yes` | The endpoint at which to get the defined resource. | + +##### Examples + +```yaml +name: sample-resource +endpoint: + uri: https://fake.com/resource/0123 + authentication: + basic: + username: admin + password: 1234 +``` + +### Authentication + +Defines the mechanism used to authenticate users and workflows attempting to access a service or a resource. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| use | `string` | `no` | The name of the top-level authentication definition to use. Cannot be used by authentication definitions defined at top level. | +| basic | [`basicAuthentication`](#basic-authentication) | `no` | The `basic` authentication scheme to use, if any.
Required if no other property has been set, otherwise ignored. | +| bearer | [`bearerAuthentication`](#bearer-authentication) | `no` | The `bearer` authentication scheme to use, if any.
Required if no other property has been set, otherwise ignored. | +| certificate | [`certificateAuthentication`](#certificate-authentication) | `no` | The `certificate` authentication scheme to use, if any.
Required if no other property has been set, otherwise ignored. | +| digest | [`digestAuthentication`](#digest-authentication) | `no` | The `digest` authentication scheme to use, if any.
Required if no other property has been set, otherwise ignored. | +| oauth2 | [`oauth2`](#oauth2-authentication) | `no` | The `oauth2` authentication scheme to use, if any.
Required if no other property has been set, otherwise ignored. | +| oidc | [`oidc`](#openidconnect-authentication) | `no` | The `oidc` authentication scheme to use, if any.
Required if no other property has been set, otherwise ignored. | + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: authentication-example + version: '0.1.0' +use: + secrets: + - usernamePasswordSecret + authentications: + sampleBasicFromSecret: + basic: + use: usernamePasswordSecret +do: + - sampleTask: + call: http + with: + method: get + endpoint: + uri: https://secured.fake.com/sample + authentication: + use: sampleBasicFromSecret +``` + +#### Basic Authentication + +Defines the fundamentals of a 'basic' authentication. + +##### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| username | `string` | `yes` | The username to use. | +| password | `string` | `yes` | The password to use. | + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: basic-authentication-example + version: '0.1.0' +use: + authentications: + sampleBasic: + basic: + username: admin + password: password123 +do: + - sampleTask: + call: http + with: + method: get + endpoint: + uri: https://secured.fake.com/sample + authentication: + use: sampleBasic +``` + +#### Bearer Authentication + +Defines the fundamentals of a 'bearer' authentication + +##### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| token | `string` | `yes` | The bearer token to use. | + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: bearer-authentication-example + version: '0.1.0' +do: + - sampleTask: + call: http + with: + method: get + endpoint: + uri: https://secured.fake.com/sample + authentication: + bearer: + token: ${ .user.token } +``` + +#### Certificate Authentication + + +#### Digest Authentication + +Defines the fundamentals of a 'digest' authentication. + +##### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| username | `string` | `yes` | The username to use. | +| password | `string` | `yes` | The password to use. | + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: digest-authentication-example + version: '0.1.0' +use: + authentications: + sampleDigest: + digest: + username: admin + password: password123 +do: + - sampleTask: + call: http + with: + method: get + endpoint: + uri: https://secured.fake.com/sample + authentication: + use: sampleDigest +``` + +#### OAUTH2 Authentication + +Defines the fundamentals of an 'oauth2' authentication. + +##### Properties + +| Name | Type | Required | Description | +|:-----|:----:|:--------:|:------------| +| authority | `uri-template` | `yes` | The URI that references the authority to use when making OAuth2 calls. | +| endpoints.token | `uri-template` | `no` | The relative path to the endpoint for OAuth2 token requests.
Defaults to `/oauth2/token`. | +| endpoints.revocation | `uri-template` | `no` | The relative path to the endpoint used to invalidate tokens.
Defaults to `/oauth2/revoke`. | +| endpoints.introspection | `uri-template` | `no` | The relative path to the endpoint used to validate and obtain information about a token, typically to check its validity and associated metadata.
Defaults to `/oauth2/introspect`. | +| grant | `string` | `yes` | The grant type to use.
Supported values are `authorization_code`, `client_credentials`, `password`, `refresh_token` and `urn:ietf:params:oauth:grant-type:token-exchange`. | +| client.id | `string` | `no` | The client id to use.
Required if the `client.authentication` method has **not** been set to `none`. | +| client.secret | `string` | `no` | The client secret to use, if any. | +| client.assertion | `string` | `no` | A JWT containing a signed assertion with your application credentials.
Required when `client.authentication` has been set to `private_key_jwt`. | +| client.authentication | `string` | `no` | The client authentication method to use.
Supported values are `client_secret_basic`, `client_secret_post`, `client_secret_jwt`, `private_key_jwt` or `none`.
Defaults to `client_secret_post`. | +| request.encoding | `string` | `no` | The encoding of the token request.
Supported values are `application/x-www-form-urlencoded` and `application/json`.
Defaults to application/x-www-form-urlencoded. | +| issuers | `uri-template[]` | `no` | A list that contains that contains valid issuers that will be used to check against the issuer of generated tokens. | +| scopes | `string[]` | `no` | The scopes, if any, to request the token for. | +| audiences | `string[]` | `no` | The audiences, if any, to request the token for. | +| username | `string` | `no` | The username to use. Used only if the grant type is `Password`. | +| password | `string` | `no` | The password to use. Used only if the grant type is `Password`. | +| subject | [`oauth2Token`](#oauth2-token) | `no` | The security token that represents the identity of the party on behalf of whom the request is being made. | +| actor | [`oauth2Token`](#oauth2-token) | `no` | The security token that represents the identity of the acting party. | + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: oauth2-authentication-example + version: '0.1.0' +do: + - sampleTask: + call: http + with: + method: get + endpoint: + uri: https://secured.fake.com/sample + authentication: + oauth2: + authority: http://keycloak/realms/fake-authority + endpoints: + token: /oauth2/token + grant: client_credentials + client: + id: workflow-runtime + secret: "**********" + scopes: [ api ] + audiences: [ runtime ] +``` + +##### OAUTH2 Token + +Represents the definition of an OAUTH2 token + +###### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| token | `string` | `yes` | The security token to use to use. | +| type | `string` | `yes` | The type of security token to use. | + +#### OpenIdConnect Authentication + +Defines the fundamentals of an 'oidc' authentication. + +##### Properties + +| Name | Type | Required | Description | +|:-----|:----:|:--------:|:------------| +| authority | `uri-template` | `yes` | The URI that references the authority to use when making OpenIdConnect calls. | +| grant | `string` | `yes` | The grant type to use.
Supported values are `authorization_code`, `client_credentials`, `password`, `refresh_token` and `urn:ietf:params:oauth:grant-type:token-exchange`. | +| client.id | `string` | `no` | The client id to use.
Required if the `client.authentication` method has **not** been set to `none`. | +| client.secret | `string` | `no` | The client secret to use, if any. | +| client.assertion | `string` | `no` | A JWT containing a signed assertion with your application credentials.
Required when `client.authentication` has been set to `private_key_jwt`. | +| client.authentication | `string` | `no` | The client authentication method to use.
Supported values are `client_secret_basic`, `client_secret_post`, `client_secret_jwt`, `private_key_jwt` or `none`.
Defaults to `client_secret_post`. | +| request.encoding | `string` | `no` | The encoding of the token request.
Supported values are `application/x-www-form-urlencoded` and `application/json`.
Defaults to application/x-www-form-urlencoded. | +| issuers | `uri-template[]` | `no` | A list that contains that contains valid issuers that will be used to check against the issuer of generated tokens. | +| scopes | `string[]` | `no` | The scopes, if any, to request the token for. | +| audiences | `string[]` | `no` | The audiences, if any, to request the token for. | +| username | `string` | `no` | The username to use. Used only if the grant type is `Password`. | +| password | `string` | `no` | The password to use. Used only if the grant type is `Password`. | +| subject | [`oauth2Token`](#oauth2-token) | `no` | The security token that represents the identity of the party on behalf of whom the request is being made. | +| actor | [`oauth2Token`](#oauth2-token) | `no` | The security token that represents the identity of the acting party. | + +##### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: oidc-authentication-example + version: '0.1.0' +do: + - sampleTask: + call: http + with: + method: get + endpoint: + uri: https://secured.fake.com/sample + authentication: + oidc: + authority: http://keycloak/realms/fake-authority/.well-known/openid-configuration + grant: client_credentials + client: + id: workflow-runtime + secret: "**********" + scopes: [ api ] + audiences: [ runtime ] +``` + +### Catalog + +A **resource catalog** is an external collection of reusable components, such as functions, that can be referenced and imported into workflows. Catalogs allow workflows to integrate with externally defined resources, making it easier to manage reuse and versioning across different workflows. + +Each catalog is defined by an `endpoint` property, specifying the root URL where the resources are hosted, enabling workflows to access external functions and services. For portability, catalogs must adhere to a specific file structure, as defined [here](https://github.com/serverlessworkflow/catalog?tab=readme-ov-file#structure). + +For more information about catalogs, refer to the [Serverless Workflow DSL document](https://github.com/serverlessworkflow/specification/blob/main/dsl.md#catalogs). + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| endpoint | [`endpoint`](#endpoint) | `yes` | The endpoint that defines the root URL at which the catalog is located. | + +#### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: catalog-example + version: '0.1.0' +use: + catalogs: + global: + endpoint: + uri: https://github.com/serverlessworkflow/catalog + authentication: + basic: + username: user + password: '012345' +do: + - log: + call: log:0.5.2@global + with: + message: The cataloged custom function has been successfully called +``` + +### Extension + +Holds the definition for extending functionality, providing configuration options for how an extension extends and interacts with other components. + +Extensions enable the execution of tasks prior to those they extend, offering the flexibility to potentially bypass the extended task entirely using an [`exit` workflow directive](#flow-directive). + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| extend | `string` | `yes` | The type of task to extend
Supported values are: `call`, `composite`, `emit`, `extension`, `for`, `listen`, `raise`, `run`, `set`, `switch`, `try`, `wait` and `all` | +| when | `string` | `no` | A runtime expression used to determine whether or not the extension should apply in the specified context | +| before | [`map[string, task][]`](#task) | `no` | The task to execute, if any, before the extended task | +| after | [`map[string, task][]`](#task) | `no` | The task to execute, if any, after the extended task | + +#### Examples + +*Perform logging before and after any non-extension task is run:* +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: logging-extension-example + version: '0.1.0' +use: + extensions: + - logging: + extend: all + before: + - sendLog: + call: http + with: + method: post + endpoint: https://fake.log.collector.com + body: + message: ${ "Executing task '\($task.reference)'..." } + after: + - sendLog: + call: http + with: + method: post + endpoint: https://fake.log.collector.com + body: + message: ${ "Executed task '\($task.reference)'..." } +do: + - sampleTask: + call: http + with: + method: get + endpoint: https://fake.com/sample +``` + +*Intercept HTTP calls to 'https://mocked.service.com' and mock its response:* +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: intercept-extension-example + version: '0.1.0' +use: + extensions: + - mockService: + extend: call + when: $task.call == "http" and ($task.with.uri != null and ($task.with.uri | startswith("https://mocked.service.com"))) or ($task.with.endpoint.uri != null and ($task.with.endpoint.uri | startswith("https://mocked.service.com"))) + before: + - intercept: + set: + statusCode: 200 + headers: + Content-Type: application/json + content: + foo: + bar: baz + then: exit #using this, we indicate to the workflow we want to exit the extended task, thus just returning what we injected +do: + - sampleTask: + call: http + with: + method: get + endpoint: https://fake.com/sample +``` + +### Error + +Defines the [Problem Details RFC](https://datatracker.ietf.org/doc/html/rfc7807) compliant description of an error. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| type | [`uri-template`](#uri-template) | `yes` | A URI reference that identifies the [`error`](#error) type.
For cross-compatibility concerns, it is strongly recommended to use [Standard Error Types](#standard-error-types) whenever possible.
Runtimes **MUST** ensure that the property has been set when raising or escalating the [`error`](#error). | +| status | `integer` | `yes` | The status code generated by the origin for this occurrence of the [`error`](#error).
For cross-compatibility concerns, it is strongly recommended to use [HTTP Status Codes](https://datatracker.ietf.org/doc/html/rfc7231#section-6) whenever possible.
Runtimes **MUST** ensure that the property has been set when raising or escalating the [`error`](#error). | +| instance | `string` | `no` | A [JSON Pointer](https://datatracker.ietf.org/doc/html/rfc6901) used to reference the component the [`error`](#error) originates from.
Runtimes **MUST** set the property when raising or escalating the [`error`](#error). Otherwise ignore. | +| title | `string` | `no` | A short, human-readable summary of the [`error`](#error). | +| detail | `string` | `no` | A human-readable explanation specific to this occurrence of the [`error`](#error). | + +#### Examples + +```yaml +type: https://serverlessworkflow.io/spec/1.0.0/errors/communication +title: Service Not Available +status: 503 +``` + +#### Standard Error Types + +Standard error types serve the purpose of categorizing errors consistently across different runtimes, facilitating seamless migration from one runtime environment to another. + +| Type | StatusĀ¹ | Description | +|------|:-------:|-------------| +| [https://serverlessworkflow.io/spec/1.0.0/errors/configuration](#) | `400` | Errors resulting from incorrect or invalid configuration settings, such as missing or misconfigured environment variables, incorrect parameter values, or configuration file errors. | +| [https://serverlessworkflow.io/spec/1.0.0/errors/validation](#) | `400` | Errors arising from validation processes, such as validation of input data, schema validation failures, or validation constraints not being met. These errors indicate that the provided data or configuration does not adhere to the expected format or requirements specified by the workflow. | +| [https://serverlessworkflow.io/spec/1.0.0/errors/expression](#) | `400` | Errors occurring during the evaluation of runtime expressions, such as invalid syntax or unsupported operations. | +| [https://serverlessworkflow.io/spec/1.0.0/errors/authentication](#) | `401` | Errors related to authentication failures. | +| [https://serverlessworkflow.io/spec/1.0.0/errors/authorization](#) | `403` | Errors related to unauthorized access attempts or insufficient permissions to perform certain actions within the workflow. | +| [https://serverlessworkflow.io/spec/1.0.0/errors/timeout](#) | `408` | Errors caused by timeouts during the execution of tasks or during interactions with external services. | +| [https://serverlessworkflow.io/spec/1.0.0/errors/communication](#) | `500` | Errors encountered while communicating with external services, including network errors, service unavailable, or invalid responses. | +| [https://serverlessworkflow.io/spec/1.0.0/errors/runtime](#) | `500` | Errors occurring during the runtime execution of a workflow, including unexpected exceptions, errors related to resource allocation, or failures in handling workflow tasks. These errors typically occur during the actual execution of workflow components and may require runtime-specific handling and resolution strategies. | + +Ā¹ *Default value. The `status code` that best describe the error should always be used.* + +### Event Consumption Strategy + +Represents the configuration of an event consumption strategy. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| all | [`eventFilter[]`](#event-filter) | `no` | Configures the workflow to wait for all defined events before resuming execution.
*Required if `any` and `one` have not been set.* | +| any | [`eventFilter[]`](#event-filter) | `no` | Configures the workflow to wait for any of the defined events before resuming execution.
*Required if `all` and `one` have not been set.*
*If empty, listens to all incoming events* | +| one | [`eventFilter`](#event-filter) | `no` | Configures the workflow to wait for the defined event before resuming execution.
*Required if `all` and `any` have not been set.* | +| until | `string`
[`eventConsumptionStrategy`](#event-consumption-strategy) | `no` | Configures the [runtime expression](dsl.md#runtime-expressions) condition or the events that must be consumed to stop listening.
*Only applies if `any` has been set, otherwise ignored.*
*If not present, once any event is received, it proceeds to the next task.* | + +### Event Properties + +An event object typically includes details such as the event type, source, timestamp, and unique identifier along with any relevant data payload. The [Cloud Events specification](https://cloudevents.io/), favored by Serverless Workflow, standardizes this structure to ensure interoperability across different systems and services. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| id | `string` | `no` | Identifies the event. `source` + `id` is unique for each distinct event.
*Required when emitting an event using `emit.event.with`.* | +| source | `string` | `no` | An URI formatted string, or [runtime expression](dsl.md#runtime-expressions), that identifies the context in which an event happened. `source` + `id` is unique for each distinct event.
*Required when emitting an event using `emit.event.with`.* | +| type | `string` | `no` | Describes the type of event related to the originating occurrence.
*Required when emitting an event using `emit.event.with`.* | +| time | `string` | `no` | A string, or [runtime expression](dsl.md#runtime-expressions), representing the timestamp of when the occurrence happened. | +| subject | `string` | `no` | Describes the subject of the event in the context of the event producer. | +| datacontenttype | `string` | `no` | Content type of `data` value. If omitted, it implies the `data` is a JSON value conforming to the "application/json" media type. | +| dataschema | `string` | `no` | An URI formatted string, or [runtime expression](dsl.md#runtime-expressions), that identifies the schema that `data` adheres to. | +| data | `any` | `no` | The event payload. | + +*Additional properties can be supplied, see the Cloud Events specification [documentation](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#extension-context-attributes) for more info.* + +*When used in an [`eventFilter`](#event-filter), at least one property must be supplied.* + + +### Event Filter + +An event filter is a mechanism used to selectively process or handle events based on predefined criteria, such as event type, source, or specific attributes. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| with | [`eventProperties`](#event-properties) | `yes` | A name/value mapping of the attributes filtered events must define. Supports both regular expressions and runtime expressions. | +| correlate | [`map[string, correlation]`](#correlation) | `no` | A name/definition mapping of the correlations to attempt when filtering events. | + +### Correlation + +A correlation is a link between events and data, established by mapping event attributes to specific data attributes, allowing for coordinated processing or handling based on event characteristics. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| from | `string` | `yes` | A runtime expression used to extract the correlation value from the filtered event. | +| expect | `string` | `no` | A constant or a runtime expression, if any, used to determine whether or not the extracted correlation value matches expectations.
If not set, the first extracted value will be used as the correlation's expectation. | + +### Retry + +The Retry is a fundamental concept in the Serverless Workflow DSL, used to define the strategy for retrying a failed task when an error is encountered during execution. This policy provides developers with fine-grained control over how and when to retry failed tasks, enabling robust error handling and fault tolerance within workflows. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| when | `string` | `no` | A a runtime expression used to determine whether or not to retry running the task, in a given context. | +| exceptWhen | `string` | `no` | A runtime expression used to determine whether or not to retry running the task, in a given context. | +| limit | [`retry`](#retry-limit) | `no` | The limits, if any, to impose to the retry policy. | +| backoff | [`backoff`](#backoff) | `no` | The backoff strategy to use, if any. | +| jitter | [`jitter`](#jitter) | `no` | The parameters, if any, that control the randomness or variability of the delay between retry attempts. | + +#### Retry Limit + +The definition of a retry policy. + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| attempt.count | `integer` | `no` | The maximum attempts count. | +| attempt.duration | [`duration`](#duration) | `no` | The duration limit, if any, for all retry attempts. | +| duration | [`duration`](#duration) | `no` | The maximum duration, if any, during which to retry a given task. | + +#### Backoff + +The definition of a retry backoff strategy. + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| constant | `object` | `no` | The definition of the constant backoff to use, if any.
*Required if `exponential` and `linear` are not set, otherwise ignored.* | +| exponential | `object` | `no` | The definition of the exponential backoff to use, if any.
*Required if `constant` and `linear` are not set, otherwise ignored.* | +| linear | `object` | `no` | The definition of the linear backoff to use, if any.
*Required if `constant` and `exponential` are not set, otherwise ignored.* | + +#### Jitter + +Represents the definition of the parameters that control the randomness or variability of a delay, typically between retry attempts + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| from | [`duration`](#duration) | `yes` | The minimum duration of the jitter range. | +| to | [`duration`](#duration) | `yes` | The maximum duration of the jitter range. | + +#### Examples + +```yaml + +``` + +### Input + +Documents the structure - and optionally configures the transformation of - workflow/task input data. + +It's crucial for authors to document the schema of input data whenever feasible. This documentation empowers consuming applications to provide contextual auto-suggestions when handling runtime expressions. + +When set, runtimes must validate raw input data against the defined schema before applying transformations, unless defined otherwise. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| schema | [`schema`](#schema) | `no` | The [`schema`](#schema) used to describe and validate raw input data.
*Even though the schema is not required, it is strongly encouraged to document it, whenever feasible.* | +| from | `string`
`object` | `no` | A [runtime expression](dsl.md#runtime-expressions), if any, used to filter and/or mutate the workflow/task input. | + +#### Examples + +```yaml +schema: + format: json + document: + type: object + properties: + order: + type: object + required: [ pet ] + properties: + pet: + type: object + required: [ id ] + properties: + id: + type: string +from: .order.pet +``` + +### Output + +Documents the structure - and optionally configures the transformations of - workflow/task output data. + +It's crucial for authors to document the schema of output data whenever feasible. This documentation empowers consuming applications to provide contextual auto-suggestions when handling runtime expressions. + +When set, runtimes must validate output data against the defined schema after applying transformations, unless defined otherwise. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| schema | [`schema`](#schema) | `no` | The [`schema`](#schema) used to describe and validate output data.
*Even though the schema is not required, it is strongly encouraged to document it, whenever feasible.* | +| as | `string`
`object` | `no` | A [runtime expression](dsl.md#runtime-expressions), if any, used to filter and/or mutate the workflow/task output. | + +#### Examples + +```yaml +output: + schema: + format: json + document: + type: object + properties: + petId: + type: string + required: [ petId ] + as: + petId: '${ .pet.id }' +``` + +### Export + +Certain task needs to set the workflow context to save the task output for later usage. Users set the content of the context through a runtime expression. The result of the expression is the new value of the context. The expression is evaluated against the transformed task output. + +Optionally, the context might have an associated schema which is validated against the result of the expression. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| schema | [`schema`](#schema) | `no` | The [`schema`](#schema) used to describe and validate context.
*Included to handle the non frequent case in which the context has a known format.* | +| as | `string`
`object` | `no` | A runtime expression, if any, used to export the output data to the context. | + +#### Examples + +Merge the task output into the current context. + +```yaml +as: '$context+.' +``` + +Replace the context with the task output. + +```yaml +as: '.' +``` + +### Schema + +Describes a data schema. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| format | `string` | `yes` | The schema format.
*Supported values are:*
*- `json`, which indicates the [JsonSchema](https://json-schema.org/) format.* | +| document | `object` | `no` | The inline schema document.
*Required if `resource` has not been set, otherwise ignored.* | +| resource | [`externalResource`](#external-resource) | `no` | The schema external resource.
*Required if `document` has not been set, otherwise ignored.* | + +#### Examples + +*Example of an inline JsonSchema:* +```yaml +format: json +document: + type: object + properties: + id: + type: string + firstName: + type: string + lastName: + type: string + required: [ id, firstName, lastName ] +``` + +*Example of a JsonSchema based on an external resource:* +```yaml +format: json +resource: + endpoint: https://test.com/fake/schema/json/document.json +``` + +### Timeout + +Defines a workflow or task timeout. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| after | [`duration`](#duration) | `yes` | The duration after which the workflow or task times out. | + +#### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: default + name: timeout-example + version: '0.1.0' +do: + - waitAMinute: + wait: + seconds: 60 +timeout: + after: + seconds: 30 +``` + +### Duration + +Defines a duration. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| Days | `integer` | `no` | Number of days, if any. | +| Hours | `integer` | `no` | Number of hours, if any. | +| Minutes | `integer` | `no`| Number of minutes, if any. | +| Seconds | `integer` | `no`| Number of seconds, if any. | +| Milliseconds | `integer` | `no`| Number of milliseconds, if any. | + +#### Examples + +*Example of a duration of 2 hours, 15 minutes and 30 seconds:* +```yaml +hours: 2 +minutes: 15 +seconds: 30 +``` + +### Endpoint + +Describes an enpoint. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| uri | `string` | `yes` | The endpoint's URI. | +| authentication | [authentication](#authentication) | `no` | The authentication policy to use. | + +### HTTP Response + +Describes an HTTP response. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| request | [`request`](#http-request) | `yes` | The HTTP request associated with the HTTP response. | +| statusCode | `integer` | `yes` | The HTTP response status code. | +| headers | `map[string, string]` | `no` | The HTTP response headers, if any. | +| content | `any` | `no` | The HTTP response content, if any.
*If the request's content type is one of the following, should contain the deserialized response content. Otherwise, should contain the base-64 encoded response content, if any.*| + +#### Examples + +```yaml +request: + method: get + uri: https://petstore.swagger.io/v2/pet/1 + headers: + Content-Type: application/json +headers: + Content-Type: application/json +statusCode: 200 +content: + id: 1 + name: milou + status: pending +``` + +### HTTP Request + +Describes an HTTP request. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| method | `string` | `yes` | The request's method. | +| uri | `uri` | `yes` | The request's URI. | +| headers | `map[string, string]` | `no` | The HTTP request headers, if any. | + +#### Examples + +```yaml +method: get +uri: https://petstore.swagger.io/v2/pet/1 +headers: + Content-Type: application/json +``` + +### URI Template + +The DSL has limited support for URI template syntax as defined by [RFC 6570](https://datatracker.ietf.org/doc/html/rfc6570). Specifically, only the [Simple String Expansion](https://datatracker.ietf.org/doc/html/rfc6570#section-3.2.2) is supported, which allows authors to embed variables in a URI. + +To substitute a variable within a URI, use the `{}` syntax. The identifier inside the curly braces will be replaced with its value during runtime evaluation. If no value is found for the identifier, an empty string will be used. + +This has the following limitations compared to runtime expressions: + +- Only top-level properties can be interpolated within strings, thus identifiers are treated verbatim. This means that `{pet.id}` will be replaced with the value of the `"pet.id"` property, not the value of the `id` property of the `pet` property. +- The referenced variable must be of type `string`, `number`, `boolean`, or `null`. If the variable is of a different type an error with type `https://https://serverlessworkflow.io/spec/1.0.0/errors/expression` and status `400` will be raised. +- [Runtime expression arguments](./dsl.md#runtime-expression-arguments) are not available for string substitution. + +#### Examples + +```yaml +uri: https://petstore.swagger.io/v2/pet/{petId} +``` + +### Container Lifetime + +Configures the lifetime of a container. + +#### Properties + +| Property | Type | Required | Description | +|----------|:----:|:--------:|-------------| +| cleanup | `string` | `yes` | The cleanup policy to use.
*Supported values are:
- `always`: the container is deleted immediately after execution.
-`never`: the runtime should never delete the container.
-`eventually`: the container is deleted after a configured amount of time after its execution.*
*Defaults to `never`.* | +| after | [`duration`](#duration) | `no` | The [`duration`](#duration), if any, after which to delete the container once executed.
*Required if `cleanup` has been set to `eventually`, otherwise ignored.* | +### Process Result + +Describes the result of a process. + +#### Properties + +| Name | Type | Required | Description| +|:--|:---:|:---:|:---| +| code | `integer` | `yes` | The process's exit code. | +| stdout | `string` | `yes` | The process's **STDOUT** output. | +| stderr | `string` | `yes` | The process's **STDERR** output. | + +#### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: run-container-example + version: '0.1.0' +do: + - runContainer: + run: + container: + image: fake-image + lifetime: + cleanup: eventually + after: + minutes: 30 + return: stderr + + - runScript: + run: + script: + language: js + code: > + Some cool multiline script + return: code + + - runShell: + run: + shell: + command: 'echo "Hello, ${ .user.name }"' + return: all + + - runWorkflow: + run: + workflow: + namespace: another-one + name: do-stuff + version: '0.1.0' + input: {} + return: none +``` + +### AsyncAPI Server + +Configures the target server of an AsyncAPI operation. + +#### Properties + +| Name | Type | Required | Description | +|:-----|:----:|:--------:|:------------| +| name | `string` | `yes` | The name of the [server](https://www.asyncapi.com/docs/reference/specification/v3.0.0#serverObject) to call the specified AsyncAPI operation on. | +| variables | `object` | `no` | The target [server's variables](https://www.asyncapi.com/docs/reference/specification/v3.0.0#serverVariableObject), if any. | + +#### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: asyncapi-example + version: '0.1.0' +do: + - publishGreetings: + call: asyncapi + with: + document: + endpoint: https://fake.com/docs/asyncapi.json + operation: greet + server: + name: greetingsServer + variables: + environment: dev + message: + payload: + greetings: Hello, World! + headers: + foo: bar + bar: baz +``` + +### AsyncAPI Outbound Message + +Configures an AsyncAPI message to publish. + +#### Properties + +| Name | Type | Required | Description | +|:-----|:----:|:--------:|:------------| +| payload | `object` | `no` | The message's payload, if any. | +| headers | `object` | `no` | The message's headers, if any. | + +#### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: asyncapi-example + version: '0.1.0' +do: + - publishGreetings: + call: asyncapi + with: + document: + endpoint: https://fake.com/docs/asyncapi.json + operation: greet + protocol: http + message: + payload: + greetings: Hello, World! + headers: + foo: bar + bar: baz +``` + +### AsyncAPI Inbound Message + +Configures an AsyncAPI message consumed by a subscription. + +#### Properties + +| Name | Type | Required | Description | +|:-------|:------:|:----------:|:--------------| +| payload | `object` | `no` | The message's payload, if any. | +| headers | `object` | `no` | The message's headers, if any. | +| correlationId | `string` | `no` | The message's correlation id, if any. | + +#### Examples + +```yaml +payload: + greetings: Hello, World! +headers: + foo: bar + bar: baz +correlationid: '123456' +``` + +### AsyncAPI Subscription + +Configures a subscription to an AsyncAPI operation. + +#### Properties + +| Name | Type | Required | Description | +|:-------|:------:|:----------:|:--------------| +| filter | `string` | `no` | A [runtime expression](dsl.md#runtime-expressions), if any, used to filter consumed [messages](#asyncapi-inbound-message). | +| consume | [`subscriptionLifetime`](#asyncapi-subscription-lifetime) | `yes` | An object used to configure the subscription's lifetime. | +| foreach | [`subscriptionIterator`](#subscription-iterator) | `no` | Configures the iterator, if any, for processing each consumed [message](#asyncapi-inbound-message). | + +> [!NOTE] +> An AsyncAPI subscribe operation call produces a sequentially ordered array of all the [messages](#asyncapi-inbound-message) it has consumed, and potentially transformed using `foreach.output.as`. + +> [!NOTE] +> When `foreach` is set, the configured operations for a [message](#asyncapi-inbound-message) must complete before moving on to the next one. As a result, consumed [messages](#asyncapi-inbound-message) should be stored in a First-In-First-Out (FIFO) queue while awaiting iteration. + +#### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: asyncapi-example + version: '0.1.0' +do: + - subscribeToChatInboxForAmount: + call: asyncapi + with: + document: + endpoint: https://fake.com/docs/asyncapi.json + operation: chat-inbox + protocol: http + subscription: + filter: ${ . == $workflow.input.chat.roomId } + consume: + amount: 5 + for: + seconds: 10 +``` + +### AsyncAPI Subscription Lifetime + +Configures the lifetime of an AsyncAPI subscription + +#### Properties + +| Name | Type | Required | Description | +|:-----|:----:|:--------:|:------------| +| amount | `integer` | `no` | The amount of messages to consume.
*Required if `while` and `until` have not been set.* | +| for | [`duration`](#duration) | `no` | The [`duration`](#duration) that defines for how long to consume messages. | +| while | `string` | `no` | A [runtime expression](dsl.md#runtime-expressions), if any, used to determine whether or not to keep consuming messages.
*Required if `amount` and `until` have not been set.* | +| until | `string` | `no` | A [runtime expression](dsl.md#runtime-expressions), if any, used to determine until when to consume messages.
*Required if `amount` and `while` have not been set.* | + +#### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: asyncapi-example + version: '0.1.0' +do: + - subscribeToChatInboxUntil: + call: asyncapi + with: + document: + endpoint: https://fake.com/docs/asyncapi.json + operation: chat-inbox + protocol: http + subscription: + filter: ${ . == $workflow.input.chat.roomId } + consume: + until: '${ ($context.messages | length) == 5 }' + for: + seconds: 10 +``` + +### Subscription Iterator + +Configures the iteration over each item (event or message) consumed by a subscription. It encapsulates configuration for processing tasks, output formatting, and export behavior for every item encountered. + +#### Properties + +| Name | Type | Required | Description | +|:-----|:----:|:--------:|:------------| +| item | `string` | `no` | The name of the variable used to store the current item being enumerated.
*Defaults to `item`.* | +| at | `string` | `no` | The name of the variable used to store the index of the current item being enumerated.
*Defaults to `index`.* | +| do | [`map[string, task][]`](#task) | `no` | The tasks to perform for each consumed item. | +| output | [`output`](#output) | `no` | An object, if any, used to customize the item's output and to document its schema. | +| export | [`export`](#export) | `no` | An object, if any, used to customize the content of the workflow context. | + +#### Examples + +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: asyncapi-example + version: '0.1.0' +do: + - subscribeToChatInboxUntil: + call: asyncapi + with: + document: + endpoint: https://fake.com/docs/asyncapi.json + operation: chat-inbox + protocol: http + subscription: + filter: ${ . == $workflow.input.chat.roomId } + consume: + until: '${ ($context.messages | length) == 5 }' + for: + seconds: 10 + foreach: + item: message + at: index + do: + - emitEvent: + emit: + event: + with: + source: https://serverlessworkflow.io/samples + type: io.serverlessworkflow.samples.asyncapi.message.consumed.v1 + data: + message: '${ $message }' +``` + +### Workflow Definition Reference + +References a workflow definition. + +#### Properties + +| Name | Type | Required | Description | +|:-----|:----:|:--------:|:------------| +| name | `string` | `yes` | The name of the referenced workflow definition. | +| namespace | `string` | `yes` | The namespace of the referenced workflow definition. | +| version | `string` | `yes` | The semantic version of the referenced workflow definition. | + +#### Examples + +```yaml +name: greet +namespace: samples +version: '0.1.0-rc2' +``` \ No newline at end of file diff --git a/dsl.md b/dsl.md new file mode 100644 index 00000000..bd41c32c --- /dev/null +++ b/dsl.md @@ -0,0 +1,817 @@ +# Serverless Workflow DSL + +## Table of Contents + +- [Abstract](#abstract) +- [Motivation](#motivation) +- [Priority of Constituencies](#priority-of-constituencies) +- [Design](#design) +- [Concepts](#concepts) + + [Workflow](#workflow) + - [Status Phases](#status-phases) + - [Lifecycle Events](#lifecycle-events) + + [Workflow Lifecycle Events](#workflow-lifecycle-events) + + [Task Lifecycle Events](#task-lifecycle-events) + - [Components](#components) + + [Task](#task) + - [Scheduling](#scheduling) + + [Event-Driven Scheduling](#event-driven-scheduling) + + [Task Flow](#task-flow) + + [Data Flow](#data-flow) + + [Runtime Expressions](#runtime-expressions) + - [Arguments](#runtime-expression-arguments) + + [Fault Tolerance](#fault-tolerance) + + [Timeouts](#timeouts) + + [Catalogs](#catalogs) + + [File Structure](#file-structure) + + [Default Catalog](#default-catalog) + + [Using Cataloged Functions](#using-cataloged-functions) + + [Interoperability](#interoperability) + - [Supported Protocols](#supported-protocols) + - [Custom and Non-Standard Interactions](#custom-and-non-standard-interactions) + + [Creating a Custom Function](#creating-a-custom-function) + + [Using a Custom Function](#using-a-custom-function) + + [Publishing a Custom Function](#publishing-a-custom-function) + + [Events](#events) + + [Extensions](#extensions) + + [External Resources](#external-resources) + + [Authentication](#authentication) + +## Abstract + +This document proposes the creation of a Domain Specific Language (DSL) called Serverless Workflow, tailored for building platform agnostic workflows. + +Serverless Workflow aims to simplify the orchestration of complex processes across diverse environments, providing developers with a unified syntax and set of tools for defining and executing serverless workflows. + +## Motivation + +Serverless computing has gained popularity for its ability to abstract away infrastructure management tasks, enabling developers to focus on application logic. However, orchestrating serverless workflows across multiple environments often involves dealing with disparate tools and platforms, leading to complexity and inefficiency. + +Serverless Workflow addresses this challenge by providing a DSL specifically designed for serverless workflow orchestration. By abstracting away the underlying infrastructure complexities and offering a modular and extensible framework, Serverless Workflow aims to streamline the development, deployment, and management of serverless workflows. + +## Priority of Constituencies + +Inspired by the [Priority of Constituencies](https://www.w3.org/TR/2024/NOTE-design-principles-20240718/#priority-of-constituencies) principle from the W3C Design Principles, the Serverless Workflow DSL prioritizes the following constituencies (collectively referred to as "users"): + +- Authors: people authoring and reading workflows +- Operators: people running and operating a runtime implementation of the specification +- Implementors: people implementing a specification compliant runtime +- Specifications writers: people working on the specifications of Serverless Workflow + +If a trade-off needs to be made, always put author's needs above all. + +Similarly, when beginning to design an API, be sure to understand and document the user needs that the API aims to address. + +Author needs come before the needs of operators, which come before the needs of runtime implementors, which come before the needs of specification writers, which come before theoretical purity. + +Like all principles, this isnāt absolute. Ease of operations affects the perceived reliability of authors' workflows. Implementors have to prioritize finite engineering resources, which affects how features reach authors. Specification writers also have finite resources, and theoretical concerns reflect the underlying needs of all of these groups. + +## Design + +The Serverless Workflow DSL is crafted with a design philosophy that prioritizes clarity, expressiveness, and ease of use. Its foundation lies in linguistic fluency, emphasizing readability and comprehension. By adopting a fluent style, the DSL promotes intuitive understanding through natural language constructs. Verbs are employed in the imperative tense to denote actions, enhancing clarity and directness in expressing workflow logic. This imperative approach empowers developers to articulate their intentions succinctly and effectively. + +The DSL also embraces the principle of implicit default behaviors, sparing authors from unnecessary repetition and enhancing the conciseness of workflow definitions. For instance, default settings alleviate the burden of explicitly defining every detail, streamlining the workflow design process. Furthermore, the DSL allows both inline declaration of components or the creation of reusable elements, granting flexibility in workflow composition. This flexibility allows developers to seamlessly integrate inline task definitions without imposing rigid structural requirements. + +Moreover, the DSL eschews strong-typed enumerations wherever feasible, fostering extensibility and adaptability across different runtime environments. While maintaining portability is crucial, the DSL prioritizes customization options for extensions and runtimes, enabling tailored implementations to suit diverse use cases. Additionally, the DSL favors universally understood terms over technical jargon, enhancing accessibility and comprehension for a broader audience. + +- Embrace linguistic fluency for enhanced readability and understanding. +- Utilize imperative verbs to convey actions directly and clearly. +- Employ implicit default behaviors to reduce redundancy and streamline workflow definitions. +- Enable the declaration and effortless import of shared components by supporting external references +- Encourage the declaration of components inline for situations where reusability is unnecessary, prioritizing ease of use in such cases. +- Prioritize flexibility over strong-typed enumerations for enhanced extensibility. +- Opt for universally understood terms to improve accessibility and comprehension. + +## Concepts + +### Workflow + +A Serverless Workflow is a sequence of specific [tasks](dsl-reference.md#tasks) that are executed in a defined order. By default, this order follows the declaration sequence within the workflow definition. Workflows are designed to automate processes and orchestrate various serverless functions and services. + +Workflows can be triggered in different ways: upon request, scheduled using CRON expressions, or initiated upon correlation with specific events. + +Additionally, workflows may optionally accept inputs and produce outputs, allowing for data processing and transformation within the workflow execution. + +#### Status Phases + +Both workflows and tasks in the Serverless Workflow DSL can exist in several phases, each indicating the current state of the workflow/task execution. These phases include: + +| Phase | Description | +| --- | --- | +| `pending` | The workflow/task has been initiated and is pending execution. | +| `running` | The workflow/task is currently in progress. | +| `waiting` | The workflow/task execution is temporarily paused, awaiting either inbound event(s) or a specified time interval as defined by a [`wait`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#wait) task. | +| `suspended` | The workflow/task execution has been manually paused by a user and will remain halted until explicitly resumed. | +| `cancelled` | The workflow/task execution has been terminated before completion. | +| `faulted` | The workflow/task execution has encountered an error. | +| `completed` | The workflow/task ran to completion. | + +Additionally, the flow of execution within a workflow can be controlled using [directives*](dsl-reference.md#flow-directive), which provide instructions to the workflow engine on how to manage and handle specific aspects of workflow execution. + +\**To learn more about flow directives and how they can be utilized to control the execution and behavior of workflows, please refer to [Flow Directives](dsl-reference.md#flow-directive).* + +#### Lifecycle Events + +Lifecycle [cloud events](https://github.com/cloudevents/spec) standardize notifications for key state changes in workflows and tasksāsuch as start, suspend, resume, cancel, fault, complete, and status change. These events carry consistent information like IDs, status transitions, timestamps, and relevant metadata, enabling users to reliably respond to updates, enhancing interoperability and simplifying integration across different implementations. + +Runtimes are expected to publish these events upon state changes. While using the [HTTP protocol binding](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/http-protocol-binding.md) with [structured content mode](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/http-protocol-binding.md#32-structured-content-mode) is recommended, other transports adhering to the [CloudEvents](https://github.com/cloudevents/spec) specification may be used. + +##### Workflow Lifecycle Events + +| Type | Data | Required | Description | +|:----:|:----:|:--------:|:------------| +|
`io.serverlessworkflow.workflow.started.v1`| [`workflowStartedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-started-event) | `yes` | Notifies about the start of a workflow. | +|
`io.serverlessworkflow.workflow.suspended.v1`| [`workflowSupsendedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-suspended-event) | `yes` | Notifies about suspending a workflow execution. | +|
`io.serverlessworkflow.workflow.resumed.v1`| [`workflowResumedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-resumed-event) | `yes` | Notifies about resuming a workflow execution. | +|
`io.serverlessworkflow.workflow.correlation-started.v1`| [`workflowCorrelationStartedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-correlation-started-event) | `yes` | Notifies about a workflow starting to correlate events. | +|
`io.serverlessworkflow.workflow.correlation-completed.v1`| [`workflowCorrelationCompletedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-correlation-completed-event) | `yes` | Notifies about a workflow completing an event correlation. | +|
`io.serverlessworkflow.workflow.cancelled.v1`| [`workflowCancelledEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-cancelled-event) | `yes` | Notifies about the cancellation of a workflow execution. | +|
`io.serverlessworkflow.workflow.faulted.v1`| [`workflowFaultedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-faulted-event) | `yes` | Notifies about a workflow being faulted. | +|
`io.serverlessworkflow.workflow.completed.v1`| [`workflowCompletedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-completed-event) | `yes` |Notifies about the completion of a workflow execution. | +|
`io.serverlessworkflow.workflow.status-changed.v1`| [`workflowStatusChangedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-status-changed-event) | `no` |Notifies about the change of a workflow's status phase. | + +> [!NOTE] +> The `io.serverlessworkflow.workflow.status-changed.v1` event is an optional convenience event that notifies consumers solely about a workflowās status changes, without carrying extra data. It is typically used by consumers who only need to track or report status updates (and not details like faults or outputs). Its use is optional because it requires runtimes to publish an additional event for each necessary lifecycle change. + +##### Task Lifecycle Events + +| Type | Data | Required | Description | +|:----:|:----:|:--------:|:------------| +|
`io.serverlessworkflow.task.created.v1`| [`taskCreatedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-created-event) | `yes` | Notifies about the creation of a task. | +|
`io.serverlessworkflow.task.started.v1`| [`taskStartedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-started-event) | `yes` | Notifies about the start of a task. | +|
`io.serverlessworkflow.task.suspended.v1`| [`taskSuspendedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-suspended-event) | `yes` | Notifies about suspending a task's execution. | +|
`io.serverlessworkflow.task.resumed.v1`| [`taskResumedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-resumed-event) | `yes` | Notifies about resuming a task's execution. | +|
`io.serverlessworkflow.task.retried.v1`| [`taskRetriedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-retried-event) | `yes` | Notifies about retrying a task's execution. | +|
`io.serverlessworkflow.task.cancelled.v1`| [`taskCancelledEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-cancelled-event) | `yes` | Notifies about the cancellation of a task's execution. | +|
`io.serverlessworkflow.task.faulted.v1`| [`taskFaultedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-faulted-event) | `yes` | Notifies about a task being faulted. | +|
`io.serverlessworkflow.task.completed.v1`| [`taskCompletedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-completed-event) | `yes` | Notifies about the completion of a task's execution. | +|
`io.serverlessworkflow.task.status-changed.v1`| [`taskStatusChangedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-status-changed-event) | `no` | Notifies about the change of a task's status phase. | + +> [!NOTE] +> The `io.serverlessworkflow.task.status-changed.v1` event is an optional convenience event that notifies consumers solely about a task's status changes, without carrying extra data. It is typically used by consumers who only need to track or report status updates (and not details like faults or outputs). Its use is optional because it requires runtimes to publish an additional event for each necessary lifecycle change. + +#### Components + +Serverless Workflow DSL allows for defining reusable components that can be referenced across the workflow. These include: + +- [Authentications](dsl-reference.md#authentication) +- [Errors](dsl-reference.md#error) +- [Extensions](dsl-reference.md#extension) +- [Functions](dsl-reference.md#task) +- [Retries](dsl-reference.md#retry) +- [Secrets](#secret) + +##### Task + +[Tasks](dsl-reference.md#tasks) are the fundamental computing units of a workflow. They define the different types of actions that a workflow can perform, including the ability to mutate their input and output data. Tasks can also write to and modify the context data, enabling complex and dynamic workflow behaviors. + +The Serverless Workflow DSL defines several default [task](dsl-reference.md#tasks) types that runtimes **must** implement: + +- [Call](dsl-reference.md#call), used to call services and/or functions. +- [Do](dsl-reference.md#do), used to define one or more subtasks to perform in sequence. +- [Emit](dsl-reference.md#emit), used to emit [events](dsl-reference.md#event). +- [For](dsl-reference.md#for), used to iterate over a collection of items, and conditionally perform a task for each of them. +- [Fork](dsl-reference.md#fork), used to define one or more two subtasks to perform in parallel. +- [Listen](dsl-reference.md#listen), used to listen for an [event](dsl-reference.md#event) or more. +- [Raise](dsl-reference.md#raise), used to raise an [error](dsl-reference.md#error) and potentially fault the [workflow](dsl-reference.md#workflow). +- [Run](dsl-reference.md#run), used to run a [container](dsl-reference.md#container-process), a [script](dsl-reference.md#script-process), a [shell](dsl-reference.md#shell-process) command or even another [workflow](dsl-reference.md#workflow-process). +- [Set](dsl-reference.md#set), used to dynamically set the [workflow](dsl-reference.md#workflow)'s data during the its execution. +- [Switch](dsl-reference.md#switch), used to dynamically select and execute one of multiple alternative paths based on specified conditions +- [Try](dsl-reference.md#try), used to attempt executing a specified [task](dsl-reference.md#task), and to handle any resulting [errors](dsl-reference.md#error) gracefully, allowing the [workflow](dsl-reference.md#workflow) to continue without interruption. +- [Wait](dsl-reference.md#wait), used to pause or wait for a specified duration before proceeding to the next task. + +To ensure they conform to the DSL, runtimes **should** pass all the feature conformance test scenarios defined in the [ctk](ctk/README.md). + +##### Secret + +Secrets are sensitive information required by a workflow to securely access protected resources or services. They provide a way to securely store and manage credentials, tokens, or other sensitive data used during workflow execution. + +Runtime **must** implement a mechanism capable of providing the workflow with the data contained within the defined secrets. If a workflow attempts to access a secret to which it does not have access rights or which does not exist, runtimes **must** raise an error with type `https://serverlessworkflow.io/spec/1.0.0/errors/authorization` and status `403`. + +#### Scheduling + +Workflow scheduling in ServerlessWorkflow allows developers to specify when and how their workflows should be executed, ensuring timely response to events and efficient resource utilization. It offers four key properties: `every`, `cron`, `after`, and `on`. + +- The `every` property defines the interval for workflow execution, ensuring periodic runs regardless of the previous run's status. +- With `cron`, developers can use CRON expressions to schedule workflow execution at specific times or intervals. +- `after` specifies a delay duration before restarting the workflow after completion. +- `on` enables event-driven scheduling, triggering workflow execution based on specified events. + +See the [DSL reference](dsl-reference.md#schedule) for more details about workflow scheduling. + +##### Event-driven scheduling + +###### Input of event-driven scheduled workflows + +In event-driven scheduled workflows, the input is structured as an array containing the events that trigger the execution of the workflow. This array serves as a vital resource, providing workflow authors access to all relevant data associated with each triggering event. When an event activates the workflow, it populates this array with one or more occurrences, allowing authors to process multiple events simultaneously as needed. + +Authors can reference individual events within the array using syntax such as $workflow.input[index], where index indicates the event's position, starting from 0. For instance, $workflow.input[0] refers to the first event, while $workflow.input[1] refers to the second. This structure allows for easy access to specific event details, and if multiple events are received at once, authors can iterate through the array to handle each one appropriately. This flexibility ensures that workflows can respond effectively to various conditions and triggers, enhancing their overall responsiveness and functionality. + +###### Distinguishing event-driven scheduling from start `listen` Tasks + +While both `schedule.on` and a start listener task enable event-driven execution of workflows, they serve distinct purposes and have different implications: + +- **`schedule.on`**: This property defines when a new workflow instance should be created based on an external event. When an event matches the criteria specified in `schedule.on`, a new workflow instance is initiated. The critical point here is that `schedule.on` solely manages the creation of new workflow instances. Any faults or timeouts related to the scheduling process are typically invisible to the user and do not impact the workflow instance. + +- **Start `listen` task**: A start listener task defines a task that must be undertaken after a new workflow instance has been created. This task listens for specific events and begins processing once the instance is active. The critical difference is that a start listener task operates within an already instantiated workflow. If a start listener task experiences a timeout or fault, it can cause the entire workflow instance to fail or behave unexpectedly, directly impacting the flow's execution and outcome. + +While `schedule.on` is concerned with *when* a new workflow instance should be initiated, a start listener task deals with *what* should happen once the instance is active. This distinction is crucial because it influences how errors and timeouts are handledā`schedule.on` faults are typically invisible and do not affect the workflow, whereas start listener task failures can directly and potentially severely impact the workflow instance they belong to. + +### Task Flow + +A workflow begins with the first task defined. + +Once the task has been executed, different things can happen: + +- `continue`: the task ran to completion, and the next task, if any, should be executed. The task to run next is implicitly the next in declaration order, or explicitly defined by the `then` property of the executed task. If the executed task is the last task, then the workflow's execution gracefully ends. +- `fault`: the task raised an uncaught error, which abruptly halts the workflow's execution and makes it transition to `faulted` [status phase](#status-phases). +- `end`: the task explicitly and gracefully ends the workflow's execution. + +> [!WARNING] +> Flow directives may only redirect to tasks declared within their own scope. In other words, they cannot target tasks at a different depth. + +### Data Flow + +In Serverless Workflow DSL, data flow management is crucial to ensure that the right data is passed between tasks and to the workflow itself. + +Here's how data flows through a workflow based on various transformation stages: + +1. **Validate Workflow Input** +Before the workflow starts, the input data provided to the workflow can be validated against the `input.schema` property to ensure it conforms to the expected structure. +The execution only proceeds if the input is valid. Otherwise, it will fault with a [ValidationError (https://serverlessworkflow.io/spec/1.0.0/errors/validation)](dsl-reference.md#error). + +2. **Transform Workflow Input** +Before the workflow starts, the input data provided to the workflow can be transformed to ensure only relevant data in the expected format is passed into the workflow context. This can be done using the top level `input.from` expression. It evaluates on the raw workflow input and defaults to the identity expression which leaves the input unchanged. This step allows the workflow to start with a clean and focused dataset, reducing potential overhead and complexity in subsequent tasks. The result of this expression will set as the initial value for the `$context` runtime expression argument and be passed to the first task. + +*Example: If the workflow receives a JSON object as input, a transformation can be applied to remove unnecessary fields and retain only those that are required for the workflow's execution.* + +After workflow input validation and transformation, the transformed input is passed as the raw input to the first task. + +3. **Validate Task Input** +Before a task executes, its raw input can be validated against the `input.schema` property to ensure it conforms to the expected structure. +The execution only proceeds if the input is valid. Otherwise, it will fault with a [ValidationError (https://serverlessworkflow.io/spec/1.0.0/errors/validation)](dsl-reference.md#error). + +4. **Transform Task Input** +The input data for the task can be transformed to match the specific requirements of that task. This ensures that the task receives only the data required to perform its operations. This can be done using the task's `input.from` expression. It evaluates the raw task input (i.e., the transformed workflow input for the first task or the transformed output of the previous task) and defaults to the identity expression, which leaves the input unchanged. The result of this expression will be set as the `$input` runtime expression argument and be passed to the task. This transformed input will be evaluated against any runtime expressions used within the task definition. + +*Example: If the task is a function call that only needs a subset of the workflow input, a transformation can be applied to provide only those fields needed for the function to execute.* + +5. **Transform Task Output** +After completing the task, its output can be transformed before passing it to the next task or storing it in the workflow context. Transformations are applied using the `output.as` runtime expression. It evaluates the raw task output and defaults to the identity expression, which leaves the output unchanged. Its result will be input for the next task. + +*Example: If the task returns a large dataset, a transformation can be applied to retain only the relevant results needed for subsequent tasks.* + +6. **Validate Task Output** +After `output.as` is evaluated, the transformed task output is validated against the `output.schema` property to ensure it conforms to the expected structure. The execution only proceeds if the output is valid. Otherwise, it will fault with a [ValidationError (https://serverlessworkflow.io/spec/1.0.0/errors/validation)](dsl-reference.md#error). + +7. **Update Workflow Context** +To update the context, one uses the `export.as` runtime expression. It evaluates the transformed task output and defaults to the expression that returns the existing context. The result of this runtime expression replaces the workflow's current context and the content of the `$context` runtime expression argument. This helps manage the data flow and keep the context clean by removing any unnecessary data produced by the task. + +8. **Validate Exported Context** +After the context is updated, the exported context is validated against the `export.schema` property to ensure it conforms to the expected structure. The execution only proceeds if the exported context is valid. Otherwise, it will fault with a [ValidationError (https://serverlessworkflow.io/spec/1.0.0/errors/validation)](dsl-reference.md#error). + +9. **Continue Workflow** +After the context is updated, the workflow continues to the next task in the sequence. The transformed output of the previous task is passed as the raw input to the next task, and the data flow cycle repeats. +If no more tasks are defined, the transformed output is passed to the workflow output transformation step. + +10. **Transform Workflow Output** +Finally, the overall workflow output can be transformed before it is returned to the caller or stored. Transformations are applied using the `output.as` runtime expression. It evaluates the last task's transformed output and defaults to the identity expression, which leaves the output unchanged. This step ensures that the final output of the workflow is concise and relevant, containing only the necessary information that needs to be communicated or recorded. + +*Example: If the workflow's final output is a summary report, a transformation can ensure that the report contains only the most important summaries and conclusions, excluding any intermediate data.* + +11. **Validate Workflow Output** +After `output.as` is evaluated, the transformed workflow output is validated against the `output.schema` property to ensure it conforms to the expected structure. The execution only proceeds if the output is valid. Otherwise, it will fault with a [ValidationError (https://serverlessworkflow.io/spec/1.0.0/errors/validation)](dsl-reference.md#error). + +By applying transformations at these strategic points, Serverless Workflow DSL ensures that data flows through the workflow in a controlled and efficient manner, maintaining clarity and relevance at each execution stage. This approach helps manage complex workflows and ensures that each task operates with the precise data required, leading to more predictable and reliable workflow outcomes. + +Visually, this can be represented as follows: + +```mermaid +flowchart TD + + subgraph Legend + legend_data{{Data}} + legend_schema[\Schema/] + legend_transformation[Transformation] + legend_arg([Runtime Argument]) + end + + initial_context_arg([
$context])
+ context_arg([$context])
+ input_arg([$input])
+ output_arg([$output])
+
+ workflow_raw_input{{Raw Workflow Input}}
+ workflow_input_schema[\Workflow: input.schema/]
+ workflow_input_from[Workflow: input.from]
+ workflow_transformed_input{{Transformed Workflow Input}}
+
+ task_raw_input{{Raw Task Input}}
+ task_if[Task: if]
+ task_input_schema[\Task: input.schema/]
+ task_input_from[Task: input.from]
+ task_transformed_input{{Transformed Task Input}}
+ task_definition[Task definition]
+ task_raw_output{{Raw Task output}}
+ task_output_as[Task: output.as]
+ task_transformed_output{{Transformed Task output}}
+ task_output_schema[\Task: output.schema/]
+ task_export_as[Task: export.as]
+ task_export_schema[\Task: export.schema/]
+
+ new_context{{New execution context}}
+
+ workflow_raw_output{{Raw Workflow Output}}
+ workflow_output_as[Workflow: output.as]
+ workflow_transformed_output{{Transformed Workflow Output}}
+ workflow_output_schema[\Workflow: output.schema/]
+
+ workflow_raw_input -- Validated by --> workflow_input_schema
+ workflow_input_schema -- Passed to --> workflow_input_from
+ workflow_input_from -- Produces --> workflow_transformed_input
+ workflow_transformed_input -- Set as --> initial_context_arg
+ workflow_transformed_input -- Passed to --> task_raw_input
+
+ subgraph Task
+
+ task_raw_input -- Passed to --> task_if
+ task_if -- Validated by --> task_input_schema
+ task_input_schema -- Passed to --> task_input_from
+ task_input_from -- Produces --> task_transformed_input
+ task_transformed_input -- Set as --> input_arg
+ task_transformed_input -- Passed to --> task_definition
+
+ task_definition -- Execution produces --> task_raw_output
+ task_raw_output -- Passed to --> task_output_as
+ task_output_as -- Produces --> task_transformed_output
+ task_transformed_output -- Set as --> output_arg
+ task_transformed_output -- Validated by --> task_output_schema
+ task_output_schema -- Passed to --> task_export_as
+ task_export_as -- Produces --> new_context
+ new_context -- Validated by --> task_export_schema
+ end
+
+ task_transformed_output -- Passed as raw input to --> next_task
+
+ subgraph next_task [Next Task]
+ end
+
+ new_context -- set as --> context_arg
+
+ next_task -- Transformed output becomes --> workflow_raw_output
+ workflow_raw_output -- Passed to --> workflow_output_as
+ workflow_output_as -- Produces --> workflow_transformed_output
+ workflow_transformed_output -- Validated by --> workflow_output_schema
+```
+
+### Runtime Expressions
+
+Runtime expressions serve as dynamic elements that enable flexible and adaptable workflow behaviors. These expressions provide a means to evaluate conditions, transform data, and make decisions during the execution of workflows.
+
+Runtime expressions allow for the incorporation of variables, functions, and operators to create logic that responds to changing conditions and input data. These expressions can range from simple comparisons, such as checking if a variable meets a certain condition, to complex computations and transformations involving multiple variables and data sources.
+
+One key aspect of runtime expressions is their ability to adapt to runtime data and context. This means that expressions can access and manipulate data generated during the execution of a workflow, enabling dynamic decision-making and behavior based on real-time information.
+
+Runtime expressions in Serverless Workflow can be evaluated using either the default `strict` mode or the `loose` mode. In `strict` mode, all expressions must be properly identified with `${}` syntax. Conversely, in `loose` mode, expressions are evaluated more liberally, allowing for a wider range of input formats. While `strict` mode ensures strict adherence to syntax rules, `loose` mode offers flexibility, allowing evaluation even if the syntax is not perfectly formed.
+
+All runtimes **must** support the default runtime expression language, which is [`jq`](https://jqlang.github.io/jq/).
+
+Runtimes **may** optionally support other runtime expression languages, which authors can specifically use by adequately configuring the workflow. See [`evaluate.language`](dsl-reference.md#evaluate) for more details.
+
+CloudFlows defines [several arguments](#runtime-expression-arguments) that runtimes **must** provide during the evaluation of runtime expressions.
+
+When the evaluation of an expression fails, runtimes **must** raise an error with type `https://serverlessworkflow.io/spec/1.0.0/errors/expression` and status `400`.
+
+#### Runtime expression arguments
+
+| Name | Type | Description |
+|:-----|:----:|:------------|
+| context | `map` | The workflow's context data. |
+| input | `any` | The task's transformed input. |
+| output | `any` | The task's transformed output. |
+| secrets | `map` | A key/value map of the workflow secrets.To avoid unintentional bleeding, secrets can only be used in the `input.from` runtime expression. | +| authorization | [`authorizationDescriptor`](#authorization-descriptor) | Describes the resolved authorization, as defined by the task's authentication, if any. | +| task | [`taskDescriptor`](#task-descriptor) | Describes the current task. | +| workflow | [`workflowDescriptor`](#workflow-descriptor) | Describes the current workflow. | +| runtime | [`runtimeDescriptor`](#runtime-descriptor) | Describes the runtime. | + +> [!WARNING] +> Use `$secrets` with caution: incorporating them in expressions or passing them as call inputs may inadvertently expose sensitive information. + +##### Runtime Descriptor + +This argument contains information about the runtime executing the workflow. + +| Name | Type | Description | Example | +|:-----|:----:|:------------|:--------| +| name | `string` | A human friendly name for the runtime. | `Synapse`, `Sonata` | +| version | `string` | The version of the runtime. This can be an arbitrary string | An incrementing positive integer (`362`), semantic version (`1.4.78`), commit hash (`04cd3be6da98fc35422c8caa821e0aa1ef6b2c02`) or container image label (`v0.7.43-alpine`) | +| metadata | `map` | An object/map of implementation specific key-value pairs. This can be chosen by runtime implementors and usage of this argument signals that a given workflow definition might not be runtime agnostic | A Software as a Service (SaaS) provider might choose to expose information about the tenant the workflow is executed for e.g. `{ "organization": { "id": "org-ff51cff2-fc83-4d70-9af1-8dacdbbce0be", "name": "example-corp" }, "featureFlags": ["fastZip", "arm64"] }`. | + +##### Workflow Descriptor + +| Name | Type | Description | Example | +|:-----|:----:|:------------|:--------| +| id | `string` | A unique id of the workflow execution. Now specific format is imposed | UUIDv4: `4a5c8422-5868-4e12-8dd9-220810d2b9ee`, ULID: `0000004JFGDSW1H037G7J7SFB9` | +| definition | `map` | The workflow's definition as a parsed object | `{ "document": { ... }, "do": [...] }` | +| input | `any` | The workflow's *raw* input (i.e *BEFORE* the `input.from` expression). For the result of `input.from` expression use the `$input` argument | | +| startedAt | [`dateTimeDescriptor`](#datetime-descriptor) | The start time of the execution | | + +##### Task Descriptor + +| Name | Type | Description | Example | +|:-----|:----:|:------------|:--------| +| name | `string` | The task's name. | `getPet` | +| reference | `string` | The task's reference. | `/do/2/myTask` | +| definition | `map` | The tasks definition (specified under the name) as a parsed object | `{ "call": "http", "with": { ... } }` | +| input | `any` | The task's *raw* input (i.e. *BEFORE* the `input.from` expression). For the result of `input.from` expression use the context of the runtime expression (for jq `.`) | | +| output | `any` | The task's *raw* output (i.e. *BEFORE* the `output.as` expression). | | +| startedAt | [`dateTimeDescriptor`](#datetime-descriptor) | The start time of the task | | + +##### Authorization Descriptor + +| Name | Type | Description | Example | +|:-------|:------:|:------------|:--------| +| scheme | `string` | The resolved authorization scheme. | `Bearer` | +| parameter | `string` | The resolved authorization parameter. | `eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJVadQssw5c` | + +##### DateTime Descriptor + +| Name | Type | Description | Example | +|:-----|:----:|:------------|:--------| +| iso8601 | `string` | The date time as a ISO 8601 date time string. It uses `T` as the date-time delimiter, either UTC (`Z`) or a time zone offset (`+01:00`). The precision can be either seconds, milliseconds or nanoseconds | `2022-01-01T12:00:00Z`, `2022-01-01T12:00:00.123456Z`, `2022-01-01T12:00:00.123+01:00` | +| epoch.seconds | `integer` | The date time as a integer value of seconds since midnight of 1970-01-01 UTC (i.e. [the Unix Epoch](https://en.wikipedia.org/wiki/Unix_time)) | `1641024000` (="2022-01-01T08:00:00Z") | +| epoch.milliseconds | `integer` | The date time as a integer value of milliseconds since midnight of 1970-01-01 UTC. This contains the *whole* timestamp, not just the millisecond portion | `1641024000123` (="2022-01-01T08:00:00.123Z") | + +The following table shows which arguments are available for each runtime expression: + +| Runtime Expression | Evaluated on | Produces | `$context` | `$input` | `$output` | `$secrets` | `$task` | `$workflow` | `$runtime` | `$authorization` | +|:-------------------|:---------:|:---------:|:---------:|:---------:|:-------:|:---------:|:-------:|:----------:|:----------:|:----------:| +| Workflow `input.from` | Raw workflow input | Transformed workflow input | | | | ā | | ā | ā | | +| Task `input.from` | Raw task input (i.e. transformed workflow input for the first task, transformed output from previous task otherwise) | Transformed task input | ā | | | ā | ā | ā | ā | | +| Task `if` | Transformed task input | | ā | ā | | ā | ā | ā | ā | | +| Task definition | Transformed task input | | ā | ā | | ā | ā | ā | ā | ā | +| Task `output.as` | Raw task output | Transformed task output | ā | ā | | ā | ā | ā | ā | ā | +| Task `export.as` | Transformed task output | `$context` | ā | ā | ā | ā | ā | ā | ā | ā | +| Workflow `output.as` | Last task's transformed output | Transformed workflow output | ā | | | ā | | ā | ā | | + +> [!WARNING] +> Use `$secrets` with caution: incorporating them in expressions or passing them as call inputs may inadvertently expose sensitive information. + +### Fault Tolerance + +Serverless Workflow is designed with resilience in mind, acknowledging that errors are an inevitable part of any system. The DSL provides robust mechanisms to identify, describe, and handle errors effectively, ensuring the workflow can recover gracefully from failures. + +Overall, the fault tolerance features in Serverless Workflow enhance its robustness and reliability, making it capable of handling a wide range of failure scenarios gracefully and effectively. + +#### Errors + +Errors in Serverless Workflow are described using the [Problem Details RFC](https://datatracker.ietf.org/doc/html/rfc7807). This specification helps to standardize the way errors are communicated, using the `instance` property as a [JSON Pointer](https://datatracker.ietf.org/doc/html/rfc6901) to identify the specific component of the workflow that has raised the error. By adhering to this standard, authors and runtimes can consistently describe and handle errors. + +*Example error:* +```yaml +type: https://serverlessworkflow.io/spec/1.0.0/errors/communication +title: Service Unavailable +status: 503 +detail: The service is currently unavailable. Please try again later. +instance: /do/getPetById +``` + +The Serverless Workflow specification defines several [standard error types](dsl-reference.md#standard-error-types) to describe commonly known errors, such as timeouts. Using these standard error types ensures that workflows behave consistently across different runtimes, and allows authors to rely on predictable error handling and recovery processes. + +See the [DSL reference](dsl-reference.md#error) for more details about errors. + +#### Retries + +Errors are critical for both authors and runtimes as they provide a means to communicate and describe the occurrence of problems. This, in turn, enables the definition of mechanisms to catch and act upon these errors. For instance, some errors caught using a [`try`](dsl-reference.md#try) block may be transient and temporary, such as a `503 Service Unavailable`. In such cases, the DSL provides a mechanism to retry a faulted task, allowing for recovery from temporary issues. + +*Retrying 5 times when an error with 503 is caught:* +```yaml +try: + call: http + with: + method: get + endpoint: + uri: https://example-service.com/healthz +catch: + errors: + with: + status: 503 + retry: + delay: + seconds: 3 + backoff: + linear: {} + limit: + attempt: + count: 5 +``` + +### Timeouts + +Workflows and tasks alike can be configured to timeout after a defined amount of time. + +When a timeout occur, runtimes **must** abruptly interrupt the execution of the workflow/task, and **must** raise an error that, if uncaught, force the workflow/task to transition to the [`faulted` status phase](#status-phases). + +A timeout error **must** have its `type` set to `https://serverlessworkflow.io/spec/1.0.0/errors/timeout` and **should** have its `status` set to `408`. + +### Catalogs + +A **resource catalog** is an external collection of reusable components, such as functions, that can be referenced and imported into workflows. The primary purpose of catalogs is to allow workflows to seamlessly integrate with externally defined resources, facilitating better reuse, versioning, and consistency across multiple workflows. + +Each catalog is defined by an `endpoint` property that specifies the root URL where the resources are hosted. This enables workflows to access external functions and services from those catalogs. + +#### File Structure + +To ensure portability and standardization, catalogs must follow a specific file structure, which is documented [here](https://github.com/serverlessworkflow/catalog?tab=readme-ov-file#structure). This file structure ensures that runtimes can correctly interpret and resolve the resources contained within a catalog. + +If a catalog is hosted in a GitHub or GitLab repository, runtimes are expected to resolve the **raw** machine-readable documents that define the cataloged resources. For example, for the function `log:1.0.0` located in a catalog at `https://github.com/serverlessworkflow/catalog/tree/main`, the function definition URI: + +``` +https://github.com/serverlessworkflow/catalog/tree/main/functions/log/1.0.0/function.yaml +``` + +Should be transformed by the runtime to point to the raw content of the document: + +``` +https://raw.githubusercontent.com/serverlessworkflow/catalog/refs/heads/main/functions/log/1.0.0/function.yaml +``` + +This transformation ensures that runtimes can retrieve and process the actual content of the resource definitions in a machine-readable format. It also ensures that authors can use the standard, user-friendly URIs of such Git repositories, making it easier to reference and manage resources without needing to directly use the raw content links. + +#### Default Catalog + +Runtimes may optionally define a **"default" catalog**, which can be used implicitly by any and all workflows, unlike other catalogs which must be explicitly defined at the top level. The default catalog provides authors with a way to define and publish functions directly to their runtime, without any additional overhead or external dependencies. + +When using the default catalog, users follow the same format as described above, but with the reserved name `default` for the catalog: + +``` +{functionName}:{functionVersion}@default +``` + +This allows workflows to call functions from the default catalog without needing to explicitly define it in the workflow definition. + +It's important to note that the name `default` should not be used by catalogs explicitly defined at the top level, unless the intent is to override the runtime's default catalog. How resources in the default catalog are stored and resolved is entirely up to the runtime, and they could be managed in various ways, such as in a database, as files, in configuration settings, or within a remote dedicated repository. + +#### Using Cataloged Functions + +When calling a custom function defined in a catalog, users must follow a specific format: + +``` +{functionName}:{functionVersion}@{catalogName} +``` + +This format ensures that the function, its version, and the catalog it belongs to are clearly defined, allowing workflows to differentiate between multiple functions with similar names across different catalogs. + +*Calling a custom function defined within a catalog:* +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: catalog-example + version: '0.1.0' +use: + catalogs: + global: + endpoint: + uri: https://github.com/serverlessworkflow/catalog + authentication: + basic: + username: user + password: '012345' +do: + - log: + call: log:0.5.2@global + with: + message: The cataloged custom function has been successfully called +``` + +### Interoperability + +Serverless Workflow DSL is designed to seamlessly interact with a variety of services, ensuring robust service interoperability. + +#### Supported Protocols + +- [**HTTP**](dsl-reference.md#http-call): Allows the workflow to make standard HTTP requests to web services. This is useful for RESTful services and web APIs that communicate over the HTTP protocol. +- [**gRPC**](dsl-reference.md#grpc-call): Supports Remote Procedure Call (RPC) using gRPC, a high-performance, open-source universal RPC framework. This is suitable for connecting to services that require low-latency and high-throughput communication. +- [**AsyncAPI**](dsl-reference.md#asyncapi-call): Facilitates interaction with asynchronous messaging protocols. AsyncAPI is designed for event-driven architectures, allowing workflows to publish and subscribe to events. +- [**OpenAPI**](dsl-reference.md#openapi-call): Enables communication with services that provide OpenAPI specifications, which is useful for defining and consuming RESTful APIs. + +Runtimes **must** raise an error with type `https://serverlessworkflow.io/spec/1.0.0/errors/communication` if and when a problem occurs during a call. + +#### Custom and Non-Standard Interactions + + In addition to the default supported protocols, the DSL also provides mechanisms to interact with services in non-standard or unsupported ways using custom processes. This flexibility allows workflows to extend their capabilities beyond the built-in protocols and integrate with any service, regardless of the communication method. + +For custom interactions, the workflow can define [tasks](dsl-reference.md#run) that [execute shell commands](dsl-reference.md#shell-process), [execute scripts](dsl-reference.md#script-process) or [run containers](dsl-reference.md#container-process) to handle unique service communication requirements. This ensures that the workflow can still maintain interoperability even with services that do not adhere to the standard supported protocols. + +##### Creating a Custom Function + +Serverless Workflow DSL supports the creation and publication of custom functions to extend the DSL capabilities. + +Custom functions allow you to define specific tasks and interactions that are not covered by the default supported protocols. + +Hereās how you can define and use custom functions within your workflows: + +1. In your repository, create a new directory for your function, for example, `/serverless-workflow/functions/my-custom-function`. It is strongly recommended that custom function authors include the semantic version of the function in its path. For instance, you might structure the path as `/serverless-workflow/functions/my-custom-function/1.0.0` to reflect the function's version. + +2. Create a `function.yaml` file containing the [function's definition](dsl-reference.md#task). Ideally, the function should document both its input and output. This is important for documentation and validation purposes. + +```yaml +#function.yaml +input: + schema: + document: + type: object + description: The function's input + properties: + emailAddress: + type: string + description: The email address to validate. +output: + schema: + document: + type: object + description: The function's output + properties: + isValid: + type: boolean + description: A boolean indicating whether or not the email address is valid. +run: + script: + language: javascript + code: | + function validateEmail(email) { + const re = /^[a-zA-Z0-9._-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,6}$/; + return re.test(email); + } + return { isValid: validateEmail(emailAddress) }; + arguments: + emailAddress: ${ .emailAddress } +``` + +3. Optionally, add all the local files your function might need into its directory. + +4. Commit and push your function to your repository. + +5. Optionally, submit your function to the [Serverless Workflow Catalog](https://github.com/serverlessworkflow/catalog), allowing users to find your function. + +For more information about authoring a new custom function, visit the [Serverless Workflow Catalog](https://github.com/serverlessworkflow/catalog). + +##### Using a Custom Function + +Once a custom function is defined, it can be used within a workflow to perform specific tasks. + +The following example demonstrates how to use the `validateEmailAddress` custom function in a workflow. + +```yaml +# workflow.yaml +document: + dsl: '1.0.0-alpha5' + namespace: default + name: customFunctionWorkflow + version: '0.1.0' +do: + - validateEmail: + call: https://github.com/myorg/functions/validateEmailAddress@v1.0.0 + with: + emailAddress: ${ .userEmail } +``` + +##### Publishing a Custom Function + +Consider submitting your function to the [Serverless Workflow Function Catalog](https://github.com/serverlessworkflow/catalog). + +This optional step allows users to discover and utilize your function, enhancing its visibility and usability within the Serverless Workflow community. By registering your function, you contribute to a shared repository of resources that can streamline workflow development for others. + +For detailed instructions on how to contribute your custom function, please refer to the [CONTRIBUTING.md](https://github.com/serverlessworkflow/catalog/blob/main/CONTRIBUTING.md) file. + +### Events + +Events play a crucial role in Serverless Workflow by facilitating communication and coordination between different components and services. They enable workflows to react to external stimuli, paving the way for event-driven architectures and real-time processing scenarios. Events are essentially messages that convey information about a specific occurrence or action, allowing workflows to respond dynamically to changes in their environment. + +Events in Serverless Workflow adhere to the [Cloud Events specification](https://cloudevents.io/), ensuring interoperability and compatibility with event-driven systems. This standardization allows workflows to seamlessly interact with various event sources and consumers across different platforms and environments. + +#### Emitting Events + +The Emit task allows workflows to publish events to event brokers or messaging systems. This capability enables workflows to broadcast notifications about various events, such as order placements, data updates, or system events. + +By emitting events, workflows can seamlessly integrate with event-driven architectures, facilitating event-driven decision-making and enabling reactive behavior based on incoming events. For example, a workflow handling order processing might emit an event signaling the successful placement of an order, triggering downstream processes like inventory management or shipping. + +See the [DSL reference](dsl-reference.md#emit) for more details about emit tasks. + +#### Listening for Events + +The Listen task provides a mechanism for workflows to await and react to external events. It enables workflows to subscribe to specific event types or patterns and trigger actions based on incoming events. + +This capability allows workflows to implement event-driven behavior, where they respond dynamically to changes in their environment. For instance, a workflow responsible for monitoring vital signs in a healthcare application might listen for temperature or heart rate measurements. Upon receiving such measurements, the workflow can perform actions like alerting medical staff or updating patient records. + +In summary, events in Serverless Workflow serve as the foundation for building event-driven architectures and enable workflows to communicate, coordinate, and react to changes in their environment effectively. They empower workflows to operate in real-time, making them well-suited for scenarios requiring dynamic, responsive behavior. + +See the [DSL reference](dsl-reference.md#listen) for more details about listen tasks. + +### Extensions + +Extensions in Serverless Workflow offer a flexible way to extend the functionality of tasks within a workflow. They allow developers to inject custom logic, perform pre- or post-processing tasks, and modify task behavior dynamically based on runtime conditions. With extensions, developers can enhance workflow capabilities, promote code reuse, and maintain consistency across workflows. + +For example, extensions can be used to: + +1. Perform logging before and after task execution. +2. Intercept HTTP calls to mock service responses. +3. Implement custom error handling or retries. +4. Apply security checks or data transformations. + +Extensions are defined with properties such as `extend`, `when`, `before`, and `after`, providing precise control over their application. Here's a brief summary: + +- **`extend`**: Specifies the type of task to extend. +- **`when`**: Conditionally applies the extension based on runtime expressions. +- **`before`**: Executes tasks before the extended task. +- **`after`**: Executes tasks after the extended task completes. + +Overall, extensions empower developers to build complex workflows with enhanced functionality and maintainability, making Serverless Workflow a powerful tool for orchestrating cloud-native applications. + +See the [DSL reference](dsl-reference.md#extension) for more details about extensions. + +*Sample logging extension:* +```yaml +document: + dsl: '1.0.0-alpha5' + namespace: test + name: sample-workflow + version: '0.1.0' +use: + extensions: + logging: + extend: all + before: + - sendLog: + call: http + with: + method: post + uri: https://fake.log.collector.com + body: + message: "${ \"Executing task '\($task.reference)'...\" }" + after: + - sendLog: + call: http + with: + method: post + uri: https://fake.log.collector.com + body: + message: "${ \"Executed task '\($task.reference)'...\" }" +do: + - sampleTask: + call: http + with: + method: get + uri: https://fake.com/sample +``` + +### External Resources + +External resources in Serverless Workflow allow you to define and access external assets or services required for workflow execution. + +These resources can include APIs, databases, files, or any other external entities needed by the workflow. Each external resource can be identified by a unique name and is associated with a URI that specifies its location. + +Optionally, you can specify an authentication policy to ensure secure access to the resource. For instance, you can use basic authentication with a username and password, or you can reference a pre-configured authentication policy by name. + +By defining external resources within the workflow, you centralize resource management and streamline access to external dependencies, enhancing the modularity and maintainability of your workflows. + +### Authentication + +Authentication in Serverless Workflow specifies the method by which the workflow accesses protected resources or services. + +Amonst others, [external resources](dsl-reference.md#external-resource) and [calls](dsl-reference.md#call) may define authentication. + +The Serverless Workflow DSL supports a suite of standard authentication mechanisms, amongst which are: + +- **Basic Authentication**: Utilizes a username-password pair for authentication. +```yaml +sampleBasic: + basic: + username: admin + password: 123 +``` + +- **Bearer Authentication**: Uses a bearer token for authentication. +```yaml +sampleBearer: + bearer: ${ .user.token } +``` + +- **OAuth2 Authentication**: Implements OAuth2 authorization framework for secure access. +```yaml +sampleOAuth2: + oauth2: + authority: http://keycloak/realms/fake-authority/.well-known/openid-configuration + grant: client-credentials + client: + id: workflow-runtime + secret: workflow-runtime-client-secret + scopes: [ api ] + audiences: [ runtime ] +``` + +These authentication schemes can be defined globally in the authentication section or associated with specific endpoints. They provide secure access to resources while ensuring proper authorization and identity verification. + +See the [DSL reference](dsl-reference.md#authentication) for more details about authentication. \ No newline at end of file diff --git a/examples/README.md b/examples/README.md index 1d815d42..de9599a0 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,4946 +1,11 @@ - # Examples -Provides Serverless Workflow language examples +Welcome to the Serverless Workflow Examples directory! This section contains a collection of brief YAML files, each representing a single workflow definition. -## Table of Contents +These examples are designed to demonstrate specific features and functionalities of the Serverless Workflow DSL. They serve as a practical reference to help you understand and implement different aspects of Serverless Workflows in your projects. -- [Hello World](#Hello-World-Example) -- [Greeting](#Greeting-Example) -- [Event-based greeting (Event State)](#Event-Based-Greeting-Example) -- [Solving Math Problems (ForEach state)](#Solving-Math-Problems-Example) -- [Parallel Execution](#Parallel-Execution-Example) -- [Async Function Invocation](#Async-Function-Invocation-Example) -- [Async SubFlow Invocation](#Async-SubFlow-Invocation-Example) -- [Event Based Transitions (Event-based Switch)](#Event-Based-Transitions-Example) -- [Applicant Request Decision (Data-based Switch + SubFlows)](#Applicant-Request-Decision-Example) -- [Provision Orders (Error Handling)](#Provision-Orders-Example) -- [Monitor Job for completion (Polling)](#Monitor-Job-Example) -- [Send CloudEvent on Workflow Completion](#Send-CloudEvent-On-Workflow-Completion-Example) -- [Monitor Patient Vital Signs (Event state)](#Monitor-Patient-Vital-Signs-Example) -- [Finalize College Application (Event state)](#Finalize-College-Application-Example) -- [Perform Customer Credit Check (Callback state)](#Perform-Customer-Credit-Check-Example) -- [Handle Car Auction Bids (Scheduled start Event state)](#Handle-Car-Auction-Bids-Example) -- [Check Inbox Periodically (Cron-based Workflow start)](#Check-Inbox-Periodically) -- [Event-based service invocation (Event triggered actions)](#Event-Based-Service-Invocation) -- [Reusing Function and Event Definitions](#Reusing-Function-And-Event-Definitions) -- [New Patient Onboarding (Error checking and Retries)](#New-Patient-Onboarding) -- [Purchase order deadline (ExecTimeout)](#Purchase-order-deadline) -- [Accumulate room readings and create timely reports (ExecTimeout and KeepActive)](#Accumulate-room-readings) -- [Car vitals checks (SubFlow Repeat)](#Car-Vitals-Checks) -- [Book Lending Workflow](#Book-Lending) -- [Filling a glass of water (Expression functions)](#Filling-a-glass-of-water) -- [Online Food Ordering](#Online-Food-Ordering) -- [Continuing as a new Execution](#Continuing-as-a-new-Execution) -- [Process Transactions (Foreach State with conditions)](#Process-Transactions) +## Contributing -### Hello World Example +We welcome contributions! If you have an example demonstrating a unique feature or use case of Serverless Workflow, feel free to submit a pull request. -#### Description - -In this simple example we use an [Inject State](../specification.md#Inject-State) to inject -`Hello World` in the states data (as the value of the 'result' property). -After the state execution completes, since it is an end state, its data output becomes the workflow -data output, which is: - -```json -{ - "result": "Hello World" -} -``` - -#### Workflow Diagram - -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "helloworld", - "version": "1.0.0", - "specVersion": "0.8", - "name": "Hello World Workflow", - "description": "Inject Hello World", - "start": "hello-state", - "states": [ - { - "name": "hello-state", - "type": "inject", - "data": { - "result": "Hello World!" - }, - "end": true - } - ] -}``` - - | -- -```yaml -id: helloworld -version: 1.0.0 -specVersion: "0.8" -name: Hello World Workflow -description: Inject Hello World -start: hello-state -states: - - name: hello-state - type: inject - data: - result: Hello World! - end: true -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "greeting", - "version": "1.0.0", - "specVersion": "0.8", - "name": "greeting-workflow", - "description": "Greet Someone", - "start": "greet", - "functions": [ - { - "name": "greeting-function", - "type": "openapi", - "operation": "file://myapis/greetingapis.json#greeting" - } - ], - "states": [ - { - "name": "greet", - "type": "operation", - "actions": [ - { - "name": "greet-action", - "functionRef": { - "refName": "greeting-function", - "arguments": { - "name": "${ .person.name }" - } - }, - "actionDataFilter": { - "results": "${ {greeting: .greeting} }" - } - } - ], - "end": true - } - ] -}``` - - | -- -```yaml -id: greeting -version: 1.0.0 -specVersion: "0.8" -name: greeting-workflow -description: Greet Someone -start: greet -functions: - - name: greeting-function - type: openapi - operation: file://myapis/greetingapis.json#greeting -states: - - name: greet - type: operation - actions: - - name: greet-action - functionRef: - refName: greeting-function - arguments: - name: ${ .person.name } - actionDataFilter: - results: "${ {greeting: .greeting} }" - end: true -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "eventbasedgreeting", - "version": "1.0.0", - "specVersion": "0.8", - "name": "Event Based Greeting Workflow", - "description": "Event Based Greeting", - "start": "greet", - "events": [ - { - "name": "greeting-event", - "type": "greetingEventType", - "source": "greetingEventSource" - } - ], - "functions": [ - { - "name": "greeting-function", - "operation": "file://myapis/greetingapis.json#greeting" - } - ], - "states": [ - { - "name": "greet", - "type": "event", - "onEvents": [ - { - "eventRefs": [ - "greeting-event" - ], - "eventDataFilter": { - "data": "${ .greet }", - "toStateData": "${ .greet }" - }, - "actions": [ - { - "name": "greet-action", - "functionRef": { - "refName": "greeting-function", - "arguments": { - "name": "${ .greet.name }" - } - } - } - ] - } - ], - "stateDataFilter": { - "output": "${ .payload.greeting }" - }, - "end": true - } - ] -}``` - - | -- -```yaml -id: eventbasedgreeting -version: 1.0.0 -specVersion: "0.8" -name: Event Based Greeting Workflow -description: Event Based Greeting -start: greet -events: - - name: greeting-event - type: greetingEventType - source: greetingEventSource -functions: - - name: greeting-function - operation: file://myapis/greetingapis.json#greeting -states: - - name: greet - type: event - onEvents: - - eventRefs: - - greeting-event - eventDataFilter: - data: ${ .greet } - toStateData: ${ .greet } - actions: - - name: greet-action - functionRef: - refName: greeting-function - arguments: - name: ${ .greet.name } - stateDataFilter: - output: ${ .payload.greeting } - end: true -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "solvemathproblems", - "version": "1.0.0", - "specVersion": "0.8", - "name": "solve-math-problems-workflow", - "description": "Solve math problems", - "start": "solve", - "functions": [ - { - "name": "solve-math-exp-func", - "operation": "http://myapis.org/mapthapis.json#solveExpression" - } - ], - "states": [ - { - "name": "solve", - "type": "foreach", - "inputCollection": "${ .expressions }", - "iterationParam": "singleexpression", - "outputCollection": "${ .results }", - "actions": [ - { - "name": "solve-action", - "functionRef": { - "refName": "solve-math-exp-func", - "arguments": { - "expression": "${ .singleexpression }" - } - } - } - ], - "stateDataFilter": { - "output": "${ .results }" - }, - "end": true - } - ] -}``` - - | -- -```yaml -id: solvemathproblems -version: 1.0.0 -specVersion: "0.8" -name: solve-math-problems-workflow -description: Solve math problems -start: solve -functions: - - name: solve-math-exp-func - operation: http://myapis.org/mapthapis.json#solveExpression -states: - - name: solve - type: foreach - inputCollection: ${ .expressions } - iterationParam: singleexpression - outputCollection: ${ .results } - actions: - - name: solve-action - functionRef: - refName: solve-math-exp-func - arguments: - expression: ${ .singleexpression } - stateDataFilter: - output: ${ .results } - end: true -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "parallelexec", - "version": "1.0.0", - "specVersion": "0.8", - "name": "parallel-execution", - "description": "Executes two branches in parallel", - "start": "parallelexec", - "states": [ - { - "name": "parallelexec", - "type": "parallel", - "completionType": "allOf", - "branches": [ - { - "name": "short-delay-branch", - "actions": [ - { - "name": "short-delay-action", - "subFlowRef": "shortdelayworkflowid" - } - ] - }, - { - "name": "long-delay-branch", - "actions": [ - { - "name": "short-delay-action", - "subFlowRef": "longdelayworkflowid" - } - ] - } - ], - "end": true - } - ] -}``` - - | -- -```yaml -id: parallelexec -version: 1.0.0 -specVersion: "0.8" -name: parallel-execution -description: Executes two branches in parallel -start: parallelexec -states: - - name: parallelexec - type: parallel - completionType: allOf - branches: - - name: short-delay-branch - actions: - - name: short-delay-action - subFlowRef: shortdelayworkflowid - - name: long-delay-branch - actions: - - name: short-delay-action - subFlowRef: longdelayworkflowid - end: true -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "sendcustomeremail", - "version": "1.0.0", - "specVersion": "0.8", - "name": "send-customer-email-workflow", - "description": "Send email to a customer", - "start": "send-email", - "functions": [ - { - "name": "email-function", - "operation": "file://myapis/emailapis.json#sendEmail" - } - ], - "states": [ - { - "name": "send-email", - "type": "operation", - "actions": [ - { - "name": "send-email-action", - "functionRef": { - "invoke": "async", - "refName": "email-function", - "arguments": { - "customer": "${ .customer }" - } - } - } - ], - "end": true - } - ] -}``` - - | -- -```yaml -id: sendcustomeremail -version: 1.0.0 -specVersion: "0.8" -name: send-customer-email-workflow -description: Send email to a customer -start: send-email -functions: - - name: email-function - operation: file://myapis/emailapis.json#sendEmail -states: - - name: send-email - type: operation - actions: - - name: send-email-action - functionRef: - invoke: async - refName: email-function - arguments: - customer: ${ .customer } - end: true -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "onboardcustomer", - "version": "1.0.0", - "specVersion": "0.8", - "name": "onboard-customer", - "description": "Onboard a Customer", - "start": "onboard", - "states": [ - { - "name": "onboard", - "type": "operation", - "actions": [ - { - "name": "onboard-action", - "subFlowRef": { - "invoke": "async", - "onParentComplete": "continue", - "workflowId": "customeronboardingworkflow", - "version": "1.0.0" - } - } - ], - "end": true - } - ] -}``` - - | -- -```yaml -id: onboardcustomer -version: 1.0.0 -specVersion: "0.8" -name: onboard-customer -description: Onboard a Customer -start: onboard -states: - - name: onboard - type: operation - actions: - - name: onboard-action - subFlowRef: - invoke: async - onParentComplete: continue - workflowId: customeronboardingworkflow - version: 1.0.0 - end: true -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "eventbasedswitchstate", - "version": "1.0.0", - "specVersion": "0.8", - "name": "event-based-switch-transitions", - "description": "Event Based Switch Transitions", - "start": "checkvisastatus", - "events": [ - { - "name": "visa-approved-event", - "type": "VisaApproved", - "source": "visaCheckSource" - }, - { - "name": "visa-rejected-event", - "type": "VisaRejected", - "source": "visaCheckSource" - } - ], - "states": [ - { - "name": "checkvisastatus", - "type": "switch", - "eventConditions": [ - { - "eventRef": "visa-approved-event", - "transition": "handle-approved-visa", - "name": "approved-condition" - }, - { - "eventRef": "visa-rejected-event", - "transition": "handle-rejected-visa", - "name": "rejected-condition" - } - ], - "timeouts": { - "eventTimeout": "PT1H" - }, - "defaultCondition": { - "transition": "handle-no-visa-decision" - } - }, - { - "name": "handle-approved-visa", - "type": "operation", - "actions": [ - { - "name": "handle-approved-action", - "subFlowRef": "handleApprovedVisaWorkflowID" - } - ], - "end": true - }, - { - "name": "handle-rejected-visa", - "type": "operation", - "actions": [ - { - "name": "handle-rejected-action", - "subFlowRef": "handleRejectedVisaWorkflowID" - } - ], - "end": true - }, - { - "name": "handle-no-visa-decision", - "type": "operation", - "actions": [ - { - "name": "handle-novisa-action", - "subFlowRef": "handleNoVisaDecisionWorkflowId" - } - ], - "end": true - } - ] -}``` - - | -- -```yaml -id: eventbasedswitchstate -version: 1.0.0 -specVersion: "0.8" -name: event-based-switch-transitions -description: Event Based Switch Transitions -start: checkvisastatus -events: - - name: visa-approved-event - type: VisaApproved - source: visaCheckSource - - name: visa-rejected-event - type: VisaRejected - source: visaCheckSource -states: - - name: checkvisastatus - type: switch - eventConditions: - - eventRef: visa-approved-event - transition: handle-approved-visa - name: approved-condition - - eventRef: visa-rejected-event - transition: handle-rejected-visa - name: rejected-condition - timeouts: - eventTimeout: PT1H - defaultCondition: - transition: handle-no-visa-decision - - name: handle-approved-visa - type: operation - actions: - - name: handle-approved-action - subFlowRef: handleApprovedVisaWorkflowID - end: true - - name: handle-rejected-visa - type: operation - actions: - - name: handle-rejected-action - subFlowRef: handleRejectedVisaWorkflowID - end: true - - name: handle-no-visa-decision - type: operation - actions: - - name: handle-novisa-action - subFlowRef: handleNoVisaDecisionWorkflowId - end: true -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "applicantrequest", - "version": "1.0.0", - "specVersion": "0.8", - "name": "applicant-request-decision-workflow", - "description": "Determine if applicant request is valid", - "start": "check-application", - "functions": [ - { - "name": "send-rejection-email-function", - "operation": "http://myapis.org/applicationapi.json#emailRejection" - } - ], - "states": [ - { - "name": "check-application", - "type": "switch", - "dataConditions": [ - { - "condition": "${ .applicants | .age >= 18 }", - "transition": "start-application", - "name": "adult-condition" - }, - { - "condition": "${ .applicants | .age < 18 }", - "transition": "reject-application", - "name": "minor-condition" - } - ], - "defaultCondition": { - "transition": "reject-application" - } - }, - { - "name": "start-application", - "type": "operation", - "actions": [ - { - "name": "start-app-action", - "subFlowRef": "startApplicationWorkflowId" - } - ], - "end": true - }, - { - "name": "reject-application", - "type": "operation", - "actionMode": "sequential", - "actions": [ - { - "name": "send-reject-action", - "functionRef": { - "refName": "send-rejection-email-function", - "arguments": { - "applicant": "${ .applicant }" - } - } - } - ], - "end": true - } - ] -}``` - - | -- -```yaml -id: applicantrequest -version: 1.0.0 -specVersion: "0.8" -name: applicant-request-decision-workflow -description: Determine if applicant request is valid -start: check-application -functions: - - name: send-rejection-email-function - operation: http://myapis.org/applicationapi.json#emailRejection -states: - - name: check-application - type: switch - dataConditions: - - condition: ${ .applicants | .age >= 18 } - transition: start-application - name: adult-condition - - condition: ${ .applicants | .age < 18 } - transition: reject-application - name: minor-condition - defaultCondition: - transition: reject-application - - name: start-application - type: operation - actions: - - name: start-app-action - subFlowRef: startApplicationWorkflowId - end: true - - name: reject-application - type: operation - actionMode: sequential - actions: - - name: send-reject-action - functionRef: - refName: send-rejection-email-function - arguments: - applicant: ${ .applicant } - end: true -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "provisionorders", - "version": "1.0.0", - "specVersion": "0.8", - "name": "provision-orders", - "description": "Provision Orders and handle errors thrown", - "start": "provision-order", - "functions": [ - { - "name": "provision-order-function", - "operation": "http://myapis.org/provisioningapi.json#doProvision" - } - ], - "errors": [ - { - "name": "missing-order-id" - }, - { - "name": "missing-order-item" - }, - { - "name": "missing-order-quantity" - } - ], - "states": [ - { - "name": "provision-order", - "type": "operation", - "actionMode": "sequential", - "actions": [ - { - "name": "provision-action", - "functionRef": { - "refName": "provision-order-function", - "arguments": { - "order": "${ .order }" - } - } - } - ], - "stateDataFilter": { - "output": "${ .exceptions }" - }, - "transition": "apply-order", - "onErrors": [ - { - "errorRef": "missing-order-id", - "transition": "missing-id" - }, - { - "errorRef": "missing-order-item", - "transition": "missing-item" - }, - { - "errorRef": "missing-order-quantity", - "transition": "missing-quantity" - } - ] - }, - { - "name": "missing-id", - "type": "operation", - "actions": [ - { - "name": "missing-action", - "subFlowRef": "handleMissingIdExceptionWorkflow" - } - ], - "end": true - }, - { - "name": "missing-item", - "type": "operation", - "actions": [ - { - "name": "missing-item", - "subFlowRef": "handleMissingItemExceptionWorkflow" - } - ], - "end": true - }, - { - "name": "missing-quantity", - "type": "operation", - "actions": [ - { - "name": "missing-quantity", - "subFlowRef": "handleMissingQuantityExceptionWorkflow" - } - ], - "end": true - }, - { - "name": "apply-order", - "type": "operation", - "actions": [ - { - "name": "apply-order", - "subFlowRef": "applyOrderWorkflowId" - } - ], - "end": true - } - ] -}``` - - | -- -```yaml -id: provisionorders -version: 1.0.0 -specVersion: "0.8" -name: provision-orders -description: Provision Orders and handle errors thrown -start: provision-order -functions: - - name: provision-order-function - operation: http://myapis.org/provisioningapi.json#doProvision -errors: - - name: missing-order-id - - name: missing-order-item - - name: missing-order-quantity -states: - - name: provision-order - type: operation - actionMode: sequential - actions: - - name: provision-action - functionRef: - refName: provision-order-function - arguments: - order: ${ .order } - stateDataFilter: - output: ${ .exceptions } - transition: apply-order - onErrors: - - errorRef: missing-order-id - transition: missing-id - - errorRef: missing-order-item - transition: missing-item - - errorRef: missing-order-quantity - transition: missing-quantity - - name: missing-id - type: operation - actions: - - name: missing-action - subFlowRef: handleMissingIdExceptionWorkflow - end: true - - name: missing-item - type: operation - actions: - - name: missing-item - subFlowRef: handleMissingItemExceptionWorkflow - end: true - - name: missing-quantity - type: operation - actions: - - name: missing-quantity - subFlowRef: handleMissingQuantityExceptionWorkflow - end: true - - name: apply-order - type: operation - actions: - - name: apply-order - subFlowRef: applyOrderWorkflowId - end: true -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "jobmonitoring", - "version": "1.0.0", - "specVersion": "0.8", - "name": "jobmonitoring", - "description": "Monitor finished execution of a submitted job", - "start": "submit-job", - "functions": [ - { - "name": "submit-job", - "operation": "http://myapis.org/monitorapi.json#doSubmit" - }, - { - "name": "check-job-status", - "operation": "http://myapis.org/monitorapi.json#checkStatus" - }, - { - "name": "report-job-suceeded", - "operation": "http://myapis.org/monitorapi.json#reportSucceeded" - }, - { - "name": "report-job-failed", - "operation": "http://myapis.org/monitorapi.json#reportFailure" - } - ], - "states": [ - { - "name": "submit-job", - "type": "operation", - "actionMode": "sequential", - "actions": [ - { - "name": "submit-job", - "functionRef": { - "refName": "submit-job", - "arguments": { - "name": "${ .job.name }" - } - }, - "actionDataFilter": { - "results": "${ .jobuid }" - } - } - ], - "stateDataFilter": { - "output": "${ .jobuid }" - }, - "transition": "wait-for-completion" - }, - { - "name": "wait-for-completion", - "type": "sleep", - "duration": "PT5S", - "transition": "get-job-status" - }, - { - "name": "get-job-status", - "type": "operation", - "actionMode": "sequential", - "actions": [ - { - "name": "get-job-status", - "functionRef": { - "refName": "check-job-status", - "arguments": { - "name": "${ .jobuid }" - } - }, - "actionDataFilter": { - "results": "${ .jobstatus }" - } - } - ], - "stateDataFilter": { - "output": "${ .jobstatus }" - }, - "transition": "determine-completion" - }, - { - "name": "determine-completion", - "type": "switch", - "dataConditions": [ - { - "condition": "${ .jobStatus == \"SUCCEEDED\" }", - "transition": "job-succeeded", - "name": "succeed" - }, - { - "condition": "${ .jobStatus == \"FAILED\" }", - "transition": "job-failed", - "name": "failed" - } - ], - "defaultCondition": { - "transition": "wait-for-completion" - } - }, - { - "name": "job-succeeded", - "type": "operation", - "actionMode": "sequential", - "actions": [ - { - "name": "job-succeeded", - "functionRef": { - "refName": "report-job-suceeded", - "arguments": { - "name": "${ .jobuid }" - } - } - } - ], - "end": true - }, - { - "name": "job-failed", - "type": "operation", - "actionMode": "sequential", - "actions": [ - { - "name": "job-failed", - "functionRef": { - "refName": "report-job-failed", - "arguments": { - "name": "${ .jobuid }" - } - } - } - ], - "end": true - } - ] -}``` - - | -- -```yaml -id: jobmonitoring -version: 1.0.0 -specVersion: "0.8" -name: jobmonitoring -description: Monitor finished execution of a submitted job -start: submit-job -functions: - - name: submit-job - operation: http://myapis.org/monitorapi.json#doSubmit - - name: check-job-status - operation: http://myapis.org/monitorapi.json#checkStatus - - name: report-job-suceeded - operation: http://myapis.org/monitorapi.json#reportSucceeded - - name: report-job-failed - operation: http://myapis.org/monitorapi.json#reportFailure -states: - - name: submit-job - type: operation - actionMode: sequential - actions: - - name: submit-job - functionRef: - refName: submit-job - arguments: - name: ${ .job.name } - actionDataFilter: - results: ${ .jobuid } - stateDataFilter: - output: ${ .jobuid } - transition: wait-for-completion - - name: wait-for-completion - type: sleep - duration: PT5S - transition: get-job-status - - name: get-job-status - type: operation - actionMode: sequential - actions: - - name: get-job-status - functionRef: - refName: check-job-status - arguments: - name: ${ .jobuid } - actionDataFilter: - results: ${ .jobstatus } - stateDataFilter: - output: ${ .jobstatus } - transition: determine-completion - - name: determine-completion - type: switch - dataConditions: - - condition: ${ .jobStatus == "SUCCEEDED" } - transition: job-succeeded - name: succeed - - condition: ${ .jobStatus == "FAILED" } - transition: job-failed - name: failed - defaultCondition: - transition: wait-for-completion - - name: job-succeeded - type: operation - actionMode: sequential - actions: - - name: job-succeeded - functionRef: - refName: report-job-suceeded - arguments: - name: ${ .jobuid } - end: true - - name: job-failed - type: operation - actionMode: sequential - actions: - - name: job-failed - functionRef: - refName: report-job-failed - arguments: - name: ${ .jobuid } - end: true -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "sendcloudeventonprovision", - "version": "1.0.0", - "specVersion": "0.8", - "name": "sendcloudeventonprovision", - "start": "provision-orders-state", - "events": [ - { - "name": "provisioning-complete-event", - "type": "provisionCompleteType", - "kind": "produced" - } - ], - "functions": [ - { - "name": "provision-order-function", - "operation": "http://myapis.org/provisioning.json#doProvision" - } - ], - "states": [ - { - "name": "provision-orders-state", - "type": "foreach", - "inputCollection": "${ .orders }", - "iterationParam": "singleorder", - "outputCollection": "${ .provisionedOrders }", - "actions": [ - { - "name": "provision-order-function", - "functionRef": { - "refName": "provision-order-function", - "arguments": { - "order": "${ .singleorder }" - } - } - } - ], - "end": { - "produceEvents": [ - { - "eventRef": "provisioning-complete-event", - "data": "${ .provisionedOrders }" - } - ] - } - } - ] -}``` - - | -- -```yaml -id: sendcloudeventonprovision -version: 1.0.0 -specVersion: "0.8" -name: sendcloudeventonprovision -start: provision-orders-state -events: - - name: provisioning-complete-event - type: provisionCompleteType - kind: produced -functions: - - name: provision-order-function - operation: http://myapis.org/provisioning.json#doProvision -states: - - name: provision-orders-state - type: foreach - inputCollection: ${ .orders } - iterationParam: singleorder - outputCollection: ${ .provisionedOrders } - actions: - - name: provision-order-function - functionRef: - refName: provision-order-function - arguments: - order: ${ .singleorder } - end: - produceEvents: - - eventRef: provisioning-complete-event - data: ${ .provisionedOrders } -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "patientVitalsWorkflow", - "name": "patientVitalsWorkflow", - "version": "1.0.0", - "specVersion": "0.8", - "start": "monitor-vitals", - "events": [ - { - "name": "high-body-temperature", - "type": "org.monitor.highBodyTemp", - "source": "monitoringSource", - "correlation": [ - { - "contextAttributeName": "patientId" - } - ] - }, - { - "name": "high-blood-pressure", - "type": "org.monitor.highBloodPressure", - "source": "monitoringSource", - "correlation": [ - { - "contextAttributeName": "patientId" - } - ] - }, - { - "name": "high-respiration-rate", - "type": "org.monitor.highRespirationRate", - "source": "monitoringSource", - "correlation": [ - { - "contextAttributeName": "patientId" - } - ] - } - ], - "functions": [ - { - "name": "call-pulmonologist", - "operation": "http://myapis.org/patientapis.json#callPulmonologist" - }, - { - "name": "send-tylenol-order", - "operation": "http://myapis.org/patientapis.json#tylenolOrder" - }, - { - "name": "call-nurse", - "operation": "http://myapis.org/patientapis.json#callNurse" - } - ], - "states": [ - { - "name": "monitor-vitals", - "type": "event", - "exclusive": true, - "onEvents": [ - { - "eventRefs": [ - "high-body-temperature" - ], - "actions": [ - { - "name": "send-tylenol-order", - "functionRef": { - "refName": "send-tylenol-order", - "arguments": { - "patientid": "${ .patientId }" - } - } - } - ] - }, - { - "eventRefs": [ - "high-blood-pressure" - ], - "actions": [ - { - "name": "call-nurse", - "functionRef": { - "refName": "call-nurse", - "arguments": { - "patientid": "${ .patientId }" - } - } - } - ] - }, - { - "eventRefs": [ - "high-respiration-rate" - ], - "actions": [ - { - "name": "call-pulmonologist", - "functionRef": { - "refName": "call-pulmonologist", - "arguments": { - "patientid": "${ .patientId }" - } - } - } - ] - } - ], - "end": { - "terminate": true - } - } - ] -}``` - - | -- -```yaml -id: patientVitalsWorkflow -name: patientVitalsWorkflow -version: 1.0.0 -specVersion: "0.8" -start: monitor-vitals -events: - - name: high-body-temperature - type: org.monitor.highBodyTemp - source: monitoringSource - correlation: - - contextAttributeName: patientId - - name: high-blood-pressure - type: org.monitor.highBloodPressure - source: monitoringSource - correlation: - - contextAttributeName: patientId - - name: high-respiration-rate - type: org.monitor.highRespirationRate - source: monitoringSource - correlation: - - contextAttributeName: patientId -functions: - - name: call-pulmonologist - operation: http://myapis.org/patientapis.json#callPulmonologist - - name: send-tylenol-order - operation: http://myapis.org/patientapis.json#tylenolOrder - - name: call-nurse - operation: http://myapis.org/patientapis.json#callNurse -states: - - name: monitor-vitals - type: event - exclusive: true - onEvents: - - eventRefs: - - high-body-temperature - actions: - - name: send-tylenol-order - functionRef: - refName: send-tylenol-order - arguments: - patientid: ${ .patientId } - - eventRefs: - - high-blood-pressure - actions: - - name: call-nurse - functionRef: - refName: call-nurse - arguments: - patientid: ${ .patientId } - - eventRefs: - - high-respiration-rate - actions: - - name: call-pulmonologist - functionRef: - refName: call-pulmonologist - arguments: - patientid: ${ .patientId } - end: - terminate: true -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "finalize-college-application", - "name": "finalizeCollegeApplication", - "version": "1.0.0", - "specVersion": "0.8", - "start": "finalize-application", - "events": [ - { - "name": "application-submitted", - "type": "org.application.submitted", - "source": "applicationsource", - "correlation": [ - { - "contextAttributeName": "applicantId" - } - ] - }, - { - "name": "sat-scores-received", - "type": "org.application.satscores", - "source": "applicationsource", - "correlation": [ - { - "contextAttributeName": "applicantId" - } - ] - }, - { - "name": "recommendation-letter-received", - "type": "org.application.recommendationLetter", - "source": "applicationsource", - "correlation": [ - { - "contextAttributeName": "applicantId" - } - ] - } - ], - "functions": [ - { - "name": "finalize-application-function", - "operation": "http://myapis.org/collegeapplicationapi.json#finalize" - } - ], - "states": [ - { - "name": "finalize-application", - "type": "event", - "exclusive": false, - "onEvents": [ - { - "eventRefs": [ - "application-submitted", - "sat-scores-received", - "recommendation-letter-received" - ], - "actions": [ - { - "name": "finalize-application", - "functionRef": { - "refName": "finalize-application-function", - "arguments": { - "student": "${ .applicantId }" - } - } - } - ] - } - ], - "end": { - "terminate": true - } - } - ] -}``` - - | -- -```yaml -id: finalize-college-application -name: finalizeCollegeApplication -version: 1.0.0 -specVersion: "0.8" -start: finalize-application -events: - - name: application-submitted - type: org.application.submitted - source: applicationsource - correlation: - - contextAttributeName: applicantId - - name: sat-scores-received - type: org.application.satscores - source: applicationsource - correlation: - - contextAttributeName: applicantId - - name: recommendation-letter-received - type: org.application.recommendationLetter - source: applicationsource - correlation: - - contextAttributeName: applicantId -functions: - - name: finalize-application-function - operation: http://myapis.org/collegeapplicationapi.json#finalize -states: - - name: finalize-application - type: event - exclusive: false - onEvents: - - eventRefs: - - application-submitted - - sat-scores-received - - recommendation-letter-received - actions: - - name: finalize-application - functionRef: - refName: finalize-application-function - arguments: - student: ${ .applicantId } - end: - terminate: true -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "customercreditcheck", - "version": "1.0.0", - "specVersion": "0.8", - "name": "customercreditcheck", - "description": "Perform Customer Credit Check", - "start": "check-credit", - "functions": [ - { - "name": "credit-check-function", - "operation": "http://myapis.org/creditcheckapi.json#doCreditCheck" - }, - { - "name": "send-rejection-email-function", - "operation": "http://myapis.org/creditcheckapi.json#rejectionEmail" - } - ], - "events": [ - { - "name": "credit-check-completed-event", - "type": "creditCheckCompleteType", - "source": "creditCheckSource", - "correlation": [ - { - "contextAttributeName": "customerId" - } - ] - } - ], - "states": [ - { - "name": "check-credit", - "type": "callback", - "action": { - "name": "check-credit", - "functionRef": { - "refName": "call-credit-check-microservice", - "arguments": { - "customer": "${ .customer }" - } - } - }, - "eventRef": "credit-check-completed-event", - "timeouts": { - "stateExecTimeout": "PT15M" - }, - "transition": "evaluate-decision" - }, - { - "name": "evaluate-decision", - "type": "switch", - "dataConditions": [ - { - "condition": "${ .creditCheck | .decision == \"Approved\" }", - "transition": "start-application", - "name": "start-application" - }, - { - "condition": "${ .creditCheck | .decision == \"Denied\" }", - "transition": "reject-application", - "name": "reject-application" - } - ], - "defaultCondition": { - "transition": "reject-application" - } - }, - { - "name": "start-application", - "type": "operation", - "actions": [ - { - "name": "start-application", - "subFlowRef": "startApplicationWorkflowId" - } - ], - "end": true - }, - { - "name": "reject-application", - "type": "operation", - "actionMode": "sequential", - "actions": [ - { - "name": "reject-application", - "functionRef": { - "refName": "send-rejection-email-function", - "arguments": { - "applicant": "${ .customer }" - } - } - } - ], - "end": true - } - ] -}``` - - | -- -```yaml -id: customercreditcheck -version: 1.0.0 -specVersion: "0.8" -name: customercreditcheck -description: Perform Customer Credit Check -start: check-credit -functions: - - name: credit-check-function - operation: http://myapis.org/creditcheckapi.json#doCreditCheck - - name: send-rejection-email-function - operation: http://myapis.org/creditcheckapi.json#rejectionEmail -events: - - name: credit-check-completed-event - type: creditCheckCompleteType - source: creditCheckSource - correlation: - - contextAttributeName: customerId -states: - - name: check-credit - type: callback - action: - name: check-credit - functionRef: - refName: call-credit-check-microservice - arguments: - customer: ${ .customer } - eventRef: credit-check-completed-event - timeouts: - stateExecTimeout: PT15M - transition: evaluate-decision - - name: evaluate-decision - type: switch - dataConditions: - - condition: ${ .creditCheck | .decision == "Approved" } - transition: start-application - name: start-application - - condition: ${ .creditCheck | .decision == "Denied" } - transition: reject-application - name: reject-application - defaultCondition: - transition: reject-application - - name: start-application - type: operation - actions: - - name: start-application - subFlowRef: startApplicationWorkflowId - end: true - - name: reject-application - type: operation - actionMode: sequential - actions: - - name: reject-application - functionRef: - refName: send-rejection-email-function - arguments: - applicant: ${ .customer } - end: true -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "handle-car-auction-bid", - "version": "1.0.0", - "specVersion": "0.8", - "name": "handle-car-auction-bid", - "description": "Store a single bid whole the car auction is active", - "start": { - "stateName": "store-car-auction-bid", - "schedule": "R/PT2H" - }, - "functions": [ - { - "name": "store-bid-function", - "operation": "http://myapis.org/carauctionapi.json#storeBid" - } - ], - "events": [ - { - "name": "car-bid-event", - "type": "carBidMadeType", - "source": "carBidEventSource" - } - ], - "states": [ - { - "name": "store-car-auction-bid", - "type": "event", - "exclusive": true, - "onEvents": [ - { - "eventRefs": [ - "car-bid-event" - ], - "actions": [ - { - "name": "car-bid-event", - "functionRef": { - "refName": "store-bid-function", - "arguments": { - "bid": "${ .bid }" - } - } - } - ] - } - ], - "end": true - } - ] -}``` - - | -- -```yaml -id: handle-car-auction-bid -version: 1.0.0 -specVersion: "0.8" -name: handle-car-auction-bid -description: Store a single bid whole the car auction is active -start: - stateName: store-car-auction-bid - schedule: R/PT2H -functions: - - name: store-bid-function - operation: http://myapis.org/carauctionapi.json#storeBid -events: - - name: car-bid-event - type: carBidMadeType - source: carBidEventSource -states: - - name: store-car-auction-bid - type: event - exclusive: true - onEvents: - - eventRefs: - - car-bid-event - actions: - - name: car-bid-event - functionRef: - refName: store-bid-function - arguments: - bid: ${ .bid } - end: true -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "check-inbox", - "name": "check-inbox", - "version": "1.0.0", - "specVersion": "0.8", - "description": "Periodically Check Inbox", - "start": { - "stateName": "check-inbox", - "schedule": { - "cron": "0 0/15 * * * ?" - } - }, - "functions": [ - { - "name": "check-inbox-function", - "operation": "http://myapis.org/inboxapi.json#checkNewMessages" - }, - { - "name": "send-text-function", - "operation": "http://myapis.org/inboxapi.json#sendText" - } - ], - "states": [ - { - "name": "check-inbox", - "type": "operation", - "actionMode": "sequential", - "actions": [ - { - "name":"check-inbox", - "functionRef": "check-inbox-function" - } - ], - "transition": "send-text-for-high-priority" - }, - { - "name": "send-text-for-high-priority", - "type": "foreach", - "inputCollection": "${ .messages }", - "iterationParam": "singlemessage", - "actions": [ - { - "name": "send-text-for-high-priority", - "functionRef": { - "refName": "send-text-function", - "arguments": { - "message": "${ .singlemessage }" - } - } - } - ], - "end": true - } - ] -}``` - - | -- -```yaml -id: check-inbox -name: check-inbox -version: 1.0.0 -specVersion: "0.8" -description: Periodically Check Inbox -start: - stateName: check-inbox - schedule: - cron: 0 0/15 * * * ? -functions: - - name: check-inbox-function - operation: http://myapis.org/inboxapi.json#checkNewMessages - - name: send-text-function - operation: http://myapis.org/inboxapi.json#sendText -states: - - name: check-inbox - type: operation - actionMode: sequential - actions: - - name: check-inbox - functionRef: check-inbox-function - transition: send-text-for-high-priority - - name: send-text-for-high-priority - type: foreach - inputCollection: ${ .messages } - iterationParam: singlemessage - actions: - - name: send-text-for-high-priority - functionRef: - refName: send-text-function - arguments: - message: ${ .singlemessage } - end: true -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "vet-appointment-workflow", - "name": "vet-appointment-workflow", - "description": "Vet service call via events", - "version": "1.0.0", - "specVersion": "0.8", - "start": "make-vet-appointment-state", - "events": [ - { - "name": "make-vet-appointment", - "source": "VetServiceSource", - "type": "events.vet.appointments", - "kind": "produced" - }, - { - "name": "vet-appointment-info", - "source": "VetServiceSource", - "type": "events.vet.appointments", - "kind": "consumed" - } - ], - "states": [ - { - "name": "make-vet-appointment-state", - "type": "operation", - "actions": [ - { - "name": "make-appointment-action", - "eventRef": { - "produceEventRef": "make-vet-appointment", - "data": "${ .patientInfo }", - "consumeEventRef": "vet-appointment-info" - }, - "actionDataFilter": { - "results": "${ .appointmentInfo }" - } - } - ], - "timeouts": { - "actionExecTimeout": "PT15M" - }, - "end": true - } - ] -}``` - - | -- -```yaml -id: vet-appointment-workflow -name: vet-appointment-workflow -description: Vet service call via events -version: 1.0.0 -specVersion: "0.8" -start: make-vet-appointment-state -events: - - name: make-vet-appointment - source: VetServiceSource - type: events.vet.appointments - kind: produced - - name: vet-appointment-info - source: VetServiceSource - type: events.vet.appointments - kind: consumed -states: - - name: make-vet-appointment-state - type: operation - actions: - - name: make-appointment-action - eventRef: - produceEventRef: make-vet-appointment - data: ${ .patientInfo } - consumeEventRef: vet-appointment-info - actionDataFilter: - results: ${ .appointmentInfo } - timeouts: - actionExecTimeout: PT15M - end: true -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "paymentconfirmation", - "version": "1.0.0", - "specVersion": "0.8", - "name": "paymentconfirmation", - "description": "Performs Payment Confirmation", - "functions": "file://functiondefs.json", - "events": "file://eventdefs.yml", - "states": [ - { - "name": "payment-received", - "type": "event", - "onEvents": [ - { - "eventRefs": [ - "payment-received-event" - ], - "actions": [ - { - "name": "checkfunds", - "functionRef": { - "refName": "check-funds-availability", - "arguments": { - "account": "${ .accountId }", - "paymentamount": "${ .payment.amount }" - } - } - } - ] - } - ], - "transition": "confirm-based-on-funds" - }, - { - "name": "confirm-based-on-funds", - "type": "switch", - "dataConditions": [ - { - "condition": "${ .funds | .available == \"true\" }", - "transition": "send-payment-success", - "name": "success" - }, - { - "condition": "${ .funds | .available == \"false\" }", - "transition": "send-insufficient-results", - "name": "failed" - } - ], - "defaultCondition": { - "transition": "send-payment-success" - } - }, - { - "name": "send-payment-success", - "type": "operation", - "actions": [ - { - "name": "send-payment-success", - "functionRef": { - "refName": "send-success-email", - "arguments": { - "applicant": "${ .customer }" - } - } - } - ], - "end": { - "produceEvents": [ - { - "eventRef": "confirmation-completed-event", - "data": "${ .payment }" - } - ] - } - }, - { - "name": "send-insufficient-results", - "type": "operation", - "actions": [ - { - "name": "send-insufficient-results", - "functionRef": { - "refName": "send-insufficient-funds-email", - "arguments": { - "applicant": "${ .customer }" - } - } - } - ], - "end": { - "produceEvents": [ - { - "eventRef": "confirmation-completed-event", - "data": "${ .payment }" - } - ] - } - } - ] -}``` - - | -- -```yaml -id: paymentconfirmation -version: 1.0.0 -specVersion: "0.8" -name: paymentconfirmation -description: Performs Payment Confirmation -functions: file://functiondefs.json -events: file://eventdefs.yml -states: - - name: payment-received - type: event - onEvents: - - eventRefs: - - payment-received-event - actions: - - name: checkfunds - functionRef: - refName: check-funds-availability - arguments: - account: ${ .accountId } - paymentamount: ${ .payment.amount } - transition: confirm-based-on-funds - - name: confirm-based-on-funds - type: switch - dataConditions: - - condition: ${ .funds | .available == "true" } - transition: send-payment-success - name: success - - condition: ${ .funds | .available == "false" } - transition: send-insufficient-results - name: failed - defaultCondition: - transition: send-payment-success - - name: send-payment-success - type: operation - actions: - - name: send-payment-success - functionRef: - refName: send-success-email - arguments: - applicant: ${ .customer } - end: - produceEvents: - - eventRef: confirmation-completed-event - data: ${ .payment } - - name: send-insufficient-results - type: operation - actions: - - name: send-insufficient-results - functionRef: - refName: send-insufficient-funds-email - arguments: - applicant: ${ .customer } - end: - produceEvents: - - eventRef: confirmation-completed-event - data: ${ .payment } -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "patientonboarding", - "name": "patientonboarding", - "version": "1.0.0", - "specVersion": "0.8", - "start": "onboard", - "states": [ - { - "name": "onboard", - "type": "event", - "onEvents": [ - { - "eventRefs": [ - "new-patient-event" - ], - "actions": [ - { - "name": "store-patient", - "functionRef": "store-patient", - "retryRef": "services-not-available-retry-strategy", - "retryableErrors": [ - "service-not-available" - ] - }, - { - "name": "assign-doctor", - "functionRef": "assign-doctor", - "retryRef": "services-not-available-retry-strategy", - "retryableErrors": [ - "service-not-available" - ] - }, - { - "name": "schedule-appt", - "functionRef": "schedule-appt", - "retryRef": "services-not-available-retry-strategy", - "retryableErrors": [ - "service-not-available" - ] - } - ] - } - ], - "onErrors": [ - { - "errorRef": "service-not-available", - "end": true - } - ], - "end": true - } - ], - "events": [ - { - "name": "store-patient", - "type": "new.patients.event", - "source": "newpatient/+" - } - ], - "functions": [ - { - "name": "store-new-patient-info", - "operation": "api/services.json#addPatient" - }, - { - "name": "assign-doctor", - "operation": "api/services.json#assignDoctor" - }, - { - "name": "schedule-appt", - "operation": "api/services.json#scheduleAppointment" - } - ], - "errors": [ - { - "name": "service-not-available", - "code": "503" - } - ], - "retries": [ - { - "name": "services-not-available-retry-strategy", - "delay": "PT3S", - "maxAttempts": 10 - } - ] -}``` - - | -- -```yaml -id: patientonboarding -name: patientonboarding -version: 1.0.0 -specVersion: "0.8" -start: onboard -states: - - name: onboard - type: event - onEvents: - - eventRefs: - - new-patient-event - actions: - - name: store-patient - functionRef: store-patient - retryRef: services-not-available-retry-strategy - retryableErrors: - - service-not-available - - name: assign-doctor - functionRef: assign-doctor - retryRef: services-not-available-retry-strategy - retryableErrors: - - service-not-available - - name: schedule-appt - functionRef: schedule-appt - retryRef: services-not-available-retry-strategy - retryableErrors: - - service-not-available - onErrors: - - errorRef: service-not-available - end: true - end: true -events: - - name: store-patient - type: new.patients.event - source: newpatient/+ -functions: - - name: store-new-patient-info - operation: api/services.json#addPatient - - name: assign-doctor - operation: api/services.json#assignDoctor - - name: schedule-appt - operation: api/services.json#scheduleAppointment -errors: - - name: service-not-available - code: "503" -retries: - - name: services-not-available-retry-strategy - delay: PT3S - maxAttempts: 10 -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "order", - "name": "order", - "description": "Purchase Order Workflow", - "version": "1.0.0", - "specVersion": "0.8", - "start": "start-new-order", - "timeouts": { - "workflowExecTimeout": { - "duration": "PT30D", - "runBefore": "CancelOrder" - } - }, - "states": [ - { - "name": "start-new-order", - "type": "event", - "onEvents": [ - { - "eventRefs": [ - "order-created-event" - ], - "actions": [ - { - "name": "log-new-order-created", - "functionRef": { - "refName": "log-new-order-created" - } - } - ] - } - ], - "transition": { - "nextState": "wait-for-order-confirmation" - } - }, - { - "name": "wait-for-order-confirmation", - "type": "event", - "onEvents": [ - { - "eventRefs": [ - "order-confirmed-event" - ], - "actions": [ - { - "name": "log-order-confirmed", - "functionRef": { - "refName": "log-order-confirmed" - } - } - ] - } - ], - "transition": { - "nextState": "wait-order-shipped" - } - }, - { - "name": "wait-order-shipped", - "type": "event", - "onEvents": [ - { - "eventRefs": [ - "shipment-sent-event" - ], - "actions": [ - { - "name": "log-order-shipped", - "functionRef": { - "refName": "log-order-shipped" - } - } - ] - } - ], - "end": { - "terminate": true, - "produceEvents": [ - { - "eventRef": "order-finished-event" - } - ] - } - }, - { - "name": "cancel-order", - "type": "operation", - "actions": [ - { - "name": "cancel-order", - "functionRef": { - "refName": "cancel-order" - } - } - ], - "end": { - "terminate": true, - "produceEvents": [ - { - "eventRef": "order-cancelled-event" - } - ] - } - } - ], - "events": [ - { - "name": "order-created-event", - "type": "my.company.orders", - "source": "/orders/new", - "correlation": [ - { - "contextAttributeName": "orderid" - } - ] - }, - { - "name": "order-confirmed-event", - "type": "my.company.orders", - "source": "/orders/confirmed", - "correlation": [ - { - "contextAttributeName": "orderid" - } - ] - }, - { - "name": "shipment-sent-event", - "type": "my.company.orders", - "source": "/orders/shipped", - "correlation": [ - { - "contextAttributeName": "orderid" - } - ] - }, - { - "name": "order-finished-event", - "type": "my.company.orders", - "kind": "produced" - }, - { - "name": "order-cancelled-event", - "type": "my.company.orders", - "kind": "produced" - } - ], - "functions": [ - { - "name": "log-new-order-created", - "operation": "http.myorg.io/ordersservices.json#logcreated" - }, - { - "name": "log-order-confirmed", - "operation": "http.myorg.io/ordersservices.json#logconfirmed" - }, - { - "name": "log-order-shipped", - "operation": "http.myorg.io/ordersservices.json#logshipped" - }, - { - "name": "cancel-order", - "operation": "http.myorg.io/ordersservices.json#calcelorder" - } - ] -}``` - - | -- -```yaml -id: order -name: order -description: Purchase Order Workflow -version: 1.0.0 -specVersion: "0.8" -start: start-new-order -timeouts: - workflowExecTimeout: - duration: PT30D - runBefore: CancelOrder -states: - - name: start-new-order - type: event - onEvents: - - eventRefs: - - order-created-event - actions: - - name: log-new-order-created - functionRef: - refName: log-new-order-created - transition: - nextState: wait-for-order-confirmation - - name: wait-for-order-confirmation - type: event - onEvents: - - eventRefs: - - order-confirmed-event - actions: - - name: log-order-confirmed - functionRef: - refName: log-order-confirmed - transition: - nextState: wait-order-shipped - - name: wait-order-shipped - type: event - onEvents: - - eventRefs: - - shipment-sent-event - actions: - - name: log-order-shipped - functionRef: - refName: log-order-shipped - end: - terminate: true - produceEvents: - - eventRef: order-finished-event - - name: cancel-order - type: operation - actions: - - name: cancel-order - functionRef: - refName: cancel-order - end: - terminate: true - produceEvents: - - eventRef: order-cancelled-event -events: - - name: order-created-event - type: my.company.orders - source: /orders/new - correlation: - - contextAttributeName: orderid - - name: order-confirmed-event - type: my.company.orders - source: /orders/confirmed - correlation: - - contextAttributeName: orderid - - name: shipment-sent-event - type: my.company.orders - source: /orders/shipped - correlation: - - contextAttributeName: orderid - - name: order-finished-event - type: my.company.orders - kind: produced - - name: order-cancelled-event - type: my.company.orders - kind: produced -functions: - - name: log-new-order-created - operation: http.myorg.io/ordersservices.json#logcreated - - name: log-order-confirmed - operation: http.myorg.io/ordersservices.json#logconfirmed - - name: log-order-shipped - operation: http.myorg.io/ordersservices.json#logshipped - - name: cancel-order - operation: http.myorg.io/ordersservices.json#calcelorder -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "roomreadings", - "name": "roomreadings", - "description": "Room Temp and Humidity Workflow", - "version": "1.0.0", - "specVersion": "0.8", - "start": "consume-reading", - "timeouts": { - "workflowExecTimeout": { - "duration": "PT1H", - "runBefore": "generate-report" - } - }, - "keepActive": true, - "states": [ - { - "name": "consume-reading", - "type": "event", - "onEvents": [ - { - "eventRefs": [ - "temperature-event", - "humidity-event" - ], - "actions": [ - { - "name": "log-reading", - "functionRef": { - "refName": "log-reading" - } - } - ], - "eventDataFilter": { - "toStateData": "${ .readings }" - } - } - ], - "end": true - }, - { - "name": "generate-report", - "type": "operation", - "actions": [ - { - "name": "generate-report", - "functionRef": { - "refName": "produce-report", - "arguments": { - "data": "${ .readings }" - } - } - } - ], - "end": { - "terminate": true - } - } - ], - "events": [ - { - "name": "temperature-event", - "type": "my.home.sensors", - "source": "/home/rooms/+", - "correlation": [ - { - "contextAttributeName": "roomId" - } - ] - }, - { - "name": "humidity-event", - "type": "my.home.sensors", - "source": "/home/rooms/+", - "correlation": [ - { - "contextAttributeName": "roomId" - } - ] - } - ], - "functions": [ - { - "name": "log-reading", - "operation": "http.myorg.io/ordersservices.json#logreading" - }, - { - "name": "produce-report", - "operation": "http.myorg.io/ordersservices.json#produceReport" - } - ] -}``` - - | -- -```yaml -id: roomreadings -name: roomreadings -description: Room Temp and Humidity Workflow -version: 1.0.0 -specVersion: "0.8" -start: consume-reading -timeouts: - workflowExecTimeout: - duration: PT1H - runBefore: generate-report -keepActive: true -states: - - name: consume-reading - type: event - onEvents: - - eventRefs: - - temperature-event - - humidity-event - actions: - - name: log-reading - functionRef: - refName: log-reading - eventDataFilter: - toStateData: ${ .readings } - end: true - - name: generate-report - type: operation - actions: - - name: generate-report - functionRef: - refName: produce-report - arguments: - data: ${ .readings } - end: - terminate: true -events: - - name: temperature-event - type: my.home.sensors - source: /home/rooms/+ - correlation: - - contextAttributeName: roomId - - name: humidity-event - type: my.home.sensors - source: /home/rooms/+ - correlation: - - contextAttributeName: roomId -functions: - - name: log-reading - operation: http.myorg.io/ordersservices.json#logreading - - name: produce-report - operation: http.myorg.io/ordersservices.json#produceReport -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "checkcarvitals", - "name": "checkcarvitals", - "description": "Check Car Vitals Workflow", - "version": "1.0.0", - "specVersion": "0.8", - "start": "when-car-is-on", - "states": [ - { - "name": "when-car-is-on", - "type": "event", - "onEvents": [ - { - "eventRefs": [ - "car-turned-on-event" - ] - } - ], - "transition": "do-car-vital-checks" - }, - { - "name": "do-car-vital-checks", - "type": "operation", - "actions": [ - { - "name": "do-car-vital-checks", - "subFlowRef": "vitalscheck", - "sleep": { - "after": "PT1S" - } - } - ], - "transition": "check-continue-vital-checks" - }, - { - "name": "check-continue-vital-checks", - "type": "switch", - "eventConditions": [ - { - "name": "car-turned-off-condition", - "eventRef": "car-turned-off-event", - "end": true - } - ], - "defaultCondition": { - "transition": "do-car-vital-checks" - } - } - ], - "events": [ - { - "name": "car-turned-on-event", - "type": "car.events", - "source": "my/car" - }, - { - "name": "car-turned-off-event", - "type": "car.events", - "source": "my/car" - } - ] -}``` - - | -- -```yaml -id: checkcarvitals -name: checkcarvitals -description: Check Car Vitals Workflow -version: 1.0.0 -specVersion: "0.8" -start: when-car-is-on -states: - - name: when-car-is-on - type: event - onEvents: - - eventRefs: - - car-turned-on-event - transition: do-car-vital-checks - - name: do-car-vital-checks - type: operation - actions: - - name: do-car-vital-checks - subFlowRef: vitalscheck - sleep: - after: PT1S - transition: check-continue-vital-checks - - name: check-continue-vital-checks - type: switch - eventConditions: - - name: car-turned-off-condition - eventRef: car-turned-off-event - end: true - defaultCondition: - transition: do-car-vital-checks -events: - - name: car-turned-on-event - type: car.events - source: my/car - - name: car-turned-off-event - type: car.events - source: my/car -``` - - | -
| JSON | -YAML | -|
|---|---|---|
| - -```json -{ - "id": "vitalscheck", - "name": "vitalscheck", - "description": "Car Vitals Check", - "version": "1.0.0", - "specVersion": "0.8", - "start": "check-vitals", - "states": [ - { - "name": "check-vitals", - "type": "operation", - "actions": [ - { - "name": "check-tire-pressure", - "functionRef": "check-tire-pressure" - }, - { - "name": "check-oil-pressure", - "functionRef": "check-oil-pressure" - }, - { - "name": "check-coolant-level", - "functionRef": "check-coolant-level" - }, - { - "name": "check-battery", - "functionRef": "check-battery" - } - ], - "end": { - "produceEvents": [ - { - "eventRef": "display-checks-on-dashboard", - "data": "${ .evaluations }" - } - ] - } - } - ], - "functions": [ - { - "name": "check-tire-pressure", - "operation": "mycarservices.json#checktirepressure" - }, - { - "name": "check-oil-pressure", - "operation": "mycarservices.json#checkoilpressure" - }, - { - "name": "check-coolant-level", - "operation": "mycarservices.json#checkcoolantlevel" - }, - { - "name": "check-battery", - "operation": "mycarservices.json#checkbattery" - } - ] -}``` - - | -- -```yaml -id: vitalscheck -name: vitalscheck -description: Car Vitals Check -version: 1.0.0 -specVersion: "0.8" -start: check-vitals -states: - - name: check-vitals - type: operation - actions: - - name: check-tire-pressure - functionRef: check-tire-pressure - - name: check-oil-pressure - functionRef: check-oil-pressure - - name: check-coolant-level - functionRef: check-coolant-level - - name: check-battery - functionRef: check-battery - end: - produceEvents: - - eventRef: display-checks-on-dashboard - data: ${ .evaluations } -functions: - - name: check-tire-pressure - operation: mycarservices.json#checktirepressure - - name: check-oil-pressure - operation: mycarservices.json#checkoilpressure - - name: check-coolant-level - operation: mycarservices.json#checkcoolantlevel - - name: check-battery - operation: mycarservices.json#checkbattery -``` - - | -- -```yaml -id: vitalscheck -name: Car Vitals Check -version: '1.0.0' -specVersion: '0.8' -start: CheckVitals -states: - - name: CheckVitals - type: operation - actions: - - functionRef: Check Tire Pressure - - functionRef: Check Oil Pressure - - functionRef: Check Coolant Level - - functionRef: Check Battery - end: - produceEvents: - - eventRef: DisplayChecksOnDashboard - data: "${ .evaluations }" -functions: - - name: checkTirePressure - operation: mycarservices.json#checktirepressure - - name: checkOilPressure - operation: mycarservices.json#checkoilpressure - - name: checkCoolantLevel - operation: mycarservices.json#checkcoolantlevel - - name: checkBattery - operation: mycarservices.json#checkbattery -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "booklending", - "name": "booklending", - "description": "Book Lending Workflow", - "version": "1.0.0", - "specVersion": "0.8", - "start": "book-lending-request", - "states": [ - { - "name": "book-lending-request", - "type": "event", - "onEvents": [ - { - "eventRefs": [ - "book-lending-request-event" - ] - } - ], - "transition": "get-book-status" - }, - { - "name": "get-book-status", - "type": "operation", - "actions": [ - { - "name": "get-book-status", - "functionRef": { - "refName": "get-status-for-book", - "arguments": { - "bookid": "${ .book.id }" - } - } - } - ], - "transition": "book-status-decision" - }, - { - "name": "book-status-decision", - "type": "switch", - "dataConditions": [ - { - "name": "book-is-on-loan", - "condition": "${ .book.status == \"onloan\" }", - "transition": "report-status-to-lender" - }, - { - "name": "check-is-available", - "condition": "${ .book.status == \"available\" }", - "transition": "check-out-book" - } - ], - "defaultCondition": { - "end": true - } - }, - { - "name": "report-status-to-lender", - "type": "operation", - "actions": [ - { - "name": "report-status-to-lender", - "functionRef": { - "refName": "send-status-to-lender", - "arguments": { - "bookid": "${ .book.id }", - "message": "Book ${ .book.title } is already on loan" - } - } - } - ], - "transition": "wait-for-lender-response" - }, - { - "name": "wait-for-lender-response", - "type": "switch", - "eventConditions": [ - { - "name": "hold-book", - "eventRef": "hold-book-event", - "transition": "request-hold" - }, - { - "name": "decline-book-hold", - "eventRef": "decline-hold-event", - "transition": "cancel-request" - } - ], - "defaultCondition": { - "end": true - } - }, - { - "name": "request-hold", - "type": "operation", - "actions": [ - { - "name": "request-hold", - "functionRef": { - "refName": "request-hold-for-lender", - "arguments": { - "bookid": "${ .book.id }", - "lender": "${ .lender }" - } - } - } - ], - "transition": "sleep-two-weeks" - }, - { - "name": "cancel-request", - "type": "operation", - "actions": [ - { - "name": "cancel-request", - "functionRef": { - "refName": "cancel-hold-request-for-lender", - "arguments": { - "bookid": "${ .book.id }", - "lender": "${ .lender }" - } - } - } - ], - "transition": "sleep-two-weeks" - }, - { - "name": "sleep-two-weeks", - "type": "sleep", - "duration": "PT2W", - "transition": "get-book-status" - }, - { - "name": "check-out-book", - "type": "operation", - "actions": [ - { - "name": "check-out-book", - "functionRef": { - "refName": "check-out-book-with-id", - "arguments": { - "bookid": "${ .book.id }" - } - } - }, - { - "name": "notify-lender-for-checkout", - "functionRef": { - "refName": "notify-lender-for-checkout", - "arguments": { - "bookid": "${ .book.id }", - "lender": "${ .lender }" - } - } - } - ], - "end": true - } - ], - "functions": "file://books/lending/functions.json", - "events": "file://books/lending/events.json" -}``` - - | -- -```yaml -id: booklending -name: booklending -description: Book Lending Workflow -version: 1.0.0 -specVersion: "0.8" -start: book-lending-request -states: - - name: book-lending-request - type: event - onEvents: - - eventRefs: - - book-lending-request-event - transition: get-book-status - - name: get-book-status - type: operation - actions: - - name: get-book-status - functionRef: - refName: get-status-for-book - arguments: - bookid: ${ .book.id } - transition: book-status-decision - - name: book-status-decision - type: switch - dataConditions: - - name: book-is-on-loan - condition: ${ .book.status == "onloan" } - transition: report-status-to-lender - - name: check-is-available - condition: ${ .book.status == "available" } - transition: check-out-book - defaultCondition: - end: true - - name: report-status-to-lender - type: operation - actions: - - name: report-status-to-lender - functionRef: - refName: send-status-to-lender - arguments: - bookid: ${ .book.id } - message: Book ${ .book.title } is already on loan - transition: wait-for-lender-response - - name: wait-for-lender-response - type: switch - eventConditions: - - name: hold-book - eventRef: hold-book-event - transition: request-hold - - name: decline-book-hold - eventRef: decline-hold-event - transition: cancel-request - defaultCondition: - end: true - - name: request-hold - type: operation - actions: - - name: request-hold - functionRef: - refName: request-hold-for-lender - arguments: - bookid: ${ .book.id } - lender: ${ .lender } - transition: sleep-two-weeks - - name: cancel-request - type: operation - actions: - - name: cancel-request - functionRef: - refName: cancel-hold-request-for-lender - arguments: - bookid: ${ .book.id } - lender: ${ .lender } - transition: sleep-two-weeks - - name: sleep-two-weeks - type: sleep - duration: PT2W - transition: get-book-status - - name: check-out-book - type: operation - actions: - - name: check-out-book - functionRef: - refName: check-out-book-with-id - arguments: - bookid: ${ .book.id } - - name: notify-lender-for-checkout - functionRef: - refName: notify-lender-for-checkout - arguments: - bookid: ${ .book.id } - lender: ${ .lender } - end: true -functions: file://books/lending/functions.json -events: file://books/lending/events.json -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "fillglassofwater", - "name": "fillglassofwater", - "description": "Fill glass of water workflow", - "version": "1.0.0", - "specVersion": "0.8", - "start": "check-if-full", - "functions": [ - { - "name": "increment-current-count-function", - "type": "expression", - "operation": ".counts.current += 1 | .counts.current" - } - ], - "states": [ - { - "name": "check-if-full", - "type": "switch", - "dataConditions": [ - { - "name": "need-to-fill-more", - "condition": "${ .counts.current < .counts.max }", - "transition": "add-water" - }, - { - "name": "glass-full", - "condition": ".counts.current >= .counts.max", - "end": true - } - ], - "defaultCondition": { - "end": true - } - }, - { - "name": "add-water", - "type": "operation", - "actions": [ - { - "name": "add-water", - "functionRef": "increment-current-count-function", - "actionDataFilter": { - "toStateData": ".counts.current" - } - } - ], - "transition": "check-if-full" - } - ] -}``` - - | -- -```yaml -id: fillglassofwater -name: fillglassofwater -description: Fill glass of water workflow -version: 1.0.0 -specVersion: "0.8" -start: check-if-full -functions: - - name: increment-current-count-function - type: expression - operation: .counts.current += 1 | .counts.current -states: - - name: check-if-full - type: switch - dataConditions: - - name: need-to-fill-more - condition: ${ .counts.current < .counts.max } - transition: add-water - - name: glass-full - condition: .counts.current >= .counts.max - end: true - defaultCondition: - end: true - - name: add-water - type: operation - actions: - - name: add-water - functionRef: increment-current-count-function - actionDataFilter: - toStateData: .counts.current - transition: check-if-full -``` - - | -
-
-
-
-
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "notifycustomerworkflow", - "name": "notifycustomerworkflow", - "description": "Notify Customer", - "version": "1.0.0", - "specVersion": "0.8", - "start": "wait-for-customer-event", - "states": [ - { - "name": "wait-for-customer-event", - "type": "event", - "onEvents": [ - { - "eventRefs": [ - "customer-event" - ], - "eventDataFilter": { - "data": "${ .customerId }", - "toStateData": "${ .eventCustomerId }" - }, - "actions": [ - { - "name": "notify-customer-function", - "functionRef": { - "refName": "notify-customer-function", - "arguments": { - "customerId": "${ .eventCustomerId }" - } - } - } - ] - } - ], - "stateDataFilter": { - "output": "${ .count = .count + 1 }" - }, - "transition": "check-event-quota" - }, - { - "name": "check-event-quota", - "type": "switch", - "dataConditions": [ - { - "name": "ready", - "condition": "${ try(.customerCount) != null and .customerCount > .quota.maxConsumedEvents }", - "end": { - "continueAs": { - "workflowId": "notifycustomerworkflow", - "version": "1.0.0", - "data": "${ del(.customerCount) }" - } - } - } - ], - "defaultCondition": { - "transition": "wait-for-customer-event" - } - } - ], - "events": [ - { - "name": "customer-event", - "type": "org.events.customerEvent", - "source": "customerSource" - } - ], - "functions": [ - { - "name": "notify-customer-function", - "operation": "http://myapis.org/customerapis.json#notifyCustomer" - } - ] -}``` - - | -- -```yaml -id: notifycustomerworkflow -name: notifycustomerworkflow -description: Notify Customer -version: 1.0.0 -specVersion: "0.8" -start: wait-for-customer-event -states: - - name: wait-for-customer-event - type: event - onEvents: - - eventRefs: - - customer-event - eventDataFilter: - data: ${ .customerId } - toStateData: ${ .eventCustomerId } - actions: - - name: notify-customer-function - functionRef: - refName: notify-customer-function - arguments: - customerId: ${ .eventCustomerId } - stateDataFilter: - output: ${ .count = .count + 1 } - transition: check-event-quota - - name: check-event-quota - type: switch - dataConditions: - - name: ready - condition: ${ try(.customerCount) != null and .customerCount > - .quota.maxConsumedEvents } - end: - continueAs: - workflowId: notifycustomerworkflow - version: 1.0.0 - data: ${ del(.customerCount) } - defaultCondition: - transition: wait-for-customer-event -events: - - name: customer-event - type: org.events.customerEvent - source: customerSource -functions: - - name: notify-customer-function - operation: http://myapis.org/customerapis.json#notifyCustomer -``` - - | -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "id": "customerbankingtransactions", - "name": "customerbankingtransactions", - "description": "Customer Banking Transactions Workflow", - "version": "1.0.0", - "specVersion": "0.8", - "autoRetries": true, - "constants": { - "largetxamount": 5000 - }, - "states": [ - { - "name": "process-transactions", - "type": "foreach", - "inputCollection": "${ .customer.transactions }", - "iterationParam": "${ .tx }", - "actions": [ - { - "name": "process-larger-transaction", - "functionRef": "banking-service-larger-tx", - "condition": "${ .tx >= $CONST.largetxamount }" - }, - { - "name": "process-smaller-transaction", - "functionRef": "banking-service-smaller-tx", - "condition": "${ .tx < $CONST.largetxamount }" - } - ], - "end": true - } - ], - "functions": [ - { - "name": "banking-service-larger-tx", - "type": "asyncapi", - "operation": "banking.yaml#largerTransation" - }, - { - "name": "banking-service-smaller-tx", - "type": "asyncapi", - "operation": "banking.yaml#smallerTransation" - } - ] -}``` - - | -- -```yaml -id: customerbankingtransactions -name: customerbankingtransactions -description: Customer Banking Transactions Workflow -version: 1.0.0 -specVersion: "0.8" -autoRetries: true -constants: - largetxamount: 5000 -states: - - name: process-transactions - type: foreach - inputCollection: ${ .customer.transactions } - iterationParam: ${ .tx } - actions: - - name: process-larger-transaction - functionRef: banking-service-larger-tx - condition: ${ .tx >= $CONST.largetxamount } - - name: process-smaller-transaction - functionRef: banking-service-smaller-tx - condition: ${ .tx < $CONST.largetxamount } - end: true -functions: - - name: banking-service-larger-tx - type: asyncapi - operation: banking.yaml#largerTransation - - name: banking-service-smaller-tx - type: asyncapi - operation: banking.yaml#smallerTransation -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
| JSON | -YAML | -|
|---|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-- -```yaml -id: vitalscheck -name: Car Vitals Check -version: '1.0.0' -specVersion: '0.8' -start: CheckVitals -states: - - name: CheckVitals - type: operation - actions: - - functionRef: Check Tire Pressure - - functionRef: Check Oil Pressure - - functionRef: Check Coolant Level - - functionRef: Check Battery - end: - produceEvents: - - eventRef: DisplayChecksOnDashboard - data: "${ .evaluations }" -functions: - - name: checkTirePressure - operation: mycarservices.json#checktirepressure - - name: checkOilPressure - operation: mycarservices.json#checkoilpressure - - name: checkCoolantLevel - operation: mycarservices.json#checkcoolantlevel - - name: checkBattery - operation: mycarservices.json#checkbattery -``` - - | -
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
-
-
-
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
| JSON | -YAML | -
|---|---|
|
-
-```json
- |
-
-
-```yaml
- |
-
| Workflow | -KPIs Extension | -
|---|---|
| - -```yaml -id: patientVitalsWorkflow -name: Monitor Patient Vitals -version: '1.0.0' -specVersion: '0.8' -start: MonitorVitals -extensions: - - extensionId: workflow-kpi-extension - path: file://myextensions/kpi.yml -events: - - name: HighBodyTemperature - type: org.monitor.highBodyTemp - source: monitoringSource - correlation: - - contextAttributeName: patientId - - name: HighBloodPressure - type: org.monitor.highBloodPressure - source: monitoringSource - correlation: - - contextAttributeName: patientId - - name: HighRespirationRate - type: org.monitor.highRespirationRate - source: monitoringSource - correlation: - - contextAttributeName: patientId -functions: - - name: callPulmonologist - operation: http://myapi.org/patientapi.json#callPulmonologist - - name: sendTylenolOrder - operation: http://myapi.org/patientapi.json#sendTylenol - - name: callNurse - operation: http://myapi.org/patientapi.json#callNurse -states: - - name: MonitorVitals - type: event - exclusive: true - onEvents: - - eventRefs: - - HighBodyTemperature - actions: - - functionRef: - refName: sendTylenolOrder - arguments: - patientid: "${ .patientId }" - - eventRefs: - - HighBloodPressure - actions: - - functionRef: - refName: callNurse - arguments: - patientid: "${ .patientId }" - - eventRefs: - - HighRespirationRate - actions: - - functionRef: - refName: callPulmonologist - arguments: - patientid: "${ .patientId }" - end: true -``` - - | -- -```yaml -extensionid: workflow-kpi-extension -currency: USD -workflow: - per: - time: PT1D - maxCost: '1300' - maxInvoked: '500' - minInvoked: '100' -events: -- for: HighBodyTemperature - per: - time: PT1D - avgConsumed: '50' -- for: HighBloodPressure - per: - time: PT1D - avgConsumed: '30' -functions: -- for: callPulmonologist - per: - instances: 1000 - maxCost: '400' - maxErrors: '5' - maxRetry: '10' - maxTimeout: '15' - avgInvoked: '40' -- for: sendTylenolOrder - per: - instances: 1000 - maxCost: '200' - maxErrors: '5' - maxRetry: '10' - maxTimeout: '15' - avgInvoked: '400' -states: -- for: MonitorVitals - per: - time: PT1D - maxCost: '300' - maxExec: '1000' - minExec: '50' -``` - - | -
| Workflow | -Rate Limiting Extension | -
|---|---|
| - -```yaml -id: processapplication -name: Process Application -version: '1.0.0' -specVersion: '0.8' -extensions: - - extensionId: workflow-ratelimiting-extension - path: file://myextensions/ratelimiting.yml -start: ProcessNewApplication -states: - - name: ProcessNewApplication - type: event - onEvents: - - eventRefs: - - ApplicationReceivedEvent - actions: - - functionRef: processApplicationFunction - - functionRef: acceptApplicantFunction - - functionRef: depositFeesFunction - end: - produceEvents: - - eventRef: NotifyApplicantEvent -functions: - - name: processApplicationFunction - operation: file://myservice.json#process - - name: acceptApplicantFunction - operation: file://myservice.json#accept - - name: depositFeesFunction - operation: file://myservice.json#deposit -events: - - name: ApplicationReceivedEvent - type: application - source: "/applications/new" - - name: NotifyApplicantEvent - type: notifications - source: "/applicants/notify" -``` - - | -- -```yaml -extensionid: workflow-ratelimiting-extension -singleInstance: - maxActionsPerSecond: 0.1 - maxConcurrentActions: 200 - maxProducedEventsPerSecond: 2 - maxStates: '1000' - maxTransitions: '1000' -allInstances: - maxActionsPerSecond: 1 - maxConcurrentActions: 500 - maxProducedEventsPerSecond: 20 - maxStates: '10000' - maxTransitions: '10000' - -``` - - | -
ā¢ Annual report
ā¢ Questions
- -## Discussion Items -Item | Who | Notes | ----- | ---- | ---- | -Project graduation status | all | Will wait for v1.0 spec release | -CNCF Incubation status | all | Discussed what benefits it brings to project | - - -## Action Items -| Done? | Item | Responsible | Due Date | -| ---- | ---- | ---- | ---- | -| | Keep up discussions around using workflow states inside branches | tihomir, yuri | | - -## Other Notes & Information diff --git a/meetingminutes/9-20-21-meeting-minutes.md b/meetingminutes/9-20-21-meeting-minutes.md deleted file mode 100644 index cf47132e..00000000 --- a/meetingminutes/9-20-21-meeting-minutes.md +++ /dev/null @@ -1,34 +0,0 @@ -# Serverless Workflow Community Meeting Minutes - -## Meeting Information -**Meeting Date/Time:** 9/20/21, 1pm EST -**Meeting Purpose:** Weekly project meeting -**Meeting Location:** https://zoom.us/my/cncfserverlesswg?pwd=YjNqYzhOdjRRd01YWFkzS1lHbDZqUT09 - -## Attendees -People who attended: -- Yuri -- Antonio -- Ricardo -- Charles - -## Agenda Items - -Item | Description ----- | ---- -Agenda Item 1 | ā¢ Updates
ā¢ SDKs
ā¢ Questions
- -## Discussion Items -Item | Who | Notes | ----- | ---- | ---- | -Start planning v0.8 release and its contents | all | Should be done sooner than later | -SDKs status | all | Update SDKs to v0.7 | -Work on case studies | all | Video or blog-based | - - -## Action Items -| Done? | Item | Responsible | Due Date | -| ---- | ---- | ---- | ---- | -| | Keep up discussions around using workflow states inside branches | tihomir, yuri | | - -## Other Notes & Information diff --git a/meetingminutes/template.md b/meetingminutes/template.md deleted file mode 100644 index d22fe677..00000000 --- a/meetingminutes/template.md +++ /dev/null @@ -1,33 +0,0 @@ -# Serverless Workflow Community Meeting Minutes - -## Meeting Information -**Meeting Date/Time:** meeting_date, meeting_time -**Meeting Purpose:** Project meeting -**Meeting Location:** https://zoom.us/my/cncfserverlesswg?pwd=YjNqYzhOdjRRd01YWFkzS1lHbDZqUT09 - -## Attendees -People who attended: -- Person A -- Person B -- Person C - -## Agenda Items - -Item | Description ----- | ---- -Agenda Item 1 | ā¢
ā¢
ā¢
ā¢
ā¢ -Agenda Item 2 | ā¢
ā¢
ā¢
ā¢
ā¢ - -## Discussion Items -Item | Who | Notes | ----- | ---- | ---- | -item | who | notes | - - -## Action Items -| Done? | Item | Responsible | Due Date | -| ---- | ---- | ---- | ---- | -| | item | who | due_date | - -## Other Notes & Information -N/A \ No newline at end of file diff --git a/OWNERS b/owners.md similarity index 72% rename from OWNERS rename to owners.md index 9e326158..1fa70c4d 100644 --- a/OWNERS +++ b/owners.md @@ -1,9 +1,7 @@ # See the GOVERNANCE.md document for the definition of the roles and responsibilities maintainers: - - tsurdilo - - ricardozanini - cdavernas - - antmendoza + - ricardozanini reviewers: - - manick02 - - JBBianchi \ No newline at end of file + - JBBianchi + - manick02 \ No newline at end of file diff --git a/package-lock.json b/package-lock.json deleted file mode 100644 index 07f14cde..00000000 --- a/package-lock.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "name": "specification", - "lockfileVersion": 3, - "requires": true, - "packages": {} -} diff --git a/references/README.md b/references/README.md deleted file mode 100644 index 07986644..00000000 --- a/references/README.md +++ /dev/null @@ -1,175 +0,0 @@ -# References - -State machines/Workflows have a long history in software design and development. The goal of this section is to list other tools and languages that had been used to define orchestration between different actors (software and human). The main intention here is to make sure that we cover as many use cases as possible leveraging existing approaches to avoid pitfalls from the past. - -- [Workflow Patterns](#Workflow-Patterns) -- [Business Process Model and Notation](#Business-Process-Model-and-Notation) -- [Mistral Workflow Language](#Mistral-Workflow-Language) -- [Amazon States Language](#Amazon-States-Language) -- [Huawei FunctionGraph workflow definition](#Huawei-FunctionGraph-workflow-definition) -- [Flogo](#Flogo) -- [Alibaba FunctionFlow](#Alibaba-FunctionFlow) -- [Common Workflow Language](#Common-Workflow-Language) - -## Workflow Patterns -The research of the [Workflow Patterns Initiative](http://www.workflowpatterns.com/) provides a thorough examination of the various perspectives (control flow, data, resource, and exception handling) that need to be supported by a workflow language. - -## Business Process Model and Notation - -[Business Process Modeling and Notation (BPMN)](https://www.omg.org/spec/BPMN/) was standardized by Object Management Group (OMG) in collaboration with companies such as: IBM, Red Hat, Oracle, SAP, TIBCO, Software AG, among others. The latest version of the specification has even been [adopted by the ISO](https://www.iso.org/standard/62652.html) and provides a rich set of constructs to define workflows in a technology-agnostic way. One of the main advantages of the BPMN spec is that it visually defines how a workflow should look like and most importantly, it defines the execution semantics of such workflows. [This article](https://www.esentri.com/bpmn-and-serverless-workflows/) describes how BPMN can be used for serverless workflows. - -
-
-
-BPMN model
- - BPMN provides the following entities to define workflows: - -- Tasks: Orchestrate interactions between systems and people -- User Task - - Service Task - - Business Rule Task -- Events: Emitting and catching events that are relevant to a workflow instance - - Condition Events - - Message Event: Enable communication between different workflow instances - - Throw - - Catch - - Timer Events -- Gateways: Enable fork/join behaviors based on certain condition - - Exclusive - - Parallel - - Complex -- Aggregation: Provide a mechanism to deal with complexity when workflows become to large to understand - - Embedded Sub Process - - Call Activity - -The [BPMN specification](https://www.omg.org/spec/BPMN/) provides XML Schemas for defining and validating workflow definitions. -
-
-
-## Mistral Workflow Language
-
-[Mistral Workflow Language](https://docs.openstack.org/mistral/latest/user/wf_lang_v2.html) is a YAML-based task graph description. Unless a dependency (link/transition/requirement) is expressed between two tasks, all unconnected tasks in the workflow description would be executed. If a transition links one task to another, its execution depends on the predecessor. With transitions, successors of a task can be identified to create workflow graphs (type: *direct*). With dependencies, required tasks can be identified to create a dependency graph (type: *reverse*). Each workflow activation maintains a context and completes one task at a time. However, at the end of each task, the task may define more than one task to continue with (fork concurrent branches) and at the beginning of a task, the task may wait on the completion of other tasks (join). The workflow concludes when all branches/tasks have completed.
-
-BPMN examples
- - Here are BPMN diagrams covering two examples listed in the [Serverless Workflow Specification - Use Cases](../usecases/README.md) section: - - **Loan Approval Workflow** - -  - - You can find the BPMN XML which can be executed in a number of Open Source and Proprietary engines [here](../media/references/loan-approval-workflow.bpmn) - - **Travel Booking Workflow** - -  - - You can find the BPMN XML which can be executed in a number of Open Source and Proprietary engines [here](../media/references/travel-booking-workflow.bpmn) -
-
-
-## Amazon States Language
-
-[Amazon States Language](https://states-language.net/spec.html) is a JSON-based DSL to define AWS Step Functions, a workflow-like execution of AWS Lambda serverless functions. The language has inspired the original draft of the serverless workflows specification. The copyright lies with Amazon.com Inc. or Affiliates and the license excludes modification or merging of the specification. The workflow is orchestrated by the engine that invokes the serverless functions (resources) referenced by the workflow.
-
-## Huawei FunctionGraph workflow definition
-
-[Huawei FunctionGraph workflow definition](https://support.huaweicloud.com/en-us/productdesc-functiongraph/functiongraph_01_0100.html) has served as [initial draft](https://github.com/cncf/wg-serverless/commit/e42aaabb2c5dd78d0bd638b5cc8be0cd771101a4#diff-bc18ddd43c9fef122edf80ec220f04bb) of this specification and is very similar to the Amazon States Language.
-
-## Flogo
-
-[TIBCO's (Project Flogo™)](http://www.flogo.io) defines applications as triggers, handlers and actions to create workflows. Its [current support for AWS Lambda](https://tibcosoftware.github.io/flogo/labs/flogo-lambda/) wraps the entire workflow as an embedded application into a single Lambda function.
-
-## Alibaba FunctionFlow
-
-FunctionFlow defines workflows of steps using yaml arrays and a simple control logic that starts with the first step in the array, allows jumps with goto and ending a flow either by reaching the last step in the array or by marking a step as the end of the flow.
-
-Workflow Language details
- A workflow describes a task graph, i.e. it consists of tasks that can be linked with transitions. - -**Workflow:** - -- type (direct or reverse) -- description -- input (required input parameters and optional default values) -- output (construct an output from the final context content) -- output-on-error (same as output but when the workflow goes into error) -- task-defaults (defaults for all tasks, unless tasks overwrites) - - pause-before - - wait-before - - wait-after - - timeout - - retry - - concurrency - - *direct-only* - - on-error (list of tasks which will run if the task has completed with an error) - - on-success (list of tasks which will run if the task has completed successfully) - - on-complete (regardless if successful or not) - - *reverse-only* - - requires (for reverse workflows that express requires-dependencies instead of on-xxx forward control) -- tasks (dictionary of all tasks) - -**Task:** - -- name -- description -- action or workflow, otherwise it's a no-op -- input (constructs action/subworkflow input parameters from the context of the task) -- publish (decides which action/subworkflow outputs are put into the context) -- publish-on-error -- with-items (processes items of a collection, i.e. the action/workflow executes multiple times) -- keep-result (can be used to discard the action/subworkflow output) -- target (which worker should execute the task) -- pause-before -- wait-before -- wait-after -- fail-on -- timeout -- retry (with count, delay, break-on, continue-on) -- concurrency (max concurrent actions, see with-items) - -
-
-
-## Common Workflow Language
-
-The [Common Workflow Language (CWL)](https://www.commonwl.org/) is an open standard for describing analysis workflows and tools in a way that makes them portable and scalable across a variety of software and hardware environments, from workstations to cluster, cloud, and high performance computing (HPC) environments. CWL is designed to meet the needs of data-intensive science, such as Bioinformatics, Medical Imaging, Astronomy, High Energy Physics, and Machine Learning.
-
-## Others
-
-If you know other related tools, languages, projects that can help this specification to be better, more scoped and serve a wide range of use cases please feel free to get in touch or send a PR to this section.
diff --git a/roadmap/README.md b/roadmap/README.md
deleted file mode 100644
index f9add27d..00000000
--- a/roadmap/README.md
+++ /dev/null
@@ -1,177 +0,0 @@
-# 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](https://github.com/cncf/wg-serverless/commits/master)_
-
-_Status description:_
-
-| Completed | In Progress | In Planning | On Hold |
-| :--: | :--: | :--: | :--: |
-| ā | āļø | š© | āļø|
-
-## Releases
-
-- [Roadmap for next planned release](#v09)
-- [v0.8 released Nov 2021](#v08)
-- [v0.7 released Aug 2021](#v07)
-- [v0.6 released March 2021](#v06)
-- [v0.5 released November 2020](#v05)
-- [v0.1 released April 2020](#v01)
-
-## Next planned release
-
-| Status | Description | Comments |
-| --- | --- | --- |
-| āļø| Fix support for workflow extensions | [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md) |
-| āļø| Fix state execution timeout | [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md) |
-| āļø| Update rules of retries increment and multiplier properties | [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md) |
-| āļø| Add clarification on mutually exclusive properties | [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md) |
-| āļø| Make the `resultEventRef` attribute in `EventRef` definition not required [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md#EventRef-Definition) |
-| āļø| Make the `stateName` attribute in `start` definition not required [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md#EventRef-Definition) |
-| āļø| Remove `id` attribute from `actions` and `states`. Now, the names from both attributes must be unique within the workflow definition | [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md#transitions)
-| āļø| Update eventRef props to`produceEventRef` and `consumeEventRef` [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md#EventRef-Definition) |
-| āļø| Update eventRef props to`resultEventTimeout` and `consumeEventTimeout` [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md#EventRef-Definition) |
-| āļø| Apply fixes to auth spec schema [workflow schema](https://github.com/serverlessworkflow/specification/tree/main/schema) |
-| āļø| Update the `dataInputSchema` top-level property by supporting the assignment of a JSON schema object [workflow schema](https://github.com/serverlessworkflow/specification/tree/main/specification.md#workflow-definition-structure) |
-| āļø| 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 the new `rest` function type [spec doc](https://github.com/serverlessworkflow/specification/tree/main/specification.md#using-functions-for-restful-service-invocations) |
-| āļø| Refactor error handling and retries |
-| āļøļø| Add inline state defs in branches | |
-| āļøļø| 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` | |
-| āļøļø| Add `dataOutputSchema` | |
-
-## Released version v0.8
-
-| Status | Description | Comments |
-| --- | --- | --- |
-| āļø| Support custom function `type` definition | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.8.x/specification.md) |
-| āļø| Workflow "name" no longer a required property | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.8.x/specification.md) |
-| āļø| Workflow "start" no longer a required property | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.8.x/specification.md) |
-| āļø| ForEach state "iterationParam" no longer a required property | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.8.x/specification.md) |
-| āļø| Added "useData" for eventDataFilter, and "useResults" for actionDataFilter | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.8.x/specification.md) |
-| āļø| Added "resultEventTimeout" for action eventref | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.8.x/specification.md) |
-| āļø| Added example for "continueAs" | [examples doc](https://github.com/serverlessworkflow/specification/blob/0.8.x/examples/README.md) |
-| āļøļø| Support for async action invocation | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.8.x/specification.md) |
-| āļøļø| Support for action condition | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.8.x/specification.md) |
-
-
-## Released version v0.7
-
-| Status | Description | Comments |
-| --- | --- | --- |
-| āļø| Add workflow `key` and `annotations` properties | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Replaced SubFlow state with subflow action type | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Add workflow `dataInputSchema` property | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Rename switch state `default` to `defaultCondition` to avoid keyword conflicts for SDK's | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Add description of additional properties | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Rename Parallel `completionType` values | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Removed `workflowId` from ParallelState and ForEach states (use subFlow action instead) | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Add subflow actions `version` property | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Renamed `schemaVersion` to `specVersion` and it is now a required parameter | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Add GraphQL support for function definitions | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Added "dataOnly" property to Event Definitions (allow event data filters to access entire event) | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Added support for Secrets and Constants | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Changed default value of execution timeout `interrupt` property. This is a non-backwards compatible changes. | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Updated workflow timeouts | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Added Workflow Auth definitions | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Added State execution timeouts | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Temporarily removed `waitForCompletion` for subflows | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Added function definition support for OData | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Added function definition support for AsyncAPI | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Rename Delay state to Sleep state | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Added 'sleep' property to action definition | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Added Rate Limiting extension | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Update ForEach state - adding sequential exec option and batch size for parallel option | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Update to error handling and retries. Retries are now per action rather than per state. Added option of automatic retries for actions | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-| āļø| Added "continueAs" property to end definitions | [spec doc](hhttps://github.com/serverlessworkflow/specification/blob/0.7.x/specification.md) |
-
-## Released version v0.6
-
-| Status | Description | Comments |
-| --- | --- | --- |
-| āļø| Adding Workflow Compensation capabilities (cmp [Compensating Transaction](https://docs.microsoft.com/en-us/azure/architecture/patterns/compensating-transaction), [SAGA pattern](https://microservices.io/patterns/data/saga.html)) | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/specification.md) |
-| āļø| Adding comparison examples with Google Cloud Workflow language| [comparisons doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/comparisons/README.md) |
-| āļø| Updates to retry functionality | [retries: exponential backoff & max backoff](https://github.com/serverlessworkflow/specification/issues/137) [retries: max-attempts & interval](https://github.com/serverlessworkflow/specification/issues/136)|
-| āļø| Update "directInvoke" property type | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/specification.md) |
-| āļø| Data schema input/output update | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/specification.md) |
-| āļø| Updating start and end state definitions| [spec doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/specification.md) |
-| āļø| Update cron definition (adding validUntil parameter)| [spec doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/specification.md) |
-| āļø| Adding comparison examples with Temporal | [comparison doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/comparisons/README.md) |
-| āļø| Simplified functionRef and transition properties | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/specification.md) |
-| āļø| Adding comparison examples with Cadence | [comparison doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/comparisons/README.md) |
-| āļø| Adding workflow execTimeout and keepActive properties | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/specification.md) |
-| āļø| Adding SubFlow state repeat (loop) ability | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/specification.md) |
-| āļø| Adding comparison examples with BPMN | [comparison doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/comparisons/README.md) |
-| āļø| Adding RPC type to function definitions (gRPC) | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/specification.md) |
-| āļø| Change function definition 'parameters' to 'arguments' | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/specification.md) |
-| āļø| Replace JsonPath with jq | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/specification.md) |
-| āļø| Update start definition (move to top-level worklow param) | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/specification.md) |
-| āļø| Updated schedule definition | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/specification.md) |
-| āļø| Update data filters | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.6.x/specification.md) |
-
-## Released version v0.5
-
-| Status | Description | Comments |
-| --- | --- | --- |
-| ā | Update Switch State | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| ā | Rename Relay to Inject state | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Update waitForCompletion property of Parallel State | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Add timeout property to actions | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Add examples comparing Argo workflow and spec markups | [examples doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/examples/examples-argo.md) |
-| āļø| Add ability to produce events during state transitions | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Add event-based condition capabilities to Switch State | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Add examples comparing Brigade workflow and spec markups | [examples doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/examples/examples-brigade.md) |
-| āļø| Update produceEvent data property | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Change uppercase property and enum types to lowercase | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Add Parallel State Exception Handling section | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Add Go SDK | [sdk repo](https://github.com/serverlessworkflow/sdk-go) |
-| āļø| Add Java SDK | [sdk repo](https://github.com/serverlessworkflow/sdk-java) |
-| āļø| Allow to define events as produced or consumed | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Add "triggered" start definition | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Update scheduled start definition - adding cron def | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Add ability to reference trigger and result events in actions | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Expand event correlation capabilities | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Only use JsonPath expressions ( remove need for expression languages other than JsonPath) | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Update workflow extensions | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Add Workflow KPIs extension | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Add Workflow Validation to Java SDK | [sdk repo](https://github.com/serverlessworkflow/sdk-java) |
-| āļø| Update Switch state conditions and default definition | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Update transitions and end definition 'produceEvents' definition | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Events definition update - add convenience way to define multiple events that share properties | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Update to function and events definitions - allow inline array def as well as uri reference to external resource | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Enforce use of OpenAPI specification in function definitions for portability | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
-| āļø| Update workflow Error Handling | [spec doc](../specification.md) |
-
-## Released version v0.1
-
-| Status | Description | Comments |
-| :--: | --- | --- |
-| ā | Establish governance, contributing guidelines and initial stakeholder | [governance doc](https://github.com/cncf/wg-serverless/tree/v0.1/workflow/spec/governance) |
-| ā | Define specification goals | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
-| ā | Define specification functional scope | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
-| ā | Include set of use-cases for Serverless Workflow | [usecases doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/usecases.md) |
-| ā | Include set of examples for Serverless Workflow | [examples doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/examples.md) |
-| ā | Define specification JSON Schema | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
-| ā | Add SubFlow state | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
-| ā | Add Relay state | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
-| ā | Add ForEach state | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
-| ā | Update Event state| [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
-| ā | Define Workflow data input/output | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
-| ā | Update state data filtering | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
-| ā | Clearly define workflow info passing | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
-| ā | Add Workflow error handling | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
-| ā | Add reusable function definitions | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
-| ā | Add support for YAML definitions | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
-| ā | Update workflow end definition | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
-| ā | Add Callback state | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
-| ā | Add workflow metadata | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
-| āļø| Update workflow start definition | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
-| āļø| Prepare github branch and docs for v0.1 | [branch](https://github.com/cncf/wg-serverless/tree/v0.1/workflow/spec) |
diff --git a/schema/auth.json b/schema/auth.json
deleted file mode 100644
index d949e7c4..00000000
--- a/schema/auth.json
+++ /dev/null
@@ -1,195 +0,0 @@
-{
- "$id": "https://serverlessworkflow.io/schemas/0.9/auth.json",
- "$schema": "http://json-schema.org/draft-07/schema#",
- "description": "Serverless Workflow specification - auth schema",
- "type": "object",
- "auth": {
- "oneOf": [
- {
- "type": "string",
- "format": "uri",
- "description": "URI to a resource containing auth definitions (json or yaml)"
- },
- {
- "type": "array",
- "description": "Workflow auth definitions",
- "items": {
- "type": "object",
- "$ref": "#/definitions/authdef"
- },
- "additionalItems": false,
- "minItems": 1
- }
- ]
- },
- "required": [
- "auth"
- ],
- "definitions": {
- "authdef": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "Unique auth definition name",
- "minLength": 1,
- "pattern": "^[a-z0-9](-?[a-z0-9])*$"
- },
- "scheme": {
- "type": "string",
- "description": "Defines the auth type",
- "enum": [
- "basic",
- "bearer",
- "oauth2"
- ],
- "default": "basic"
- },
- "properties": {
- "oneOf": [
- {
- "type": "string",
- "description": "Expression referencing a workflow secret that contains all needed auth info"
- },
- {
- "title": "Basic Auth Info",
- "$ref": "#/definitions/basicpropsdef"
- },
- {
- "title": "Bearer Auth Info State",
- "$ref": "#/definitions/bearerpropsdef"
- },
- {
- "title": "OAuth2 Info",
- "$ref": "#/definitions/oauth2propsdef"
- }
- ]
- }
- },
- "required": [
- "name",
- "properties"
- ]
- },
- "basicpropsdef": {
- "type": "object",
- "description": "Basic auth information",
- "properties": {
- "username": {
- "type": "string",
- "description": "String or a workflow expression. Contains the user name",
- "minLength": 1
- },
- "password": {
- "type": "string",
- "description": "String or a workflow expression. Contains the user password",
- "minLength": 1
- },
- "metadata": {
- "$ref": "common.json#/definitions/metadata"
- }
- },
- "required": [
- "username",
- "password"
- ],
- "additionalProperties": false
- },
- "bearerpropsdef": {
- "type": "object",
- "description": "Bearer auth information",
- "properties": {
- "token": {
- "type": "string",
- "description": "String or a workflow expression. Contains the token",
- "minLength": 1
- },
- "metadata": {
- "$ref": "common.json#/definitions/metadata"
- }
- },
- "required": [
- "token"
- ],
- "additionalProperties": false
- },
- "oauth2propsdef": {
- "type": "object",
- "description": "OAuth2 information",
- "properties": {
- "authority": {
- "type": "string",
- "description": "String or a workflow expression. Contains the authority information",
- "minLength": 1
- },
- "grantType": {
- "type": "string",
- "description": "Defines the grant type",
- "enum": [
- "password",
- "clientCredentials",
- "tokenExchange"
- ],
- "additionalItems": false
- },
- "clientId": {
- "type": "string",
- "description": "String or a workflow expression. Contains the client identifier",
- "minLength": 1
- },
- "clientSecret": {
- "type": "string",
- "description": "Workflow secret or a workflow expression. Contains the client secret",
- "minLength": 1
- },
- "scopes": {
- "type": "array",
- "description": "Array containing strings or workflow expressions. Contains the OAuth2 scopes",
- "items": {
- "type": "string"
- },
- "minItems": 1,
- "additionalItems": false
- },
- "username": {
- "type": "string",
- "description": "String or a workflow expression. Contains the user name. Used only if grantType is 'resourceOwner'",
- "minLength": 1
- },
- "password": {
- "type": "string",
- "description": "String or a workflow expression. Contains the user password. Used only if grantType is 'resourceOwner'",
- "minLength": 1
- },
- "audiences": {
- "type": "array",
- "description": "Array containing strings or workflow expressions. Contains the OAuth2 audiences",
- "items": {
- "type": "string"
- },
- "minItems": 1,
- "additionalItems": false
- },
- "subjectToken": {
- "type": "string",
- "description": "String or a workflow expression. Contains the subject token",
- "minLength": 1
- },
- "requestedSubject": {
- "type": "string",
- "description": "String or a workflow expression. Contains the requested subject",
- "minLength": 1
- },
- "requestedIssuer": {
- "type": "string",
- "description": "String or a workflow expression. Contains the requested issuer",
- "minLength": 1
- },
- "metadata": {
- "$ref": "common.json#/definitions/metadata"
- }
- },
- "required": ["grantType", "clientId"]
- }
- }
-}
\ No newline at end of file
diff --git a/schema/common.json b/schema/common.json
deleted file mode 100644
index 4322f834..00000000
--- a/schema/common.json
+++ /dev/null
@@ -1,15 +0,0 @@
-{
- "$id": "https://serverlessworkflow.io/schemas/0.9/common.json",
- "$schema": "http://json-schema.org/draft-07/schema#",
- "description": "Serverless Workflow specification - common schema",
- "type": "object",
- "definitions": {
- "metadata": {
- "type": "object",
- "description": "Metadata information",
- "additionalProperties": {
- "type": "string"
- }
- }
- }
-}
\ No newline at end of file
diff --git a/schema/errors.json b/schema/errors.json
deleted file mode 100644
index 2026d7b4..00000000
--- a/schema/errors.json
+++ /dev/null
@@ -1,334 +0,0 @@
-{
- "$id":"https://serverlessworkflow.io/schemas/0.9/errors.json",
- "$schema":"http://json-schema.org/draft-07/schema#",
- "description":"Serverless Workflow specification - errors schema",
- "type":"object",
- "errors":{
- "oneOf":[
- {
- "type":"string",
- "format":"uri",
- "description":"URI to a resource containing workflow error strategy (json or yaml)"
- },
- {
- "type":"object",
- "description":"The workflow's error handling configuration, including error definitions, error handlers and error policies",
- "properties":{
- "definitions":{
- "type":"array",
- "description":"Defines errors that can be explicitly handled and/or thrown during workflow execution",
- "items":{
- "$ref":"#/definitions/errorDefinition"
- },
- "additionalItems":false,
- "minItems":1
- },
- "handlers":{
- "type":"array",
- "description":"Defines error handlers used to configure what to do when catching specific errors",
- "items":{
- "$ref":"#/definitions/errorHandler"
- },
- "additionalItems":false,
- "minItems":1
- },
- "policies":{
- "type":"array",
- "description":"Defines groups of error handlers that define reusable error policies",
- "items":{
- "$ref":"#/definitions/errorPolicy"
- },
- "additionalItems":false,
- "minItems":1
- }
- }
- }
- ]
- },
- "required":[
- "errors"
- ],
- "definitions":{
- "errorDefinition":{
- "type":"object",
- "properties":{
- "name":{
- "type":"string",
- "description":"The name of the error. Must follow the Serverless Workflow Naming Convention.",
- "pattern":"^[a-z0-9](-?[a-z0-9])*$",
- "minLength": 1
- },
- "source":{
- "type":"string",
- "description":"An RFC6901 JSON pointer that precisely identifies the component within a workflow definition (ex: funcRef, subflowRef, ...) from which the described issue originates",
- "pattern":"/(\/(([^/~])|(~[01]))*)/g",
- "minLength": 1
- },
- "type":{
- "type":"string",
- "description":"A RFC3986 URI reference that identifies the problem type. The RFC7807 Problem Details specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML)",
- "format":"uri",
- "minLength": 1
- },
- "status":{
- "type":"integer",
- "description":"The status code generated by the origin for an occurrence of a problem. Status codes are extensible by nature and runtimes are not required to understand the meaning of all defined status codes. However, for cross-compatibility purpose, the specification encourages using RFC7231 HTTP Status Codes"
- },
- "title":{
- "type":"string",
- "description":"A short, human-readable summary of a problem type. It SHOULD NOT change from occurrence to occurrence of a problem, except for purposes of localization"
- },
- "detail":{
- "type":"string",
- "description":"A human-readable explanation specific to an occurrence of a problem"
- }
- },
- "additionalProperties":false,
- "required":[
- "name",
- "type",
- "status",
- "source"
- ]
- },
- "errorReference":{
- "oneOf":[
- {
- "type":"object",
- "properties":{
- "refName":{
- "type":"string",
- "minLength": 1
- }
- },
- "required":[
- "refName"
- ],
- "additionalProperties":false
- },
- {
- "type":"object",
- "properties":{
- "instance":{
- "type":"string",
- "minLength": 1
- },
- "type":{
- "type":"string",
- "minLength": 1
- },
- "status":{
- "oneOf": [
- {
- "type": "string",
- "minLength": 1
- },
- {
- "type": "integer"
- }
- ]
- }
- },
- "minProperties":1,
- "additionalProperties":false
- }
- ]
- },
- "throw":{
- "oneOf":[
- {
- "type":"boolean",
- "description":"If true, rethrows the caught error as is"
- },
- {
- "type":"object",
- "anyOf":[
- {
- "required":[
- "refName"
- ],
- "properties":{
- "refName":{
- "type":"string"
- }
- }
- },
- {
- "required":[
- "type",
- "status"
- ],
- "properties":{
- "type":{
- "type":"string",
- "minLength": 1
- },
- "status":{
- "anyOf":[
- {
- "type":"integer"
- },
- {
- "type":"string",
- "minLength": 1
- }
- ]
- },
- "title":{
- "type":"string",
- "minLength": 1
- },
- "detail":{
- "type":"string",
- "minLength": 1
- }
- }
- }
- ]
- }
- ]
- },
- "errorHandler":{
- "type":"object",
- "properties":{
- "name":{
- "type":"string",
- "description":"The unique name which is used to reference the handler.",
- "pattern":"^[a-z0-9](-?[a-z0-9])*$",
- "minLength": 1
- },
- "when":{
- "type":"array",
- "items":{
- "$ref":"#/definitions/errorReference"
- },
- "description":"References the errors to handle. If null, and if `exceptWhen` is null, all errors are caught.",
- "additionalItems":false,
- "minItems":1
- },
- "exceptWhen":{
- "type":"array",
- "items":{
- "$ref":"#/definitions/errorReference"
- },
- "description":"References the errors not to handle. If null, and if `when` is null, all errors are caught.",
- "additionalItems":false,
- "minItems": 1
- },
- "retry":{
- "oneOf":[
- {
- "type":"string",
- "description":"The unique name of the retry definition to use"
- },
- {
- "$ref":"retries.json#/definitions/retrydef",
- "description":"The inline retry definition to use"
- }
- ]
- },
- "then":{
- "$ref":"#/definitions/errorOutcomeDefinition"
- }
- },
- "required":[
- "name"
- ]
- },
- "errorOutcomeDefinition":{
- "type":"object",
- "properties":{
- "compensate":{
- "type":"string",
- "description":"Unique Name of a workflow state which is responsible for compensation"
- },
- "end":{
- "$ref":"workflow.json#/definitions/end"
- },
- "transition":{
- "$ref":"workflow.json#/definitions/transition"
- },
- "throw":{
- "$ref":"#/definitions/throw"
- }
- },
- "minProperties":1,
- "maxProperties":1
- },
- "errorHandlerReference":{
- "type":"object",
- "oneOf":[
- {
- "properties":{
- "refName":{
- "type":"string",
- "minLength": 1
- }
- },
- "required":[
- "refName"
- ],
- "additionalProperties": false
- },
- {
- "properties":{
- "when":{
- "type":"array",
- "items":{
- "$ref":"#/definitions/errorReference"
- },
- "additionalItems":false,
- "minItems": 1
- },
- "exceptWhen":{
- "type":"array",
- "items":{
- "$ref":"#/definitions/errorReference"
- },
- "additionalItems":false,
- "minItems": 1
- },
- "retry":{
- "oneOf":[
- {
- "type":"string",
- "minLength": 1
- },
- {
- "$ref":"retries.json#/definitions/retrydef"
- }
- ]
- },
- "then":{
- "$ref":"#/definitions/errorOutcomeDefinition"
- }
- },
- "additionalProperties": false
- }
- ]
- },
- "errorPolicy":{
- "type":"object",
- "properties":{
- "name":{
- "type":"string",
- "description":"The unique name which is used to reference the policy.",
- "pattern":"^[a-z0-9](-?[a-z0-9])*$",
- "minLength": 1
- },
- "handlers":{
- "type":"array",
- "description":"Defines the handlers the policy is made out of",
- "items":{
- "$ref":"#/definitions/errorHandlerReference"
- },
- "additionalItems":false,
- "minItems": 1
- }
- },
- "required":[
- "name"
- ]
- }
- }
-}
\ No newline at end of file
diff --git a/schema/events.json b/schema/events.json
deleted file mode 100644
index 27fca014..00000000
--- a/schema/events.json
+++ /dev/null
@@ -1,108 +0,0 @@
-{
- "$id": "https://serverlessworkflow.io/schemas/0.9/events.json",
- "$schema": "http://json-schema.org/draft-07/schema#",
- "description": "Serverless Workflow specification - events schema",
- "type": "object",
- "events": {
- "oneOf": [
- {
- "type": "string",
- "format": "uri",
- "description": "URI to a resource containing event definitions (json or yaml)"
- },
- {
- "type": "array",
- "description": "Workflow CloudEvent definitions. Defines CloudEvents that can be consumed or produced",
- "items": {
- "type": "object",
- "$ref": "#/definitions/eventdef"
- },
- "additionalItems": false,
- "minItems": 1
- }
- ]
- },
- "required": [
- "events"
- ],
- "definitions": {
- "eventdef": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "Unique event name",
- "minLength": 1,
- "pattern": "^[a-z0-9](-?[a-z0-9])*$"
- },
- "source": {
- "type": "string",
- "description": "CloudEvent source"
- },
- "type": {
- "type": "string",
- "description": "CloudEvent type"
- },
- "correlation": {
- "type": "array",
- "description": "CloudEvent correlation definitions",
- "minItems": 1,
- "items": {
- "type": "object",
- "$ref": "#/definitions/correlationDef"
- },
- "additionalItems": false
- },
- "dataOnly": {
- "type": "boolean",
- "default": true,
- "description": "If `true`, only the Event payload is accessible to consuming Workflow states. If `false`, both event payload and context attributes should be accessible "
- },
- "metadata": {
- "$ref": "common.json#/definitions/metadata",
- "description": "Metadata information"
- }
- },
- "additionalProperties": false,
- "if": {
- "properties": {
- "source": {
- "type": "null"
- }
- }
- },
- "then": {
- "required": [
- "name",
- "type"
- ]
- },
- "else": {
- "required": [
- "name",
- "source"
- ]
- }
- },
- "correlationDef": {
- "type": "object",
- "description": "CloudEvent correlation definition",
- "properties": {
- "contextAttributeName": {
- "type": "string",
- "description": "CloudEvent Extension Context Attribute name",
- "minLength": 1
- },
- "contextAttributeValue": {
- "type": "string",
- "description": "CloudEvent Extension Context Attribute value",
- "minLength": 1
- }
- },
- "additionalProperties": false,
- "required": [
- "contextAttributeName"
- ]
- }
- }
-}
\ No newline at end of file
diff --git a/schema/extensions.json b/schema/extensions.json
deleted file mode 100644
index 364b543e..00000000
--- a/schema/extensions.json
+++ /dev/null
@@ -1,50 +0,0 @@
-{
- "$id": "https://serverlessworkflow.io/schemas/0.9/extensions.json",
- "$schema": "http://json-schema.org/draft-07/schema#",
- "description": "Serverless Workflow specification - extensions schema",
- "type": "object",
- "extensions": {
- "oneOf": [
- {
- "type": "string",
- "format": "uri",
- "description": "URI to a resource containing workflow extensions definitions (json or yaml)"
- },
- {
- "type": "array",
- "description": "Workflow extensions definitions",
- "items": {
- "type": "object",
- "$ref": "#/definitions/extension"
- },
- "additionalItems": false,
- "minItems": 1
- }
- ]
- },
- "required": [
- "extensions"
- ],
- "definitions": {
- "extension": {
- "type": "object",
- "properties": {
- "extensionId": {
- "type": "string",
- "description": "Unique extension id",
- "minLength": 1
- },
- "resource": {
- "type": "string",
- "description": "URI to a resource containing this workflow extension definitions (json or yaml)",
- "minLength": 1
- }
- },
- "additionalProperties": false,
- "required": [
- "extensionId",
- "resource"
- ]
- }
- }
-}
\ No newline at end of file
diff --git a/schema/extensions/kpi.json b/schema/extensions/kpi.json
deleted file mode 100644
index 08a81382..00000000
--- a/schema/extensions/kpi.json
+++ /dev/null
@@ -1,289 +0,0 @@
-{
- "$id": "https://serverlessworkflow.io/schemas/0.8/extensions/kpi.json",
- "$schema": "http://json-schema.org/draft-07/schema#",
- "description": "Serverless Workflow specification - KPIs Extension Schema",
- "type": "object",
- "definitions": {
- "kpi": {
- "type": "object",
- "description": "Serverless Workflow KPI Extension",
- "properties": {
- "extensionid": {
- "type": "string",
- "default": "workflow-kpi-extension",
- "description": "Extension unique identifier"
- },
- "workflowid": {
- "type": "string",
- "minLength": 1,
- "description": "Workflow definition unique identifier (workflow id property)"
- },
- "workflowVersions": {
- "type": "array",
- "description": "Workflow versions. If not defined, applies to all workflow instances (regardless of their associated workflow version)",
- "items": {
- "type": "string"
- }
- },
- "currency": {
- "type": "string",
- "default": "USD",
- "description": "Unit for all cost-based KPI parameters. Default 'USD'"
- },
- "events": {
- "type": "array",
- "description": "Events KPIs",
- "items": {
- "type": "object",
- "$ref": "#/definitions/eventskpi"
- }
- },
- "functions": {
- "type": "array",
- "description": "Functions KPIs",
- "items": {
- "type": "object",
- "$ref": "#/definitions/functionskpi"
- }
- },
- "states": {
- "type": "array",
- "description": "States KPIs",
- "items": {
- "type": "object",
- "$ref": "#/definitions/stateskpi"
- }
- },
- "workflow": {
- "description": "Workflow KPIs",
- "$ref": "#/definitions/workflowkpi"
- }
- },
- "required": [
- "extensionid",
- "workflowid"
- ]
- },
- "eventskpi": {
- "type": "object",
- "properties": {
- "for": {
- "type": "string",
- "description": "References an unique event name in the defined workflow events"
- },
- "per": {
- "description": "Define the kpi thresholds in terms of time and/or num of workflow instances",
- "$ref": "#/definitions/thresholds"
- },
- "maxConsumed": {
- "type": "string",
- "description": "If event kind is 'consumed', the max amount of times this event is consumed"
- },
- "minConsumed": {
- "type": "string",
- "description": "If event kind is 'consumed', the min amount of times this event is consumed"
- },
- "avgConsumed": {
- "type": "string",
- "description": "If event kind is 'consumed', the avg amount of times this event is consumed"
- },
- "maxProduced": {
- "type": "string",
- "description": "If event kind is 'produced', the max amount of times this event is produced"
- },
- "minProduced": {
- "type": "string",
- "description": "If event kind is 'produced', the min amount times this event is produced"
- },
- "avgProduced": {
- "type": "string",
- "description": "If event kind is 'produced', the avg amount of times this event is produced"
- }
- },
- "required": [
- "for",
- "per"
- ]
- },
- "functionskpi": {
- "type": "object",
- "allOf": [
- {
- "properties": {
- "for": {
- "type": "string",
- "description": "References an unique function name in the defined workflow functions"
- },
- "per": {
- "description": "Define the kpi thresholds in terms of time and/or num of workflow instances",
- "$ref": "#/definitions/thresholds"
- },
- "maxErrors": {
- "type": "string",
- "description": "Max number of errors during function invocation"
- },
- "maxRetry": {
- "type": "string",
- "description": "Max number of retries done for this function invocation"
- },
- "maxTimeout": {
- "type": "string",
- "description": "Max number of times the function timeout time was reached"
- }
- }
- },
- {
- "$ref": "#/definitions/invocationkpis"
- },
- {
- "$ref": "#/definitions/costkpis"
- }
- ],
- "required": [
- "for",
- "per"
- ]
- },
- "stateskpi": {
- "type": "object",
- "allOf": [
- {
- "properties": {
- "for": {
- "type": "string",
- "description": "References an unique state name in the defined workflow events"
- },
- "per": {
- "description": "Define the kpi thresholds in terms of time and/or num of workflow instances",
- "$ref": "#/definitions/thresholds"
- }
- }
- },
- {
- "$ref": "#/definitions/execkpis"
- },
- {
- "$ref": "#/definitions/durationkpis"
- },
- {
- "$ref": "#/definitions/costkpis"
- }
- ],
- "required": [
- "for",
- "per"
- ]
- },
- "workflowkpi": {
- "type": "object",
- "allOf": [
- {
- "properties": {
- "per": {
- "description": "Define the kpi thresholds in terms of time and/or num of workflow instances",
- "$ref": "#/definitions/thresholds"
- }
- }
- },
- {
- "$ref": "#/definitions/invocationkpis"
- },
- {
- "$ref": "#/definitions/durationkpis"
- },
- {
- "$ref": "#/definitions/costkpis"
- }
- ],
- "required": [
- "per"
- ]
- },
- "thresholds": {
- "type": "object",
- "properties": {
- "time": {
- "type": "string",
- "default": "PT1D",
- "description": "ISO_8601 time. 1 day default"
- },
- "instances": {
- "type": "integer",
- "minimum": 1,
- "default": 1,
- "description": "Number of workflow instances"
- }
- },
- "required": [
- ]
- },
- "costkpis": {
- "type": "object",
- "properties": {
- "maxCost": {
- "type": "string",
- "description": "Max cost"
- },
- "minCost": {
- "type": "string",
- "description": "Min cost"
- },
- "avgCost": {
- "type": "string",
- "description": "Avg cost"
- }
- }
- },
- "invocationkpis": {
- "type": "object",
- "properties": {
- "maxInvoked": {
- "type": "string",
- "description": "Max number of invocation times"
- },
- "minInvoked": {
- "type": "string",
- "description": "Min number of invocation times"
- },
- "avgInvoked": {
- "type": "string",
- "description": "Avg number of invocation times"
- }
- }
- },
- "durationkpis": {
- "type": "object",
- "properties": {
- "maxDuration": {
- "type": "string",
- "description": "ISO 8601. Max duration"
- },
- "minDuration": {
- "type": "string",
- "description": "ISO 8601. Min duration"
- },
- "avgDuration": {
- "type": "string",
- "description": "ISO 8601. Avg duration"
- }
- }
- },
- "execkpis": {
- "type": "object",
- "properties": {
- "maxExec": {
- "type": "string",
- "description": "Max exec number"
- },
- "minExec": {
- "type": "string",
- "description": "Min exec numbe"
- },
- "avgExec": {
- "type": "string",
- "description": "Avg exec number"
- }
- }
- }
- }
-}
\ No newline at end of file
diff --git a/schema/extensions/ratelimiting.json b/schema/extensions/ratelimiting.json
deleted file mode 100644
index a7bc6f2c..00000000
--- a/schema/extensions/ratelimiting.json
+++ /dev/null
@@ -1,73 +0,0 @@
-{
- "$id": "https://serverlessworkflow.io/schemas/0.8/extensions/ratelimiting.json",
- "$schema": "http://json-schema.org/draft-07/schema#",
- "description": "Serverless Workflow specification - Various workflow rate limiting settings",
- "type": "object",
- "definitions": {
- "ratelimiting": {
- "type": "object",
- "description": "Serverless Workflow Rate Limiting Extension",
- "properties": {
- "extensionid": {
- "type": "string",
- "default": "workflow-ratelimiting-extension",
- "description": "Extension unique identifier"
- },
- "workflowid": {
- "type": "string",
- "minLength": 1,
- "description": "Workflow definition unique identifier (workflow id property)"
- },
- "workflowVersions": {
- "type": "array",
- "description": "Workflow versions. If not defined, applies to all workflow instances (regardless of their associated workflow version)",
- "items": {
- "type": "string"
- }
- },
- "singleInstance": {
- "description": "Rate Limit settings per single instance of a workflow with provided workflowid",
- "$ref": "#/definitions/ratelimits"
- },
- "allInstances": {
- "description": "Rate Limit settings across all instance of a workflow with provided workflowid",
- "$ref": "#/definitions/ratelimits"
- }
- },
- "required": [
- "extensionid",
- "workflowid"
- ]
- },
- "ratelimits": {
- "type": "object",
- "properties": {
- "maxActionsPerSecond": {
- "type": "number",
- "default": 0,
- "description": "Sets the rate limiting on number of actions that can be executed per second. Notice that the number is represented as number type, so that you can set it to less than 1 if needed. For example, set the number to 0.1 means workflow actions can be executed once every 10 seconds. Default zero value means 'unlimited'"
- },
- "maxConcurrentActions": {
- "type": "number",
- "default": 100,
- "description": "Maximum number of actions that can be executed in parallel"
- },
- "maxProducedEventsPerSecond": {
- "type": "number",
- "default": 0,
- "description": "Sets the rate limiting on number of events that can be produced per second. Notice that the number is represented as number type, so that you can set it to less than 1 if needed. For example, set the number to 0.1 means workflow can produce events once every 10 seconds. Default zero value means 'unlimited'"
- },
- "maxStates": {
- "type": "integer",
- "default": 0,
- "description": "Maximum number of workflow states that should be executed. Default is zero, meaning unlimited."
- },
- "maxTransitions": {
- "type": "integer",
- "default": 0,
- "description": "Maximum number of workflow transitions that should be executed. Default is zero, meaning unlimited."
- }
- }
- }
- }
-}
\ No newline at end of file
diff --git a/schema/functions.json b/schema/functions.json
deleted file mode 100644
index 44906f25..00000000
--- a/schema/functions.json
+++ /dev/null
@@ -1,143 +0,0 @@
-{
- "$id": "https://serverlessworkflow.io/schemas/0.9/functions.json",
- "$schema": "http://json-schema.org/draft-07/schema#",
- "description": "Serverless Workflow specification - functions schema",
- "type": "object",
- "functions": {
- "oneOf": [
- {
- "type": "string",
- "format": "uri",
- "description": "URI to a resource containing function definitions (json or yaml)"
- },
- {
- "type": "array",
- "description": "Workflow function definitions",
- "items": {
- "type": "object",
- "$ref": "#/definitions/function"
- },
- "additionalItems": false,
- "minItems": 1
- }
- ]
- },
- "required": ["functions"],
- "definitions": {
- "function": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "Unique function name",
- "minLength": 1,
- "pattern": "^[a-z0-9](-?[a-z0-9])*$"
- },
- "operation": {
- "$ref": "#/definitions/operation"
- },
- "type": {
- "type": "string",
- "description": "Defines the function type. Is either `http`, `openapi`,`asyncapi, `rpc`, `graphql`, `odata`, `expression`, or `custom`. Default is `openapi`.",
- "enum": [
- "http",
- "openapi",
- "asyncapi",
- "rpc",
- "graphql",
- "odata",
- "expression",
- "custom"
- ],
- "default": "openapi"
- },
- "authRef": {
- "oneOf": [
- {
- "type": "string",
- "description": "References the auth definition to be used to invoke the operation",
- "minLength": 1,
- "pattern": "^[a-z0-9](-?[a-z0-9])*$"
- },
- {
- "type": "object",
- "description": "Configures both the auth definition used to retrieve the operation's resource and the auth definition used to invoke said operation",
- "properties": {
- "resource": {
- "type": "string",
- "description": "References an auth definition to be used to access the resource defined in the operation parameter",
- "minLength": 1,
- "pattern": "^[a-z0-9](-?[a-z0-9])*$"
- },
- "invocation": {
- "type": "string",
- "description": "References an auth definition to be used to invoke the operation"
- }
- },
- "additionalProperties": false,
- "required": ["resource"]
- }
- ]
- },
- "metadata": {
- "$ref": "common.json#/definitions/metadata"
- }
- },
- "additionalProperties": false,
- "required": ["name", "operation"]
- },
- "operation": {
- "oneOf": [
- {
- "type": "string",
- "description": "If type is `openapi`, FunctionFlow FDL (Flow Definition Language) model
- - The language is documented [here](https://help.aliyun.com/document_detail/122492.html). - The following entities have been extracted from [fnf examples](https://github.com/awesome-fnf). - - Each flow activation maintains a context addressable with XPath (JSONPath). The event that has triggered the execution is provided in $.input, outputs of serverless functions are available in $.local and unless outputMappings are specified, $.local is passed on. - -flow: - -- steps lists the steps to be executed (using goto) -- outputMappings to map the workflow output to a response - -step types: - -- task (invoke serverless function) - - resourceArn that points to the function - - inputMappings to map input data to parameters of the serverless function - - retry to retry on errors or outcomes that retry the execution with backing-off intervals and number of attempts - - catch to jump to a different state upon errors -- succeed (an end state) -- fail (an end state) -- wait -- pass (useful for mapping of data) -- choice - - inputMappings - - choices (condition + goto) - - default -- parallel -- foreach - - inputMappings - - iterationMapping (to define branching) - -
-
-
-
-
-
-
-
-
-
-
-
-
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "stateDataFilter": { - "input": "${ .orders }", - "output": "${ .provisionedOrders }" - } -} -``` - - | -- -```yaml -stateDataFilter: - input: "${ .orders }" - output: "${ .provisionedOrders }" -``` - - | -
-
-
-
-
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "actionDataFilter": { - "fromStateData": "${ .language }", - "results": "${ .results.greeting }", - "toStateData": "${ .finalgreeting }" - } -} -``` - - | -- -```yaml -actionDataFilter: - fromStateData: "${ .language }" - results: "${ .results.greeting }" - toStateData: "${ .finalgreeting }" -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "eventDataFilter": { - "data": "${ .data.results }" - } -} -``` - - | -- -```yaml -eventDataFilter: - data: "${ .data.results }" -``` - - | -
-
-
-
-
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "name": "sample-workflow", - "version": "1.0.0", - "specVersion": "0.8", - "description": "Sample Workflow", - "start": "MyStartingState", - "states": [], - "functions": [], - "events": [], - "errors": [], - "retries":[] -} -``` - - | -- -```yaml -name: sample-workflow -version: '1.0.0' -specVersion: '0.8' -description: Sample Workflow -start: MyStartingState -states: [] -functions: [] -events: [] -errors: [] -retries: [] -``` - - | -
-
-
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ -"name": "monitor-vitals", -"type": "event", -"exclusive": true, -"onEvents": [{ - "eventRefs": ["high-body-temperature"], - "actions": [{ - "functionRef": { - "refName": "send-tylenol-order", - "arguments": { - "patientid": "${ .patientId }" - } - } - }] - }, - { - "eventRefs": ["high-blood-pressure"], - "actions": [{ - "functionRef": { - "refName": "call-nurse", - "arguments": { - "patientid": "${ .patientId }" - } - } - }] - }, - { - "eventRefs": ["high-respiration-rate"], - "actions": [{ - "functionRef": { - "refName": "call-pulmonologist", - "arguments": { - "patientid": "${ .patientId }" - } - } - }] - } -], -"end": { - "terminate": true -} -} -``` - - | -- -```yaml -name: monitor-vitals -type: event -exclusive: true -onEvents: -- eventRefs: - - high-body-temperature - actions: - - functionRef: - refName: send-tylenol-order - arguments: - patientid: "${ .patientId }" -- eventRefs: - - high-blood-pressure - actions: - - functionRef: - refName: call-nurse - arguments: - patientid: "${ .patientId }" -- eventRefs: - - high-respiration-rate - actions: - - functionRef: - refName: call-pulmonologist - arguments: - patientid: "${ .patientId }" -end: - terminate: true -``` - - | -
-
-
-
-
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "name": "reject-application", - "type": "operation", - "actionMode": "sequential", - "actions": [ - { - "functionRef": { - "refName": "send-rejection-email-function", - "arguments": { - "customer": "${ .customer }" - } - } - } - ], - "end": true -} -``` - - | -- -```yaml -name: reject-application -type: operation -actionMode: sequential -actions: -- functionRef: - refName: send-rejection-email-function - arguments: - customer: "${ .customer }" -end: true -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "name":"check-visa-status", - "type":"switch", - "eventConditions": [ - { - "eventRef": "visa-approved-event", - "transition": "handle-approved-visa" - }, - { - "eventRef": "visa-rejected-event", - "transition": "handle-rejected-visa" - } - ], - "timeouts": { - "eventTimeout": "PT1H" - }, - "defaultCondition": { - "transition": "handle-no-visa-decision" - } -} -``` - - | -- -```yaml -name: check-visa-status -type: switch -eventConditions: -- eventRef: visa-approved-event - transition: handle-approved-visa -- eventRef: visa-rejected-event - transition: handle-rejected-visa -timeouts: - eventTimeout: PT1H -defaultCondition: - transition: handle-no-visa-decision -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json - { - "name":"parallel-exec", - "type":"parallel", - "completionType": "allOf", - "branches": [ - { - "name": "branch-1", - "actions": [ - { - "functionRef": { - "refName": "function-name-one", - "arguments": { - "order": "${ .someParam }" - } - } - } - ] - }, - { - "name": "branch-2", - "actions": [ - { - "functionRef": { - "refName": "function-name-two", - "arguments": { - "order": "${ .someParam }" - } - } - } - ] - } - ], - "end": true -} -``` - - | -- -```yaml -name: parallel-exec -type: parallel -completionType: allOf -branches: -- name: branch-1 - actions: - - functionRef: - refName: function-name-one - arguments: - order: "${ .someParam }" -- name: branch-2 - actions: - - functionRef: - refName: function-name-two - arguments: - order: "${ .someParam }" -end: true -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "name":"hello", - "type":"inject", - "data": { - "result": "Hello" - }, - "transition": "world" -} -``` - - | -- -```yaml -name: hello -type: inject -data: - result: Hello -transition: world -``` - - | -
| JSON | -YAML | -
|---|---|
| - - ```json - { - "name":"simple-inject-state", - "type":"inject", - "data": { - "person": { - "fname": "John", - "lname": "Doe", - "address": "1234 SomeStreet", - "age": 40 - } - }, - "transition": "greet-person-state" - } - ``` - - | -- -```yaml - name: simple-inject-state - type: inject - data: - person: - fname: John - lname: Doe - address: 1234 SomeStreet - age: 40 - transition: greet-person-state -``` - - | -
| JSON | -YAML | -
|---|---|
| - -```json - { - "name":"simple-inject-state", - "type":"inject", - "data": { - "people": [ - { - "fname": "John", - "lname": "Doe", - "address": "1234 SomeStreet", - "age": 40 - }, - { - "fname": "Marry", - "lname": "Allice", - "address": "1234 SomeStreet", - "age": 25 - }, - { - "fname": "Kelly", - "lname": "Mill", - "address": "1234 SomeStreet", - "age": 30 - } - ] - }, - "stateDataFilter": { - "output": "${ {people: [.people[] | select(.age < 40)]} }" - }, - "transition": "greet-person-state" - } -``` - - | -- -```yaml - name: simple-inject-state - type: inject - data: - people: - - fname: John - lname: Doe - address: 1234 SomeStreet - age: 40 - - fname: Marry - lname: Allice - address: 1234 SomeStreet - age: 25 - - fname: Kelly - lname: Mill - address: 1234 SomeStreet - age: 30 - stateDataFilter: - output: "${ {people: [.people[] | select(.age < 40)]} }" - transition: greet-person-state -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "name": "provision-orders-state", - "type": "foreach", - "inputCollection": "${ .orders }", - "iterationParam": "singleorder", - "outputCollection": "${ .provisionresults }", - "actions": [ - { - "functionRef": { - "refName": "provision-order-function", - "arguments": { - "order": "${ $singleorder }" - } - } - } - ] -} -``` - - | -- -```yaml -name: provision-orders-state -type: foreach -inputCollection: "${ .orders }" -iterationParam: "singleorder" -outputCollection: "${ .provisionresults }" -actions: -- functionRef: - refName: provision-order-function - arguments: - order: "${ $singleorder }" -``` - - | -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "name": "send-confirmation-for-completed-orders", - "version": "1.0.0", - "specVersion": "0.8", - "start": "send-confirm-state", - "functions": [ - { - "name": "send-confirmation-function", - "operation": "file://confirmationapi.json#sendOrderConfirmation" - } - ], - "states": [ - { - "name":"send-confirm-state", - "type":"foreach", - "inputCollection": "${ [.orders[] | select(.completed == true)] }", - "iterationParam": "completedorder", - "outputCollection": "${ .confirmationresults }", - "actions":[ - { - "functionRef": { - "refName": "send-confirmation-function", - "arguments": { - "orderNumber": "${ $completedorder.orderNumber }", - "email": "${ $completedorder.email }" - } - } - }], - "end": true - }] -} -``` - - | -- -```yaml -name: send-confirmation-for-completed-orders -version: '1.0.0' -specVersion: '0.8' -start: send-confirm-state -functions: -- name: send-confirmation-function - operation: file://confirmationapi.json#sendOrderConfirmation -states: -- name: send-confirm-state - type: foreach - inputCollection: "${ [.orders[] | select(.completed == true)] }" - iterationParam: completedorder - outputCollection: "${ .confirmationresults }" - actions: - - functionRef: - refName: send-confirmation-function - arguments: - orderNumber: "${ $completedorder.orderNumber }" - email: "${ $completedorder.email }" - end: true -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "name": "check-credit", - "type": "callback", - "action": { - "functionRef": { - "refName": "call-credit-check-microservice", - "arguments": { - "customer": "${ .customer }" - } - } - }, - "eventRef": "credit-check-completed-event", - "timeouts": { - "stateExecTimeout": "PT15M" - }, - "transition": "evaluate-decision" -} -``` - - | -- -```yaml -name: check-credit -type: callback -action: - functionRef: - refName: call-credit-check-microservice - arguments: - customer: "${ .customer }" -eventRef: credit-check-completed-event -timeouts: - stateExecTimeout: PT15M -transition: evaluate-decision -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "name": "hello-world-function", - "operation": "https://hellworldservice.api.com/api.json#helloWorld" -} -``` - - | -- -```yaml -name: hello-world-function -operation: https://hellworldservice.api.com/api.json#helloWorld -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "name": "applicant-info", - "type": "org.application.info", - "source": "applicationssource", - "correlation": [ - { - "contextAttributeName": "applicantId" - } - ] -} -``` - - | -- -```yaml -name: applicant-info -type: org.application.info -source: applicationssource -correlation: -- contextAttributeName: applicantId -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "correlation": [ - { - "contextAttributeName": "patientId" - }, - { - "contextAttributeName": "department", - "contextAttributeValue" : "UrgentCare" - } - ] -} -``` - - | -- -```yaml -correlation: -- contextAttributeName: patientId -- contextAttributeName: department - contextAttributeValue: UrgentCare -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "eventRefs": ["high-body-temperature"], - "actions": [{ - "functionRef": { - "refName": "send-tylenol-order", - "arguments": { - "patientid": "${ .patientId }" - } - } - }] -} -``` - - | -- -```yaml -eventRefs: -- high-body-temperature -actions: -- functionRef: - refName: send-tylenol-order - arguments: - patientid: "${ .patientId }" -``` - - | -
-
-
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "name": "finalize-application-action", - "functionRef": { - "refName": "finalize-application-function", - "arguments": { - "applicantid": "${ .applicantId }" - } - } -} -``` - - | -- -```yaml -name: finalize-application-action -functionRef: - refName: finalize-application-function - arguments: - applicantid: "${ .applicantId }" -``` - - | -
-
-
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "refName": "finalize-application-function", - "arguments": { - "applicantid": "${ .applicantId }" - } -} -``` - - | -- -```yaml -refName: finalize-application-function -arguments: - applicantid: "${ .applicantId }" -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "publish": { - "event": "make-vet-appointment", - "data": "${ .patientInfo }", - } -} -``` - - | -- -```yaml -publish: - event: make-vet-appointment - data: "${ .patientInfo }" -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "subscribe": { - "name": "approved-appointment", - } -} -``` - - | -- -```yaml -eventRef: - subscribe: approved-appointment - -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "workflowId": "handle-approved-visa", - "version": "2.0.0" -} -``` - - | -- -```yaml -workflowId: handle-approved-visa -version: '2.0.0' -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "retries": [ - { - "name": "retry-five-times", - "maxAttempts": 5 - } - ], - "errors": { - "definitions": [ - { - "name": "service-not-available-error", - "type": "https://serverlessworkflow.io/spec/errors/communication", - "status": 503, - "title": "Service Not Available", - "detail": "Failed to contact service, even after multiple retries" - } - ], - "handlers": [ - { - "name": "handle-503", - "when": [ - { - "status": 503 - } - ], - "retry": "retry-five-times", - "then": { - "throw": { - "refName": "service-not-available-error" - } - } - } - ], - "policies": [ - { - "name": "fault-tolerance-policy", - "handlers": [ - { - "refName": "handle-503" - } - ] - } - ] - } -} -``` - - | -- -```yaml -retries: - - name: retry-five-times - maxAttempts: 5 -errors: - definitions: - - name: service-not-available-error - type: https://serverlessworkflow.io/spec/errors/communication - status: 503 - title: Service Not Available - detail: Failed to contact service, even after multiple retries - handlers: - - name: handle-503 - when: - - status: 503 - retry: retry-five-times - then: - throw: - refName: service-not-available-error - policies: - - name: fault-tolerance-policy - handlers: - - refName: handle-503 -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "instance": "/states/0/actions/0", - "type": "https://example.com/errors#timeout", - "status": 504, - "title": "Function Timeout", - "detail": "The function 'my-function' timed out." -} -``` - - | -- -```yaml -instance: "/states/0/actions/0" -type: "https://example.com/errors#timeout" -status: 504 -title: "Function Timeout" -detail: "The function 'my-function' timed out." -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "type": "https://example.com/errors#timeout", - "status": 504 -} -``` - - | -- -```yaml -type: "https://example.com/errors#timeout" -status: 504 -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "errors": { - "handlers": [ - { - "name": "handle-invalid-error", - "when": [ - { "error": "invalid" }, - { "status": 404 }, - { "status": 403 } - ], - "then": { - "transition": "my-state" - } - }, - { - "name": "handle-timeout-error", - "when": [ - { "status": 503 } - ], - "retry": "my-retry-policy", - "then": { - "transition": "my-state" - } - } - ] - } -} -``` - - | -- -```yaml -errors: - handlers: - - name: 'handle-invalid-error' - when: - - type: 'invalid' - - status: 404 - - status: 403 - then: - transition: 'my-state' - - name: 'handle-timeout-error' - when: - - status: 503 - retry: 'my-retry-policy' - then: - transition: 'my-state' -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "errors": { - "policies": [ - { - "name": "my-retry-policy", - "handlers": [ - { - "refName": "handle-timeout-error" - }, - { - "when": [ - { "status": 503 } - ], - "retry": "my-retry-policy" - } - ] - } - ] - } -} -``` - - | -- -```yaml -errors: - policies: - - name: 'my-retry-policy' - handlers: - - refName: 'handle-timeout-error' - - when: - - status: 503 - retry: 'my-retry-policy' -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "errors": { - "policies": [ - { - "name": "my-retry-policy", - "handlers": [ - { - "refName": "handle-timeout-error" - }, - { - "when": [ - { "status": 503 } - ], - "retry": "my-retry-policy" - } - ] - } - ] - } -} -``` - - | -- -```yaml -errors: - policies: - - name: 'my-retry-policy' - handlers: - - refName: 'handle-timeout-error' - - when: - - status: 503 - retry: 'my-retry-policy' -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "when": [ - { - "status": 503 - } - ], - "then": { - "transition": "my-state" - } -} -``` - - | -- -```yaml -when: - - status: 503 -then: - transition: 'my-state' -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "throw": { - "type": "https://serverlessworkflow.io/spec/errors/runtime", - "status": 400, - "detail": "${ $CONST.localizedErrorDetail }" - } -} -``` - - | -- -```yaml -throw: - type: https://serverlessworkflow.io/spec/errors/runtime - status: 400 - detail: ${ $CONST.localizedErrorDetail } -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "name": "timeout-retry-strat", - "delay": "PT2M", - "maxAttempts": 3, - "jitter": "PT0.001S" -} -``` - - | -- -```yaml -name: timeout-retry-strat -delay: PT2M -maxAttempts: 3 -jitter: PT0.001S -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "produceEvents": [{ - "eventRef": "produce-result-event", - "data": "${ .result.data }" - }], - "nextState": "eval-result-state" -} -``` - - | -- -```yaml -produceEvents: -- eventRef: produce-result-event - data: "${ .result.data }" -nextState: eval-result-state -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "name": "eighteen-or-older", - "condition": "${ .applicant | .age >= 18 }", - "transition": "start-application" -} -``` - - | -- -```yaml -name: eighteen-or-older -condition: "${ .applicant | .age >= 18 }" -transition: start-application -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "name": "visa-approved", - "eventRef": "visa-approved-event", - "transition": "handle-approved-visa" -} -``` - - | -- -```yaml -name: visa-approved -eventRef: visa-approved-event -transition: handle-approved-visa -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "name": "branch-1", - "actions": [ - { - "functionRef": { - "refName": "function-name-one", - "arguments": { - "order": "${ .someParam }" - } - } - }, - { - "functionRef": { - "refName": "function-name-two", - "arguments": { - "order": "${ .someParamTwo }" - } - } - } - ] -} -``` - - | -- -```yaml -name: branch-1 -actions: -- functionRef: - refName: function-name-one - arguments: - order: "${ .someParam }" -- functionRef: - refName: function-name-two - arguments: - order: "${ .someParamTwo }" -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "stateName": "my-starting-state", - "schedule": "2020-03-20T09:00:00Z/PT2H" -} -``` - - | -- -```yaml -stateName: my-starting-state -schedule: 2020-03-20T09:00:00Z/PT2H -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "cron": "0 0/15 * * * ?" -} -``` - - | -- -```yaml -cron: 0 0/15 * * * ? -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "expression": "0 15,30,45 * ? * *", - "validUntil": "2021-11-05T08:15:30-05:00" -} -``` - - | -- -```yaml -expression: 0 15,30,45 * ? * * -validUntil: '2021-11-05T08:15:30-05:00' -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "terminate": true, - "produceEvents": [{ - "eventRef": "provisioning-complete-event", - "data": "${ .provisionedOrders }" - }] -} -``` - - | -- -```yaml -terminate: true -produceEvents: -- eventRef: provisioning-complete-event - data: "${ .provisionedOrders }" - -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "eventRef": "provisioning-complete-event", - "data": "${ .provisionedOrders }", - "contextAttributes": { - "buyerId": "${ .buyerId }" - } - } -``` - - | -- -```yaml -eventRef: provisioning-complete-event -data: "${ .provisionedOrders }" -contextAttributes: - buyerId: "${ .buyerId }" -``` - - | -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "actions": [ - { - "name": "my-action", - "functionRef": "my-function", - "onErrors": [ - { - "when": [ - { - "status": 503 - } - ], - "retry": "retry-five-times" - } - ] - } - ] -} - -``` - - | -- -```yaml -actions: - - name: my-action - functionRef: my-function - onErrors: - - when: - - status: 503 - retry: retry-five-times -``` - - | -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "errors": { - "definitions": [ - { - "name": "service-not-available-error", - "type": "https://serverlessworkflow.io/spec/errors/communication", - "status": 503, - "title": "Service Not Available", - "detail": "Failed to contact service, even after multiple retries" - } - ], - "handlers": [ - { - "name": "handle-503", - "when": [ - { - "status": 503 - } - ], - "retry": "retry-five-times", - "then": { - "throw": { - "refName": "service-not-available-error" - } - } - } - ] - }, - "states": [ - { - "name": "my-state", - "type": "operation", - "actions": [ - { - "name": "my-action", - "functionRef": "my-function", - "onErrors": [ - { - "refName": "handle-503" - } - ] - } - ] - } - ] -} - -``` - - | -- -```yaml -errors: - definitions: - - name: service-not-available-error - type: https://serverlessworkflow.io/spec/errors/communication - status: 503 - title: Service Not Available - detail: Failed to contact service, even after multiple retries - handlers: - - name: handle-503 - when: - - status: 503 - retry: retry-five-times - then: - throw: - refName: service-not-available-error -states: - - name: my-state - type: operation - actions: - - name: my-action - functionRef: my-function - onErrors: - - refName: handle-503 -``` - - | -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "errors": { - "definitions": [ - { - "name": "service-not-available-error", - "type": "https://serverlessworkflow.io/spec/errors/communication", - "status": 503, - "title": "Service Not Available", - "detail": "Failed to contact service, even after multiple retries" - } - ], - "handlers": [ - { - "name": "handle-503", - "when": [ - { - "status": 503 - } - ], - "retry": "retry-five-times", - "then": { - "throw": { - "refName": "service-not-available-error" - } - } - } - ] - }, - "states": [ - { - "name": "my-state", - "type": "operation", - "actions": [ - { - "name": "my-action", - "functionRef": "my-function", - "onErrors": [ - { - "refName": "handle-503" - } - ] - } - ] - } - ] -} - -``` - - | -- -```yaml -errors: - definitions: - - name: service-not-available-error - type: https://serverlessworkflow.io/spec/errors/communication - status: 503 - title: Service Not Available - detail: Failed to contact service, even after multiple retries - handlers: - - name: handle-503 - when: - - status: 503 - retry: retry-five-times - then: - throw: - refName: service-not-available-error - policy: - - name: fault-tolerance - handlers: - - refName: handle-503 -states: - - name: my-state - type: operation - actions: - - name: my-action - functionRef: my-function - onErrors: fault-tolerance -``` - - | -
Click to view example definition
-- -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "duration": "PT2M", - "runBefore": "createandsendreport" -} -``` - - | -- -```yaml -duration: PT2M -runBefore: createandsendreport -``` - - | -
| JSON | -YAML | -
|---|---|
| - -```json - { - "states": [ - { - "name": "new-item-purchase", - "type": "event", - "onEvents": [ - { - "eventRefs": [ - "new-purchase" - ], - "actions": [ - { - "functionRef": { - "refName": "debit-customer-function", - "arguments": { - "customerid": "${ .purchase.customerid }", - "amount": "${ .purchase.amount }" - } - } - }, - { - "functionRef": { - "refName": "send-purchase-confirmation-email-function", - "arguments": { - "customerid": "${ .purchase.customerid }" - } - } - } - ] - } - ], - "compensatedBy": "cancel-purchase", - "transition": "some-next-workflow-state" - }, - { - "name": "cancel-purchase", - "type": "operation", - "usedForCompensation": true, - "actions": [ - { - "functionRef": { - "refName": "credit-customer-function", - "arguments": { - "customerid": "${ .purchase.customerid }", - "amount": "${ .purchase.amount }" - } - } - }, - { - "functionRef": { - "refName": "send-purchase-cancellation-email-function", - "arguments": { - "customerid": "${ .purchase.customerid }" - } - } - } - ] - } - ] - } -``` - - | -- -```yaml -states: -- name: new-item-purchase - type: event - onEvents: - - eventRefs: - - new-purchase - actions: - - functionRef: - refName: debit-customer-function - arguments: - customerid: "${ .purchase.customerid }" - amount: "${ .purchase.amount }" - - functionRef: - refName: send-purchase-confirmation-email-function - arguments: - customerid: "${ .purchase.customerid }" - compensatedBy: cancel-purchase - transition: some-next-workflow-state -- name: CancelPurchase - type: operation - usedForCompensation: true - actions: - - functionRef: - refName: credit-customer-function - arguments: - customerid: "${ .purchase.customerid }" - amount: "${ .purchase.amount }" - - functionRef: - refName: send-purchase-cancellation-email-function - arguments: - customerid: "${ .purchase.customerid }" -``` - - | -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "transition": { - "compensate": true, - "nextState": "next-workflow-state" - } -} -``` - - | -- -```yaml -transition: - compensate: true - nextState: next-workflow-state -``` - - | -
| JSON | -YAML | -
|---|---|
| - -```json -{ - "end": { - "compensate": true - } -} -``` - - | -- -```yaml -end: - compensate: true -``` - - | -
-
-
-
-
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies: