W Api Docs

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

作者 blockmatic7e05e2abd052dc6b526e8a28e36d102d42bfd635无许可证1 个星标收录于 2026年10月9日更新于 2026年10月9日仓库6天前更新

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

AI 生成的概览

从所属 schema 源刷新 API 文档,而不是手动编辑生成的 OpenAPI。

功能
指导智能体通过定位所属 schema 或路由源以及文档化的生成脚本,来更新 API 文档。它要求修改 schema 或路由,而不是生成的产物,然后运行文档化的生成命令并检查漂移脚本。它还涵盖仅在行为发生变化时更新采用方 MDX,并避免臆造认证、速率限制或版本策略。
适用场景
当需要从真实来源刷新或重新生成 API 文档时使用。也适用于不得直接编辑生成的 OpenAPI、客户端或 SQL,而应改为修改所属 schema 或路由的情况。
运行要求
不附带脚本,仅为说明性指令。它假定可以访问仓库的 API 文档 MDX、生成器 README、package.json 和文档化的生成命令,以及仓库提供的任何漂移脚本。

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.

来源与署名

来源:blockmatic/basilic-skills位于skills/workflow/w-api-docs提交7e05e2a

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架