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
swagger-cover
0
Покрыть роут/модуль OpenAPI/Swagger — параметры, ответы, описания, security + проверка, на любом стеке (роль swagger). Use when роут/модуль надо задокументировать (править код/спеку); найти дыры без правок — $swagger-audit.
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
# Задача: покрыть роут/модуль OpenAPI/Swagger
Определи стек и механизм документации (не предполагай Fastify): `schema` у Fastify, `@ApiOperation/@ApiResponse/@ApiTags` у NestJS, JSDoc `@openapi` (swagger-jsdoc) или декораторы у tsoa, `options.validate/response/tags` у Hapi, `.meta.openapi` у tRPC, либо правки в статической `openapi.{yaml,json}`. По `$swagger-coverage`:
1. Опиши вход (`params`/`query`/`headers`/`body`) и **все** ответы (успех + ошибки), заведи/переиспользуй общий Error-компонент. Для Fastify+zod — схемы + `z.globalRegistry` для `$ref`.
2. Проставь `summary`/`description`/`tags`/`operationId`; для защищённых — `security`.
3. Сверь хендлер/controller: возвращает РОВНО то, что в схеме ответа, с верными статусами. При расхождении правь хендлер или схему, не ослабляя валидацию.
4. Запрещено: прятать роут из спеки (`hide`/exclude), ставить `any`/пустые схемы ради покрытия.
5. **Валидация спеки — обязательный шаг готовности.** Получи итоговую спеку (рантайм-эндпоинт стека / статический файл / генератор; для рантайм-спеки запусти приложение и убедись, что она отдаётся) и прогони `npx swagger-cli validate <spec>` или `npx @redocly/cli lint <spec>` + `npx openapi-typescript <spec>` без ошибок; прогони тесты. **Только валидная спека = готово** — при ошибках валидации чини и перегоняй, невалидную спеку не сдавай.
Опирайся на `$swagger-coverage`, `$backend-architecture`, `$typescript`.Skill folder
Files included alongside SKILL.md in the publisher’s repository.