菜单
Catalogs user-readable OpenAPI text in ref-numbered tables with possible issues and proposed content. Read-only unless user asks to update specific refs. Use when the user invokes /api-review or asks to review API descriptions.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Audits an OpenAPI JSON spec (Redocly lint, OpenAPI version, FFS style guide, copy rules). Read-only — no file edits. Use when the user invokes /api-eval or asks to evaluate or audit an API spec.
Fixes Redocly lint errors and api-ref-structure.mdc inconsistencies on an OpenAPI JSON spec. Use when the user invokes /api-fix or asks to fix API lint or structure issues. Does not apply FFS style guide or copy fixes.
Stages all working-tree changes with git add -A, then commits with a message that follows the repository user’s Git commit rules (short imperative subject, blank line, body bullets with 📖/✏️). Use when the user invokes /gc or the gc skill, asks to “gc”, or asks to stage everything and commit with the project commit-message format.
Stages all changes with git add -A, drafts a commit message per the user’s Git commit rules, prints it for review, then waits for the user to edit the message and choose (1) commit or (2) reject. Use when the user invokes /gcam or the gcam skill, asks for stage-all with review before commit, or interactive commit with approve/reject.
| name | api-review |
| description | Catalogs user-readable OpenAPI text in ref-numbered tables with possible issues and proposed content. Read-only unless user asks to update specific refs. Use when the user invokes /api-review or asks to review API descriptions. |
/api-review — Description catalog/api-review, "review API descriptions", or "catalog schema descriptions".update refs N,M,… (that is not /api-fix).Resolve target spec — _shared/resolve-api-spec.md. Print **Target spec:** \path``.
Collect text — Walk the spec in document order. Assign Ref 1, 2, 3, … to every user-readable description and title (where Redocly shows it).
Evaluate copy — Load api-ref-copy.mdc. Fill Possible issues and Proposed content (when issues exist).
Emit sectioned tables — One table per section below. Location is always the last column.
| Ref | Text (excerpt) | Possible issues | Proposed content | Location |
|---|
….Missing period, Internal ID, Title Case on non-response; — if none.— if OK or no safe proposal.`components/schemas/Foo.description` · L201).Info and tags
Operations (summary, description)
Parameters and request bodies
Responses and headers
Schemas (primary focus)
Examples (prose in example strings only)
Footer
/api-fix. Copy → Proposed content or update refs 3, 7, 12 (not /api-fix).update refs 3, 7, 12 — Apply Proposed content at Location paths; preserve meaning. Not /api-fix.