Runs

Render Workflow Graph

Validates and renders a workflow manifest as SVG without creating a run. The manifest is checked as POST /validate checks it; a workflow Petri refuses is not rendered.

post/api/v1/graph/render

Request body

format'svg'
direction'lr' | 'tb'

Example request

{
  "manifest": {
    "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

Rendered graph image

Changes

Changed in 10 of the 172 revisions of this API.2115

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

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

    • ●

      removed the request property //

      request-property-removed

    • ●

      removed the request property //

      request-property-removed

    • ●

      removed the request property /

      request-property-removed

    • ●

      removed the request property //

      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 //

      new-required-request-property

    • ▲

      added the new required request property //

      new-required-request-property

    • ○

      added the new optional request property //

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ●

      removed the request property //

      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 //

      request-property-removed

    • ●

      removed the request property //

      request-property-removed

    • ●

      removed the request property /

      request-property-removed

    • ●

      removed the request property //

      request-property-removed

    • ○

      added the new optional request property //

      new-optional-request-property

    • ●

      removed the request property //

      request-property-removed

  • 41937812f64011See the full diff
    • ●

      removed the request property //

      request-property-removed

    • ○

      added the new optional request property //

      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