Skip to main content
POST
Validate a workflow definition

Authorizations

api_key
string
header
required

Personal API key.

Path Parameters

app_id
string
required

ID of the app whose workflows you want to work with.

Body

application/json
definition
Definition · object
required

The CNCF Serverless Workflow v1.0 document to check.

Example:

Response

The verdict. Check valid, not the status code.

valid
boolean
required

Whether the definition can be saved as-is.

Example:

true

errors
Errors · object[]

What is wrong with the definition, one entry per problem. Empty when valid is true.

Example:
supported_task_types
string[]

Task types a definition may use.

Example:
available_activities
string[]

Activities this app can call from a task.

Example: