SKILLEMALL.ai

CD openapi

Генерация OpenAPI в Vovk.ts — как спецификация OpenAPI 3.x выводится из процедур + схем валидации, семейство декораторов `@operation` (`@operation({...})` для summary/description/tags/security/deprecated, `@operation.error(status, message)` для ответов об ошибках, `@operation.tool({...})` для метаданных AI-инструментов), настройка верхнего уровня `outputConfig.openAPIObject` (info, servers, license, tags, security, components), переопределения для каждого сегмента, доступ к спецификации из кода (`@/client/openapi`), обслуживание JSON спецификации из контроллера и рендеринг с помощью **Scalar** (основной / рекомендуемый UI документации — использует примеры кода TypeScript / Python / Rust, генерируемые Vovk через `x-codeSamples`) или альтернатив, таких как Redoc / Swagger UI. Используйте, когда пользователь запрашивает «документацию API», «документацию Scalar», «Swagger», «спецификацию OpenAPI», «документировать мой API», «сгенерировать OpenAPI из моих контроллеров», «добавить блок info/title/servers», «документацию для конкретного сегмента», «предоставить OpenAPI по адресу /api/docs», «bearer auth в спецификации», «документировать возможные ошибки», «сделать конечную точку устаревшей». НЕ охватывает создание процедур → передать навыку `procedure`. НЕ охватывает вывод AI-инструментов через `deriveTools` → передать навыку `tools` (хотя `@operation.tool` упоминается здесь, так как это часть семейства декораторов). НЕ охватывает импорт сторонних OpenAPI → передать навыку `mixins`.

машинный переводПоказать оригиналСкрыть оригинал«Vovk.ts OpenAPI generation — how the OpenAPI 3.x spec is derived from…»

Vovk.ts OpenAPI generation — how the OpenAPI 3.x spec is derived from procedures + validation schemas, the `@operation` decorator family (`@operation({...})` for summary/description/tags/security/deprecated, `@operation.error(status, message)` for error responses, `@operation.tool({...})` for AI tool metadata), top-level `outputConfig.openAPIObject` configuration (info, servers, license, tags, security, components), per-segment overrides, accessing the spec from code (`@/client/openapi`), serving the spec JSON from a controller, and rendering it with **Scalar** (the primary / recommended docs UI — picks up the TypeScript / Python / Rust code samples that Vovk generates via `x-codeSamples`) or alternatives like Redoc / Swagger UI. Use whenever the user asks for "API docs", "Scalar docs", "Swagger", "OpenAPI spec", "document my API", "generate OpenAPI from my controllers", "add an info/title/servers block", "segment-specific docs", "expose OpenAPI at /api/docs", "bearer auth in the spec", "document possible errors", "deprecate an endpoint". Does NOT cover procedure authoring → hand off to `procedure` skill. Does NOT cover AI tool derivation via `deriveTools` → hand off to `tools` skill (though `@operation.tool` is mentioned here since it's part of the decorator family). Does NOT cover third-party OpenAPI imports → hand off to `mixins` skill.

Разбор skillemall

Скилл учит ИИ генерировать OpenAPI 3.x из процедур и схем валидации Vovk.ts. Обещает: декораторы `@operation` для метаданных (summary, tags, security), `@operation.error()` для ошибок, `@operation.tool()` для AI-инструментов, конфиг `outputConfig.openAPIObject` на уровне приложения, доступ к спеке через `@/client/openapi` и рендер через Scalar с автогенерацией примеров кода.

В файле — одна инструкция на 3240 токенов, без примеров и прогонов. Оценка C (качество 59%, процесс 47%) указывает на неполноту: описание перегружено деталями, но не показывает, как это работает на практике. Lint ругается на длинное описание. Критических ошибок нет, зато нет и песочницы, чтобы проверить, генерирует ли декоратор валидный OpenAPI и подхватывает ли Scalar примеры.

Ставить, если вы уже работаете с Vovk.ts и нужна справка по синтаксису. Если ИИ должен самостоятельно писать `@operation` с нужными параметрами — потребуется дополнить примерами из реальных контроллеров.

finom/vovk Agent Skills автор: finom 1 файл тело ≈ 3 240 токенов Открыть источникgithub.com↗ проанализирован 5 дн назад

Генерация OpenAPI в Vovk.ts — как спецификация OpenAPI 3.x выводится из процедур + схем валидации, семейство декораторов @operation (@operation({...}) для…

Как процесс D 47/100 · Процесс не доведён — слабые места: результат и критерий готовности, входы и предусловия, ошибки и развилки

ПроцедураРазработкатип и темы размечены автоматически по тексту скилла
JSON
Технический рейтинг
C
84/100
безопасность, качество, тесты
Безопасность 60%
100
Качество 40%
59
Прогон на моделях
не было
Процессный рейтинг
D
47/100
Процесс не доведён
Результат и критерий готовности вес 14
0
Входы и предусловия вес 11
0
Ошибки и развилки вес 10
0
три самых слабых из десяти параметров · все десять

Как улучшить

  1. Сократите description до 1024 символов.
Для прогона на моделях — необязательно
  • Свои кейсы (evals/evals.json, 4–6 реальных запросов с ожидаемыми ответами): тогда полная проверка прогонит именно их, а не черновик от модели.
  • spec.yaml с триггерными фразами и утверждениями — контракт поведения для CI; `skilltest init` создаст шаблон.

Находки guard · 0

✓ Критических и высоких находок нет

Просканировано файлов: 1. Улики замаскированы. Пометки в серых чипах объясняют, почему серьёзность понижена.

По спецификации Agent Skills

  • ошибка description-long description 1361 символов, лимит 1024
  • заметка edit-residue в тексте есть пометки об устаревшем (строки 25, 40, 283): проверьте, не остались ли старые правила рядом с новыми — полная проверка читает текст на противоречия

Процессный рейтинг: все десять параметров 47/100

  • 0Результат и критерий готовности. Не сказано, что считать результатом
  • 0Входы и предусловия. Не сказано, что нужно иметь на входе
  • 0Ошибки и развилки. Линейный процесс без обработки сбоев
  • 0Отчётность по ходу. Скилл ничего не сообщает по ходу работы
  • 30Повторный запуск. Изменяющих операций: 4, без проверки текущего состояния
  • 60Инструменты и файлы. Используются инструменты (bash, web, python), но во frontmatter они не объявлены
  • 70Когда включается. Сказано, когда применять, но не сказано, когда не стоит
  • 85Шаги. Шагов: 9, расплывчатых формулировок: 2
  • 100Согласованность. Имя и обязательные поля на месте
  • 100Стоимость исполнения. Тело инструкции 3240 токенов

Всё перечисленное измерено по тексту скилла, а не оценено моделью: цифры проверяемы. Вес параметра тем больше, чем чаще из-за него процесс встаёт.

Сигналы качества

  • +4Описание не говорит, когда скилл НЕ применять (ложные срабатывания)
  • +3Длина description 1361: рекомендуется 120–800 символов
  • +3Формат ответа не описан: модель каждый раз решает сама
  • -2Ссылки на localhost: у другого пользователя не заработает
  • +1Лицензия не указана
  • +2Инструкции на одном языке
  • +5В description 12 примера фраз-триггеров в кавычках
  • +4Структура: 23 заголовков
  • +3Пошаговые инструкции: 9 пунктов
  • +4Есть примеры (14 блоков кода)

База качества 70; замечания lint вычитаются, сигналы прибавляют до 100. Итог: 59.