Validate a workflow document

POST/api/build/workflows/validate

Authorization

bearerAuth

AuthorizationBearer <token>

OAuth access token whose grant carries Build authorization.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A whole workflow as one JSON document.

kind*string

Document discriminator.

slug*string

URL slug. Cannot change after creation.

Match^[a-z0-9]+(-[a-z0-9]+)*$

Lengthlength <= 80

name*string

Display name.

Length1 <= length <= 80

description*|

What the workflow does.

enabled*boolean

Whether the workflow runs.

updated_at?string

Version stamp. Required on replace.

Match

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Formatdate-time

space*

Where the workflow lives.

send_as*|

Identity runs send as.

inputs*

Inputs with optional defaults.

schedule*|

Optional schedule.

steps*array<|>

One to ten steps.

Items1 <= items <= 10

output*|

Which step's output is the workflow's output.

Response Body

`application/json`

curl -X POST "https://example.com/api/build/workflows/validate" \  -H "Content-Type: application/json" \  -d '{    "kind": "spinrun.workflow/v1",    "slug": "string",    "name": "string",    "description": "string",    "enabled": true,    "space": {      "team": "string"    },    "send_as": "string",    "inputs": {      "property1": {},      "property2": {}    },    "schedule": {      "cron": "stringstr",      "timezone": "string"    },    "steps": [      {        "id": "string",        "kind": "tool",        "tool": "string"      }    ],    "output": "string"  }'

{  "data": {    "valid": true,    "changes": [      "string"    ],    "document": null  }}

Validate a workflow document

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

413application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`