Об этом проекте

Репозиторий WorkOS OpenAPI Specification является официальным источником спецификаций API WorkOS, выполненных в формате YAML по стандарту OpenAPI 3.1.1. Он охватывает ключевые функции платформы, включая управление пользователями и организациями, синхронизацию каталогов (SCIM), однократное вхождение (SSO), аудит, управление API-ключами и авторизацию (RBAC). Репозиторий служит единственным авторитетным источником данных для генерации официальных SDK WorkOS. Внутри репозитория реализован полный рабочий процесс генерации и оркестрации SDK, включая модули политики в `src/policy/`, которые определяют правила именования, логику монтирования и функции преобразования для обеспечения соответствия SDK инженерным стандартам WorkOS. Разработчики могут использовать скрипты npm для анализа имен операций, генерации кода на нескольких языках, сравнения спецификаций и проверки совместимости. Также поддерживается автоматическая публикация с генерацией структурированных заметок об изменениях и обнаружением разрушающих изменений в CI. Для внешних разработчиков спецификация доступна как пакет npm `@workos/openapi-spec`, содержащий сгенерированные типы TypeScript, путь к исходному YAML и модули политики для генерации кода. Это позволяет улучшить статическую проверку HTTP-клиентов и разрабатывать собственные инструменты на основе спецификации. Репозиторий также включает скрипты для генерации коллекций Postman, облегчая отладку API. В целом, он служит критической инфраструктурой для синхронизации изменений API с экосистемой SDK и обеспечения совместимости.