playbooks

run

Create a PlaybookRun for a test deployment. The CLI drives case execution and updates the run via playbooks.updateRun.

POST

Usage:

const result = await swirls.client.playbooks.run({
  projectId: '...',
  deploymentId: '...',
  playbookName: '...',
})

Input:

Output:

getRun

Get a PlaybookRun by id

GET

Usage:

const result = await swirls.client.playbooks.getRun({
  id: '...',
})

Input:

Output:

listRuns

List PlaybookRuns for a project, newest first

GET

Usage:

const result = await swirls.client.playbooks.listRuns({
  projectId: '...',
})

Input:

Output:

updateRun

Update PlaybookRun verdict, summary, cases, and completion metadata (used by the test runner)

POST

Usage:

const result = await swirls.client.playbooks.updateRun({
  id: '...',
})

Input:

Output: