update-api-reference — команда для Claude Code
Команда update-api-reference для Claude Code сравнивает новую схему API с предыдущей и готовит обновления справки, руководств и журнала изменений при смене эндпоинтов или параметров.
Apache-2.0 ★ 450 обновлён 2026-04-03
.claude/commands/update-api-reference.mdЧто делает update-api-reference
Передайте путь или URL файла OpenAPI/AsyncAPI, аудиторию, нужные типы материалов и языки примеров. Команда сравнит схему с предыдущей версией, отметит новые, изменённые и устаревшие эндпоинты, а затем подготовит описания, параметры, ответы и примеры кода. Можно запросить справочник, руководство, учебный материал или запись в журнал изменений.
В результате появятся обновлённая API-справка в Markdown или HTML, набор примеров для выбранных языков и выдержка из журнала изменений. Для миграционных рекомендаций предусмотрен параметр breaking-change. Черновики проходят проверку инженерной или продуктовой команды, а затем редакционную проверку; публикация и обновление версий тоже входят в описанный процесс. Для работы нужна схема OpenAPI или AsyncAPI и предыдущая версия для сравнения.
Какие задачи решает
- сравнить новую схему API с предыдущей версией
- обновить описания эндпоинтов и параметров
- подготовить примеры кода на выбранных языках
- добавить изменения в журнал и составить рекомендации по миграции
Примеры запросов агенту
- Обнови справочник API по схеме
openapi.yamlдля разработчиков и добавь руководство с примерами наjsиpython. - Сравни новую схему с предыдущей версией и подготовь журнал изменений и рекомендации по миграции с
--breaking-change true. - Подготовь справку API и учебный материал для партнёров по схеме
openapi.yaml. Запусти/technical-writing:update-api-reference.
Как установить update-api-reference
Вручную: положить файлы
.claude/commands/update-api-reference.mdВызов — /update-api-reference. Для всех проектов — ~/.claude/commands/
Вручную: положить файлы
~/.codex/prompts/update-api-reference.mdВызов — /prompts:update-api-reference. В Codex этот формат помечен устаревшим, замена — скиллы
Вручную: положить файлы
.github/prompts/update-api-reference.prompt.mdВручную: положить файлы
.gemini/commands/update-api-reference.tomlGemini хранит команды в TOML: текст запроса — в поле prompt
Вопросы об update-api-reference
Как установить update-api-reference в Claude Code?
Добавьте файл команды по пути .claude/commands/update-api-reference.md.
Что делает update-api-reference?
Команда сравнивает схему OpenAPI или AsyncAPI с предыдущей версией и готовит обновления справки, руководств, примеров кода и журнала изменений.
Как получить рекомендации по миграции?
Укажите --breaking-change true. Команда подготовит рекомендации, если они применимы к изменениям схемы.
Исходный текст
update-api-reference.md · Apache-2.0
--- name: update-api-reference description: Generates API reference + guides updates from new schema changes with samples and changelog entries. usage: /technical-writing:update-api-reference --spec openapi.yaml --audience developers --outputs reference,guide --languages js,python --- # Command: update-api-reference ## Inputs - **spec** – OpenAPI/AsyncAPI file path or URL. - **audience** – developers | partners | internal | admins. - **outputs** – reference, guide, changelog, tutorial (comma-separated). - **languages** – code sample languages (js, python, curl, java, go, ruby, csharp). - **breaking-change** – true/false toggle for migration guidance. ## Workflow 1. **Spec Diff & Analysis** – compare schema version vs prior baseline, note new/changed/deprecated endpoints. 2. **Content Scope** – determine docs to update (reference tables, tutorials, SDK snippets, changelog entries). 3. **Drafting** – produce updated endpoint descriptions, parameters, responses, usage notes, and code samples per language. 4. **Review Loop** – route drafts to engineering/product for validation and to editorial for style compliance. 5. **Publishing & Versioning** – push updates, tag version support, update changelog + migration guidance. ## Outputs - Updated API reference markdown/HTML with highlighted changes. - Code sample bundle per requested languages. - Changelog excerpt + migration guidance (if applicable). ## Agent/Skill Invocations - `api-docs-editor` – leads spec diff + doc updates. - `documentation-architect` – ensures IA + governance alignment. - `api-style-guide` skill – enforces terminology, formatting, and code sample rules. - `versioning-dashboard` skill – logs version info + deprecation timelines. ---
© gtmagents · Apache-2.0 · gtmagents/gtm-agents