Runs

Validate Workflow Manifest

Validates runtime readiness for a workflow manifest without creating a run.

post/api/v1/preflight

Request body

versioninteger required

Manifest schema version.

parent_idstring nullable

Optional orchestration parent run ID. Fork and rewind lineage use separate fields and should not set this value.

titlestring nullable

Optional explicit run title. The server trims leading/trailing whitespace, rejects blank values, rejects control characters and newline characters, and requires at most 100 characters.

cwdstring required

CLI working directory at invocation time.

workflowsobject required

Example request

{
  "version": 1,
  "parent_id": "01HV6D7S5YF4Z4B2M7K4N0Q6T8",
  "title": "Add rate limiting to auth endpoints",
  "cwd": "/tmp/project",
  "git": {
    "origin_url": "https://github.com/acme/my-app.git",
    "branch": "feature/foo",
    "sha": "abc123def"
  },
  "target": {
    "path": ".fabro/workflows/smoke/workflow.fabro"
  }
}

Response

Preflight report

okboolean required

Whether preflight passed using the CLI-compatible success rule.

Changes

Changed in 9 of the 134 revisions of this API.2114

    • removed the request property git/push_outcome

      request-property-removed

    • removed the request property goal/path

      request-property-removed

    • removed the request property run_id

      request-property-removed

    • removed the request property target/identifier

      request-property-removed

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new required request property git/push_outcome

      new-required-request-property

    • added the new required request property target/identifier

      new-required-request-property

    • added the new optional request property goal/path

      new-optional-request-property

    • added the new optional request property run_id

      new-optional-request-property

    • removed the request property git/push_outcome

      request-property-removed

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the request property goal/path

      request-property-removed

    • removed the request property target/identifier

      request-property-removed

    • removed the request property run_id

      request-property-removed

    • removed the request property args/docker_image

      request-property-removed

    • added the new optional request property args/docker_image

      new-optional-request-property

    • removed the request property args/docker_image

      request-property-removed

  • 41937812f64011See the full diff
    • removed the request property args/sandbox

      request-property-removed

    • added the new optional request property args/environment

      new-optional-request-property

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog