SECURITY REVIEW
Not yet assessed
Review the original instructions and requested permissions before installing.
No security review is available for this catalog entry yet.
Community / AGENT SKILL
docs-api
0
Сгенерировать docs/API.md из OpenAPI/Swagger-спеки — таблица эндпоинтов, параметры/ответы, curl-примеры (роль docs). Use когда нужна человекочитаемая API-документация поверх спеки.
Understand the trade-offs.
SKILL QUALITY
Not yet assessed
How clearly the skill guides your agent, how complete its workflow is, and how you can check the outcome.
No quality assessment is available for this catalog entry yet.
The full skill.
Original instructions from the publisher’s SKILL.md
# Задача: docs/API.md из OpenAPI-спеки
Сгенерируй `docs/API.md` из OpenAPI-спеки (см. `$api-design`, `$swagger-coverage`).
1. Найди спеку: статическая `openapi.{yaml,json}`, рантайм-эндпоинт (`/documentation/json` · `/api-json` · `/openapi.json` · `/v3/api-docs`) или генератор.
2. **Спеки нет — не выдумывай API по коду**: остановись и предложи сначала `$swagger-audit` → `$swagger-cover`; документировать нечего, пока контракта нет.
3. Сводная таблица эндпоинтов (метод, путь, `summary`, auth, теги), группировка по тегам. По каждой операции: параметры, `requestBody`, `responses` по кодам — **только из спеки**.
4. curl-примеры на ключевые операции: реальные поля из схем, плейсхолдеры `<TOKEN>`, базовый URL из `servers`; синтаксис проверь (`bash -n`).
5. Версия — из `info.version`; в шапке файла — источник спеки и дата генерации.
Отдай путь к `docs/API.md` + источник спеки + число задокументированных операций (сверь со спекой). Опирайся на `$technical-writing`.