W Api Docs

blockmatic/basilic-skills/skills/workflow/w-api-docs

by blockmatic7e05e2abd052dc6b526e8a28e36d102d42bfd635No license1 starsListed Oct 9, 2026Updated Oct 9, 2026Repository updated 6 days ago

Refresh API docs from the owning schema source; never edit generated OpenAPI by hand.

Instructions onlySoftware Development
AI-generated overview

Refresh API documentation from its owning schema source instead of editing generated OpenAPI files by hand.

What it does
Guides an agent through updating API documentation by locating the owning schema or route source and the documented generate script. It directs changes to the schema or route rather than the generated artifact, then running the documented generate command and checking drift scripts. It also covers updating adopter MDX only for behavior that changed and avoiding invented auth, rate-limit, or versioning policy.
When to use it
Use when API documentation needs to be refreshed or regenerated from its source of truth. Also relevant when generated OpenAPI, clients, or SQL must not be edited directly and the owning schema or route should be changed instead.
Requirements
No scripts are shipped; it is instructions only. It assumes access to the repository's API docs MDX, generator README, package.json, and the documented generate command, plus any drift scripts the repository provides.

Update API documentation from the source of truth (TypeBox/Fastify routes, or the repo's documented generator). Never edit generated OpenAPI, generated clients, or generated SQL directly.

  1. Read the API docs MDX and the generator README. Identify the owning source and the generate script in package.json.
  2. Change the owning schema or route, not the generated artifact.
  3. Run the documented generate command. Check drift scripts if the repo has them.
  4. Update adopter MDX only for behavior that changed. Do not invent auth, rate-limit, or versioning policy.
  5. Docs: /w-docs if behavior or commands changed.

Source and attribution

Source:blockmatic/basilic-skillsinskills/workflow/w-api-docsat commit7e05e2a

License: No license

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal