nexus/docs
Aron Prins f87db64ba9 docs(api/routines): address three review findings
**#1 — Missing `description` field in fields table**
The create body example included `description` and the schema confirms
`description: z.string().optional().nullable()`, but the reference table
omitted it. Added as an optional field.

**#2 — Concurrency policy descriptions were inaccurate**
Original docs described both `coalesce_if_active` and `skip_if_active` as
variants of "skip", which was wrong. Source-verified against
`server/src/services/routines.ts` (dispatchRoutineRun, line 568):

  const status = concurrencyPolicy === "skip_if_active" ? "skipped" : "coalesced";

Both policies write identical DB state (same linkedIssueId and
coalescedIntoRunId); the only difference is the run status value.
Descriptions now reflect this: both finalise the incoming run immediately
and link it to the active run — no new issue is created in either case.

Note: the reviewer's suggestion that `coalesce_if_active` "extends or
notifies" the active run was also not supported by the code; corrected
accordingly.

**#3 — `triggerId` undocumented in Manual Run**
`runRoutineSchema` accepts `triggerId` and the service genuinely uses it
(routines.ts:1029–1034): fetches the trigger, enforces that it belongs to
the routine (403) and is enabled (409), then passes it to dispatchRoutineRun
which records the run against the trigger and updates its `lastFiredAt`.
Added `triggerId` to the example body and documented all three behaviours.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-23 10:21:34 +01:00
..
adapters fix: isolate codex home in worktrees 2026-03-13 11:53:56 -05:00
api docs(api/routines): address three review findings 2026-03-23 10:21:34 +01:00
cli fix: restore docs deleted in v0.2.3 release, add Paperclip branding 2026-03-03 15:49:43 -06:00
companies Update skill package docs and plans 2026-03-14 10:13:20 -05:00
deploy docs: add tailscale private access guide 2026-03-05 14:21:47 -06:00
guides Merge pull request #141 from aaaaron/integrate-opencode-pr62 2026-03-06 11:32:03 -06:00
images fix: restore docs deleted in v0.2.3 release, add Paperclip branding 2026-03-03 15:49:43 -06:00
plans feat(issues): add issue documents and inline editing 2026-03-13 21:30:48 -05:00
specs Add company import export v2 plan 2026-03-13 21:10:45 -05:00
start docs: clarify quickstart npx usage 2026-03-20 08:50:00 -05:00
agents-runtime.md fix: restore docs deleted in v0.2.3 release, add Paperclip branding 2026-03-03 15:49:43 -06:00
docs.json docs: add tailscale private access guide 2026-03-05 14:21:47 -06:00
favicon.svg fix: restore docs deleted in v0.2.3 release, add Paperclip branding 2026-03-03 15:49:43 -06:00