schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
workflow.json | key | Domain-specific workflow identifier | {"type": "string", "minLength": 1} |
workflow.json | name | Workflow name | {"type": "string", "minLength": 1} |
workflow.json | description | Workflow description | {"type": "string"} |
workflow.json | version | Workflow version | {"type": "string", "minLength": 1, "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"} |
workflow.json | annotations | List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities | {"type": "array", "minItems": 1, "items": {"type": "string"}, "additionalItems": false} |
workflow.json | constants | URI to a resource containing constants data (json or yaml) | {"type": "string", "format": "uri"} |
workflow.json | constants | Workflow constants data (object type) | {"type": "object"} |
workflow.json | specVersion | Serverless Workflow schema version | {"type": "string", "minLength": 1} |
workflow.json | expressionLang | Identifies the expression language used for workflow expressions. Default is 'jq' | {"type": "string", "default": "jq", "minLength": 1} |
workflow.json | keepActive | If 'true', workflow instances is not terminated when there are no active execution paths. Instance can be terminated via 'terminate end definition' or reaching defined 'workflowExecTimeout' | {"type": "boolean", "default": false} |
workflow.json | autoRetries | If set to true, actions should automatically be retried on unchecked errors. Default is false | {"type": "boolean", "default": false} |
workflow.json | states | State definitions | {"type": "array", "items": {"anyOf": [{}, {}, {}, {}, {}, {}, {}, {}]}, "additionalItems": false, "minItems": 1} |
workflow.json | before | Amount of time (ISO 8601 duration format) to sleep before function/subflow invocation. Does not apply if 'eventRef' is defined. | {"type": "string"} |
workflow.json | after | Amount of time (ISO 8601 duration format) to sleep after function/subflow invocation. Does not apply if 'eventRef' is defined. | {"type": "string"} |
workflow.json | crondef | Cron expression defining when workflow instances should be created (automatically) | {"type": "string", "minLength": 1} |
workflow.json | expression | Repeating interval (cron expression) describing when the workflow instance should be created | {"type": "string", "minLength": 1} |
workflow.json | validUntil | Specific date and time (ISO 8601 format) when the cron expression invocation is no longer valid | {"type": "string"} |
workflow.json | continueasdef | Unique id of the workflow to be continue execution as. Entire state data is passed as data input to next execution | {"type": "string", "minLength": 1} |
workflow.json | workflowId | Unique id of the workflow to continue execution as | {"type": "string"} |
workflow.json | version | Version of the workflow to continue execution as | {"type": "string", "minLength": 1, "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"} |
workflow.json | data | If string type, an expression which selects parts of the states data output to become the workflow data input of continued execution. If object type, a custom object to become the workflow data input of the continued execution | {"type": ["string", "object"]} |
workflow.json | workflowExecTimeout | Workflow execution timeout to be used by the workflow continuing execution. Overwrites any specific settings set by that workflow | {} |
workflow.json | transition | Name of state to transition to | {"type": "string", "minLength": 1} |
workflow.json | transition | Function Reference | {"type": "object", "properties": {"nextState": {"type": "string", "minLength": 1}, "produceEvents": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "compensate": {"type": "boolean", "default": false}}, "additionalProperties": false, "required": ["nextState"]} |
workflow.json | nextState | Name of state to transition to | {"type": "string", "minLength": 1} |
workflow.json | produceEvents | Array of events to be produced before the transition happens | {"type": "array", "items": {"type": "object"}, "additionalItems": false} |
workflow.json | compensate | If set to true, triggers workflow compensation when before this transition is taken. Default is false | {"type": "boolean", "default": false} |
workflow.json | errorRef | Reference to a unique workflow error definition. Used of errorRefs is not used | {"type": "string", "minLength": 1} |
workflow.json | errorRefs | References one or more workflow error definitions. Used if errorRef is not used | {"type": "array", "minItems": 1, "items": {"type": "string"}, "additionalItems": false} |
workflow.json | transition | Transition to next state to handle the error. | {} |
workflow.json | end | End workflow execution in case of this error. | {} |
workflow.json | eventRefs | References one or more unique event names in the defined workflow events | {"type": "array", "minItems": 1, "items": {"type": "string"}, "uniqueItems": true, "additionalItems": false} |
workflow.json | actionMode | Specifies how actions are to be performed (in sequence or in parallel) | {"type": "string", "enum": ["sequential", "parallel"], "default": "sequential"} |
workflow.json | actions | Actions to be performed if expression matches | {"type": "array", "items": {"type": "object"}, "additionalItems": false} |
workflow.json | eventDataFilter | Event data filter | {} |
workflow.json | name | Unique action definition name | {"type": "string"} |
workflow.json | functionRef | References a function to be invoked | {} |
workflow.json | eventRef | References a `produce` and `consume` reusable event definitions | {} |
workflow.json | subFlowRef | References a sub-workflow to invoke | {} |
workflow.json | sleep | Defines time periods workflow execution should sleep before / after function execution | {} |
workflow.json | retryRef | References a defined workflow retry definition. If not defined the default retry policy is assumed | {"type": "string"} |
workflow.json | nonRetryableErrors | List of unique references to defined workflow errors for which the action should not be retried. Used only when `autoRetries` is set to `true` | {"type": "array", "minItems": 1, "items": {"type": "string"}, "additionalItems": false} |
workflow.json | retryableErrors | List of unique references to defined workflow errors for which the action should be retried. Used only when `autoRetries` is set to `false` | {"type": "array", "minItems": 1, "items": {"type": "string"}, "additionalItems": false} |
workflow.json | actionDataFilter | Action data filter | {} |
workflow.json | condition | Expression, if defined, must evaluate to true for this action to be performed. If false, action is disregarded | {"type": "string", "minLength": 1} |
workflow.json | functionref | Name of the referenced function | {"type": "string", "minLength": 1} |
workflow.json | functionref | Function Reference | {"type": "object", "properties": {"refName": {"type": "string"}, "arguments": {"type": "object"}, "selectionSet": {"type": "string"}, "invoke": {"type": "string", "enum": ["sync", "async"], "default": "sync"}}, "additionalProperties": false, "required": ["refName"]} |
workflow.json | refName | Name of the referenced function | {"type": "string"} |
workflow.json | arguments | Function arguments/inputs | {"type": "object"} |
workflow.json | selectionSet | Only used if function type is 'graphql'. A string containing a valid GraphQL selection set | {"type": "string"} |
workflow.json | invoke | Specifies if the function should be invoked sync or async | {"type": "string", "enum": ["sync", "async"], "default": "sync"} |
workflow.json | eventref | Event References | {"type": "object", "properties": {"produceEventRef": {"type": "string"}, "consumeEventRef": {"type": "string"}, "consumeEventTimeout": {"type": "string"}, "data": {"type": ["string", "object"]}, "contextAttributes": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false, "required": ["produceEventRef"]} |
workflow.json | produceEventRef | Reference to the unique name of a 'produced' event definition | {"type": "string"} |
workflow.json | consumeEventRef | Reference to the unique name of a 'consumed' event definition | {"type": "string"} |
workflow.json | consumeEventTimeout | Maximum amount of time (ISO 8601 format) to wait for the result event. If not defined it should default to the actionExecutionTimeout | {"type": "string"} |
workflow.json | data | If string type, an expression which selects parts of the states data output to become the data (payload) of the event referenced by 'produceEventRef'. If object type, a custom object to become the data (payload) of the event referenced by 'produceEventRef'. | {"type": ["string", "object"]} |
workflow.json | contextAttributes | Add additional extension context attributes to the produced event | {"type": "object", "additionalProperties": {"type": "string"}} |
workflow.json | subflowref | Unique id of the sub-workflow to be invoked | {"type": "string", "minLength": 1} |
workflow.json | subflowref | Specifies a sub-workflow to be invoked | {"type": "object", "properties": {"workflowId": {"type": "string"}, "version": {"type": "string", "minLength": 1, "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"}, "onParentComplete": {"type": "string", "enum": ["continue", "terminate"], "default": "terminate"}, "invoke": {"type": "string", "enum": ["sync", "async"], "default": "sync"}}, "required": ["workflowId"]} |
workflow.json | workflowId | Unique id of the sub-workflow to be invoked | {"type": "string"} |
workflow.json | version | Version of the sub-workflow to be invoked | {"type": "string", "minLength": 1, "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"} |
workflow.json | onParentComplete | If invoke is 'async', specifies how subflow execution should behave when parent workflow completes. Default is 'terminate' | {"type": "string", "enum": ["continue", "terminate"], "default": "terminate"} |
workflow.json | invoke | Specifies if the subflow should be invoked sync or async | {"type": "string", "enum": ["sync", "async"], "default": "sync"} |
workflow.json | branch | Branch Definition | {"type": "object", "properties": {"name": {"type": "string"}, "timeouts": {"type": "object", "properties": {"actionExecTimeout": {}, "branchExecTimeout": {}}, "required": []}, "actions": {"type": "array", "items": {"type": "object"}, "additionalItems": false}}, "additionalProperties": false, "required": ["name", "actions"]} |
workflow.json | name | Branch name | {"type": "string"} |
workflow.json | timeouts | State specific timeouts | {"type": "object", "properties": {"actionExecTimeout": {}, "branchExecTimeout": {}}, "required": []} |
workflow.json | actions | Actions to be executed in this branch | {"type": "array", "items": {"type": "object"}, "additionalItems": false} |
workflow.json | sleepstate | Causes the workflow execution to sleep for a specified duration | {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "sleep"}, "end": {}, "duration": {"type": "string"}, "transition": {}, "metadata": {}}, "additionalProperties": false, "oneOf": [{"required": ["name", "type", "duration", "end"]}, {"required": ["name", "type", "duration", "transition"]}]} |
workflow.json | name | State name | {"type": "string"} |
workflow.json | type | State type | {"type": "string", "const": "sleep"} |
workflow.json | end | State end definition | {} |
workflow.json | duration | Duration (ISO 8601 duration format) to sleep | {"type": "string"} |
workflow.json | transition | Next transition of the workflow after the workflow sleep | {} |
workflow.json | eventstate | This state is used to wait for events from event sources, then consumes them and invoke one or more actions to run in sequence or parallel | {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "event"}, "exclusive": {"type": "boolean", "default": true}, "onEvents": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "timeouts": {"type": "object", "properties": {"stateExecTimeout": {}, "actionExecTimeout": {}, "eventTimeout": {}}, "required": []}, "stateDataFilter": {}, "onErrors": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "transition": {}, "end": {}, "compensatedBy": {"type": "string", "minLength": 1}, "metadata": {}}, "additionalProperties": false, "oneOf": [{"required": ["name", "type", "onEvents", "end"]}, {"required": ["name", "type", "onEvents", "transition"]}]} |
workflow.json | name | State name | {"type": "string"} |
workflow.json | type | State type | {"type": "string", "const": "event"} |
workflow.json | exclusive | If true consuming one of the defined events causes its associated actions to be performed. If false all of the defined events must be consumed in order for actions to be performed | {"type": "boolean", "default": true} |
workflow.json | onEvents | Define the events to be consumed and optional actions to be performed | {"type": "array", "items": {"type": "object"}, "additionalItems": false} |
workflow.json | timeouts | State specific timeouts | {"type": "object", "properties": {"stateExecTimeout": {}, "actionExecTimeout": {}, "eventTimeout": {}}, "required": []} |
workflow.json | stateDataFilter | State data filter | {} |
workflow.json | onErrors | States error handling definitions | {"type": "array", "items": {"type": "object"}, "additionalItems": false} |
workflow.json | transition | Next transition of the workflow after all the actions have been performed | {} |
workflow.json | end | State end definition | {} |
workflow.json | compensatedBy | Unique Name of a workflow state which is responsible for compensation of this state | {"type": "string", "minLength": 1} |
workflow.json | operationstate | Defines actions be performed. Does not wait for incoming events | {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "operation"}, "end": {}, "stateDataFilter": {}, "actionMode": {"type": "string", "enum": ["sequential", "parallel"], "default": "sequential"}, "actions": {"type": "array", "items": {"type": "object"}}, "timeouts": {"type": "object", "properties": {"stateExecTimeout": {}, "actionExecTimeout": {}}, "required": []}, "onErrors": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "transition": {}, "compensatedBy": {"type": "string", "minLength": 1}, "usedForCompensation": {"type": "boolean", "default": false}, "metadata": {}}, "additionalProperties": false, "if": {"properties": {"usedForCompensation": {"const": true}}, "required": ["usedForCompensation"]}, "then": {"required": ["name", "type", "actions"]}, "else": {"oneOf": [{"required": ["name", "type", "actions", "end"]}, {"required": ["name", "type", "actions", "transition"]}]}} |
workflow.json | name | State name | {"type": "string"} |
workflow.json | type | State type | {"type": "string", "const": "operation"} |
workflow.json | end | State end definition | {} |
workflow.json | stateDataFilter | State data filter | {} |
workflow.json | actionMode | Specifies whether actions are performed in sequence or in parallel | {"type": "string", "enum": ["sequential", "parallel"], "default": "sequential"} |
workflow.json | actions | Actions to be performed | {"type": "array", "items": {"type": "object"}} |
workflow.json | timeouts | State specific timeouts | {"type": "object", "properties": {"stateExecTimeout": {}, "actionExecTimeout": {}}, "required": []} |
workflow.json | onErrors | States error handling definitions | {"type": "array", "items": {"type": "object"}, "additionalItems": false} |
workflow.json | transition | Next transition of the workflow after all the actions have been performed | {} |
workflow.json | compensatedBy | Unique Name of a workflow state which is responsible for compensation of this state | {"type": "string", "minLength": 1} |
workflow.json | usedForCompensation | If true, this state is used to compensate another state. Default is false | {"type": "boolean", "default": false} |
workflow.json | parallelstate | Consists of a number of states that are executed in parallel | {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "parallel"}, "end": {}, "stateDataFilter": {}, "timeouts": {"type": "object", "properties": {"stateExecTimeout": {}, "branchExecTimeout": {}}, "required": []}, "branches": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "completionType": {"type": "string", "enum": ["allOf", "atLeast"], "default": "allOf"}, "numCompleted": {"type": ["number", "string"], "minimum": 0, "minLength": 0}, "onErrors": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "transition": {}, "compensatedBy": {"type": "string", "minLength": 1}, "usedForCompensation": {"type": "boolean", "default": false}, "metadata": {}}, "additionalProperties": false, "if": {"properties": {"usedForCompensation": {"const": true}}, "required": ["usedForCompensation"]}, "then": {"required": ["name", "type", "branches"]}, "else": {"oneOf": [{"required": ["name", "type", "branches", "end"]}, {"required": ["name", "type", "branches", "transition"]}]}} |
workflow.json | name | State name | {"type": "string"} |
workflow.json | type | State type | {"type": "string", "const": "parallel"} |
workflow.json | end | State end definition | {} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.