Validate Pipeline Template

POST

/v1/pipelines/templates:validate

curl --request POST \
  --url https://junction-api.qualiastudios.dev/v1/pipelines/templates:validate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "source": "example" }'

Everything apply checks, writing nothing: the file’s shape, every pin, the resolved graph’s ports as a run would see them, and its outputs.

Authorizations

• ApiKey
• Bearer

Request Body ^required

Media type application/json

TemplateSource

A template file, as it is kept in the workspace’s repository.

object

source

required

The TOML file: name, description, nodes, edges, outputs

string

<= 65536 characters

Example ^generated

{
  "source": "example"
}

Responses

200

Successful Response

Media type application/json

TemplateValidation

object

valid

required

boolean

errors

Array<string>

name

string | null

launch_fields

Array<object>

LaunchField

One launch-form field of a template: an exposed port with its JSON schema, derived required-ness, and display metadata.

object

name

required

string

type_name

required

string

schema

object

key

additional properties

any

required

required

boolean

default

nullable

resolve

object

key

additional properties

any

ui

object

key

additional properties

any

Example ^generated

{
  "valid": true,
  "errors": [
    "example"
  ],
  "name": "example",
  "launch_fields": [
    {
      "name": "example",
      "type_name": "example",
      "schema": {},
      "required": true,
      "default": "example",
      "resolve": {},
      "ui": {}
    }
  ]
}

401

Invalid or missing API key

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

403

Missing capability on the workspace

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Array<object>

ValidationError

object

loc

required

Location

Array<string | integer>

msg

required

Message

string

type

required

Error Type

string

input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}