← ClaudeAtlas

openapi-auditlisted

Audit and repair a project's whole OpenAPI/Swagger spec — inventory every API route, find endpoints that are undocumented or documented partially, and fill the gaps from real code. Use for pre-existing spec debt (a project whose Swagger is empty or stale), not for the endpoints of the task you are currently implementing.
YasMax91/groundwork · ★ 0 · API & Backend · score 69
Install: claude install-skill YasMax91/groundwork
# OpenAPI audit Brings a project's published spec back to the standard in `${CLAUDE_SKILL_DIR}/../../guidelines/openapi-protocol.md`: every endpoint documented, every operation complete to the last detail, generation clean. Scope note: the endpoints **you are changing right now** are covered by `implement-approved` + the `openapi` Stop gate. This skill is for the **backlog** — spec debt that predates the task. ## 1. Inventory both sides - **Routes** — `./vendor/bin/sail artisan route:list --json`. Keep the API surface (the `api` middleware group / the project's API prefix); drop internal, telescope/horizon, and framework routes. - **Documented operations** — regenerate first (`./vendor/bin/sail artisan l5-swagger:generate`), then read the produced document (usually `storage/api-docs/api-docs.json`). If generation fails, fix that before auditing — a failing build means the published spec is already stale. ## 2. Classify every route For each API route, compare the documented operation against the protocol checklist: | Verdict | Meaning | | --- | --- | | `missing` | No operation for this path+method — it ships undocumented. | | `incomplete` | Operation exists but a required part is absent (see the checklist below). | | `stale` | Documented shape contradicts the current FormRequest / Resource / enum / status codes. | | `ok` | Matches the protocol. | `incomplete`/`stale` must name **which** parts fail: summary/description · tags · security · parameters (typed, requ