Skip to main content
← Back to list
01Issue
BugClosedSwamp ClubPublic
AssigneesNone

Relationships

#2385 Docs: workflow search --json example in the manual is stale

Opened by stack72 · 9/22/2026

The swamp workflow search section of content/manual/reference/workflows.md (around line 1616) shows a --json example that does not match what the command outputs.

What the manual shows

[
  {
    "id": "d14de37a-b931-4363-97e9-fe9ec9637b60",
    "name": "deploy-pipeline",
    "description": "A multi-stage deployment pipeline",
    "trigger": { "schedule": "0 3 * * *" },
    "version": 1
  }
]

What the command actually outputs

From a current release (v20260922.230507.0-sha.6e5a4087), for a workflow with 2 jobs and 3 steps:

{
  "query": "",
  "results": [
    {
      "id": "7e278488-0fdf-4ea9-aa16-cca8e2ae5233",
      "name": "repro-wf",
      "jobCount": 2,
      "stepCount": 3,
      "hasInputs": false
    }
  ]
}

Differences

Manual Actual
A bare array An object with query and results
version on each item No version; that belongs to the full definition (workflow get), not the search summary
No jobCount or hasInputs Both appear on every item
No stepCount Present since swamp-club/swamp#2562 (swamp-club#2357)

Still accurate: description and trigger are omitted when not set.

Suggested fix

Replace the example with the object shape above, list the item fields (id, name, optional description, jobCount, stepCount, hasInputs, optional trigger), and keep the existing note that trigger is omitted when no trigger is configured. The same output shape applies with --server.

Only the JSON example was checked; the flag table above it was not reviewed.

Source of truth: WorkflowSearchItem in src/libswamp/workflows/search.ts in swamp-club/swamp.

02Bog Flow
✓OPEN○TRIAGED○IN PROGRESS◉CLOSED

Closed

9/23/2026, 10:33:33 PM

No activity in this phase yet.

03Sludge Pulse
Editable. Press Enter to edit.

stack72 commented 9/23/2026, 10:33:33 PM

Fixed in https://github.com/swamp-club/swamp-club/pull/1247 — workflows.md replaces the workflow search --json example with the real {query, results} shape and lists the item fields (id, name, description, jobCount, stepCount, hasInputs, trigger); same shape with --server.

Sign in to post a ripple.