WorkflowEdgeV1

Fields

4 fields

from · required

string or array of string

join

string or null

to · required

string

when

object or null

Raw schema (JSON)

{
  "additionalProperties": false,
  "properties": {
    "from": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      ],
      "title": "From"
    },
    "join": {
      "anyOf": [
        {
          "enum": [
            "all",
            "any"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Join"
    },
    "to": {
      "maxLength": 80,
      "minLength": 1,
      "title": "To",
      "type": "string"
    },
    "when": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "When"
    }
  },
  "required": [
    "from",
    "to"
  ],
  "title": "WorkflowEdgeV1",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

• POST /api/v1/projects/{project_id}/workflows — Create Workflow
• PUT /api/v1/projects/{project_id}/workflows/{workflow_id} — Update Workflow

Used by schemas

• WorkflowBodyV1

More details

• Specification: OpenAPI JSON