suaveplan/openspec/archive/2026-05-26-api-openapi/tasks.md

Tasks — @suaveplan/api-openapi

Every checkbox MUST reflect work actually done in this change.

0. Pre-flight (non-negotiable)

• 0.1 Confirm clean working tree (git status reports nothing) and no in-flight worktrees with uncommitted work (git worktree list then git status in each)
• 0.2 If any worktrees exist under .claude/worktrees/, account for each one: still-active agent, work-pending-merge, or stale-and-prune. Stale worktrees MUST be removed (git worktree remove) before opening a new one — code that has been lost twice on main is the failure mode this guards against.
• 0.3 Confirm the package set in MANIFEST.md matches find packages -maxdepth 3 -name package.json count. Drift here means a prior change archived without regenerating the manifest.

1. Spec authoring

• 1.1 Read design doc (§7)
• 1.2 Read openspec/AGENTS.md Sections 13 and 14
• 1.3 Draft proposal.md
• 1.4 Draft specs/api-openapi/spec.md
• 1.5 Every requirement carries **Verified by:**

2. Implementation

• 2.1 Scaffold packages/api/api-openapi/
• 2.2 src/emitter/ — createOpenapiEmitter, OpenapiEmitter
• 2.3 src/zod-conversion/ — wrapper over @asteasolutions/zod-to-openapi
• 2.4 src/namespacing/ — operationId / tag / component-prefix rules
• 2.5 src/endpoints/ — /openapi.json, /openapi.yaml, /docs, /docs/{plugin} handlers
• 2.6 src/strictness/ — host.openapi.strictness dev/prod resolution
• 2.7 src/error-codes.ts
• 2.8 src/index.ts — explicit named re-exports

3. Tests

• 3.1 src/emitter/emitter.test.ts
• 3.2 src/emitter/emitter.spec-conformance.test.ts
• 3.3 src/endpoints/endpoints.test.ts
• 3.4 src/namespacing/namespacing.test.ts
• 3.5 tests/dep-graph.test.ts
• 3.6 Every it(...) carries { timeout: 5000 }

4. Documentation

• 4.1 Sibling .md per implementation .ts
• 4.2 README.md ## Modules
• 4.3 Update CLAUDE.md package listing

5. Pre-archive verification (the 5-gate triple)

• 5.1 bun run check
• 5.2 bunx turbo lint typecheck test --filter=@suaveplan/api-openapi
• 5.3 bunx turbo test:coverage --filter=@suaveplan/api-openapi — 100/100/100/100
• 5.4 bun scripts/openspec-conformance.ts @suaveplan/api-openapi
• 5.5 bunx turbo build --filter=@suaveplan/api-openapi

6. Pre-archive 7-row checklist

• 6.1 Generics threaded for typed schema rendering
• 6.2 Zod schemas wired at every route ingestion boundary
• 6.3 Every OPENAPI_* code thrown by a production path
• 6.4 Strict-mode behaviours: warn vs refuse-install both tested
• 6.5 OTel instruments (emission counter, conversion-error counter) asserted with MeterProvider
• 6.6 Lifecycle dedup — repeated getJson() on unchanged input returns the same document
• 6.7 No retroactive tick

7. Archive

• 7.1 Fold spec delta into openspec/specs/api-openapi/spec.md
• 7.2 Move folder to archive
• 7.3 Tick 8.6 in umbrella tasks
• 7.4 Refresh MANIFEST.md