К основному содержанию
команда CX Codex

update-api-reference — команда для Claude Code

Команда update-api-reference для Claude Code сравнивает новую схему API с предыдущей и готовит обновления справки, руководств и журнала изменений при смене эндпоинтов или параметров.

Apache-2.0 ★ 450 обновлён 2026-04-03

Установить в Claude Code · Вручную: положить файлы Все способы и платформы ↓
.claude/commands/update-api-reference.md
Открыть на GitHub

Что делает 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/

Вопросы об 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

Похожие слэш-команды

Все слэш-команды по теме «Бэкенд и API» →
api-reference-documentation aj-geddes Скилл api-reference-documentation помогает агенту собрать справочник по API: эндпоинты, аутентификация, примеры запросов и ответов, спецификация OpenAPI. CX Codex +1 501установок api-reference-quality Samuel Berthe Скилл api-reference-quality сверяет документацию API со спецификацией на уровне эндпоинтов и настраивает автоматические CI-проверки против расхождения документации с кодом. CX Codex +1 10 500установок api-reference rohitg00 Плагин api-reference для Claude Code создаёт документацию API по исходному коду, чтобы подготовить или обновить справочник проекта. ★ 2 858звёзд репо doc-api davila7 Команда doc-api для Claude Code генерирует документацию API по кодовой базе проекта. Она находит маршруты, контроллеры и схемы данных, формируя спецификации OpenAPI или интерактивный Swagger UI. CX Codex +1 733установок w-api-docs blockmatic-icebox Скилл w-api-docs для Claude Code обновляет API-документацию из исходной схемы или маршрутов. Он подключается к задаче, когда нужно изменить API и пересобрать его документацию. CX Codex +1 647установок api-documentation bobmatnyc Скилл api-documentation для Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode с правилами документирования API и кодовых интерфейсов. Агент получает единый набор практик вместо повторяющихся инструкций в каждом промпте. CX Codex +1 397установок

Из того же набора224

Весь набор →
seo-writing Скилл seo-writing помогает планировать и писать статьи под поисковые запросы с учётом продуктового позиционирования. Пригодится при подготовке ТЗ авторам и аудите блогов. CX Codex +1 ★ 450звёзд репо social-selling Скилл social-selling для Claude Code помогает вовлекать потенциальных клиентов через LinkedIn и сообщества, чтобы начинать тёплые разговоры и назначать встречи. Он подключается к задачам по социальным касаниям и развитию контакта. CX Codex +1 ★ 450звёзд репо analyze-call Команда analyze-call разбирает запись или транскрипт звонка на метрики, ключевые моменты, риски и рекомендации для команды продаж. CX Codex +1 ★ 450звёзд репо build-battlecard-suite Команда build-battlecard-suite генерирует баттлкарты, разборы возражений и скрипты разговоров по конкурентам под разные отделы и форматы. Структурирует конкурентную разведку. CX Codex +1 ★ 450звёзд репо run-win-loss-program Команда run-win-loss-program ведёт win/loss-исследование целиком: от выборки сделок и интервью до раздачи выводов по командам. CX Codex +1 ★ 450звёзд репо run-market-landscape-study Команда run-market-landscape-study для Claude Code, которая проводит полный цикл исследования рынка: от оценки TAM/SAM/SOM до матрицы конкурентов. Результат оформляется в выбранный формат — презентацию, мемо или дашборд. CX Codex +1 ★ 450звёзд репо run-waterfall-enrichment Команда run-waterfall-enrichment запускает обогащение контактов и компаний через цепочку провайдеров с лимитом кредитов. Результаты можно направить в CRM, CSV или хранилище данных. CX Codex +1 ★ 450звёзд репо manage-trust-communications Команда manage-trust-communications генерирует сценарии коммуникации при изменении тарифов, сбоях или регуляторных изменениях: сообщения для разных аудиторий, FAQ, план эскалации и мониторинг доверия. CX Codex +1 ★ 450звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой