What problem does it solve?
Changing a public API contract in Compozy touches many surfaces at once: Go DTOs, OpenAPI specs, generated TypeScript clients, web consumers, CLI docs, and site documentation. This Skill prevents drift and broken consumers by enforcing one atomic bundle that ships source, generated artifacts, and documentation together.
Core Features & Use Cases
- Trigger Detection: Identifies when edits to contract files, OpenAPI specs, generated clients, or handler request/response semantics require a co-ship bundle.
- Codegen Synchronization: Runs
make codegen and make codegen-check so openapi/compozy.json and web/src/generated/compozy-openapi.d.ts stay deterministic and committed alongside source.
- Consumer and Docs Updates: Guides updates to web systems (types, adapters, hooks, MSW fixtures, Storybook) and site docs (CLI, HTTP, configuration pages), including deleting pages for removed verbs.
- Use Case: When renaming a field in a public handler response, use this Skill to regenerate the OpenAPI spec and TypeScript types, update affected web hooks and fixtures, refresh the endpoint docs, and verify the full bundle with
make gate before opening the PR.
Quick Start
Ask the agent to apply the contract co-ship workflow for the handler response change you are about to make and verify the bundle with codegen-check and the gate.
