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 從公開儲存庫中收錄這些內容。

檢舉或申請下架