À propos du projet

WorkOS OpenAPI Specification 仓库是 WorkOS API 的官方规范来源，采用 OpenAPI 3.1.1 标准。该仓库涵盖了 WorkOS 平台的核心功能接口，包括用户管理、组织管理、目录同步、单点登录、审计日志、API 密钥管理及授权等。作为 WorkOS 官方 SDK 生成的唯一权威数据源，仓库内置了完整的 SDK 生成与编排工作流，确保生成的 SDK 符合 WorkOS 的工程规范。开发者可通过 npm 脚本执行操作名称解析、多语言 SDK 代码生成、规范差异比对及兼容性验证。仓库支持自动化发布流程，能够生成结构化的变更日志片段，并在 CI 环境中自动检测破坏性变更。对于外部开发者，WorkOS 将该规范发布为 npm 包 @workos/openapi-spec，提供从规范生成的 TypeScript 类型定义、原始 YAML 文件路径以及用于代码片段生成的策略模块。