इस प्रोजेक्ट के बारे में

WorkOS OpenAPI Specification 仓库是 WorkOS API 的官方规范来源，采用 OpenAPI 3.1.1 标准并以 YAML 格式定义。该仓库不仅涵盖了 WorkOS 平台的核心功能接口，包括用户管理、组织管理、目录同步（SCIM）、单点登录（SSO）、审计日志、API 密钥管理及授权（RBAC）等，还作为 WorkOS 官方 SDK 生成的唯一权威数据源。 仓库内置了完整的 SDK 生成与编排工作流，通过 `src/policy/` 目录下的策略模块定义命名规则、挂载逻辑及转换函数，确保生成的 SDK 符合 WorkOS 的工程规范。开发者可通过 npm 脚本执行操作名称解析、多语言 SDK 代码生成、规范差异比对及兼容性验证。此外，仓库支持自动化发布流程，能够生成结构化的变更日志片段，并在 CI 环境中自动检测破坏性变更。 对于外部开发者，WorkOS 将该规范发布为 npm 包 `@workos/openapi-spec`。该包提供了从规范生成的 TypeScript 类型定义、原始 YAML 文件路径以及用于代码片段生成的策略模块。开发者可以直接导入类型以增强 HTTP 客户端的静态检查能力，或加载原始规范进行自定义工具开发。仓库还包含生成 Postman 集合的脚本，便于 API 调试。整体而言，该仓库是连接 WorkOS API 定义与多语言客户端实现的关键基础设施，确保了 API 变更在 SDK 生态中的准确同步与兼容性保障。