openapi-spec

WorkOS OpenAPI Specification 저장소는 WorkOS API의 공식 사양 소스로, OpenAPI 3.1.1 표준을 따르며 YAML 형식으로 정의되어 있습니다. 이 저장소는 사용자 관리, 조직 관리, 디렉토리 동기화(SCIM), 단일 사인온(SSO), 감사 로그, API 키 관리, 권한 부여(RBAC) 등 WorkOS 플랫폼의 핵심 기능 인터페이스를 포괄합니다. 또한, WorkOS 공식 SDK 생성을 위한 유일한 권위 있는 데이터 소스로서, `src/policy/` 디렉토리의 정책 모듈을 통해 명명 규칙, 마운트 로직, 변환 함수를 정의하여 생성된 SDK가 WorkOS의 엔지니어링 표준을 준수하도록 보장합니다. 개발자는 npm 스크립트를 통해 작업 이름 해석, 다국어 SDK 코드 생성, 사양 차이 비교, 호환성 검증을 수행할 수 있으며, 자동화된 릴리스 프로세스를 통해 구조화된 변경 로그를 생성하고 CI 환경에서 호환성 문제를 감지할 수 있습니다. 외부 개발자를 위해, WorkOS는 이 사양을 `@workos/openapi-spec` npm 패키지로 배포하여, TypeScript 타입 정의, 원본 YAML 파일 경로, 코드 스니펫 생성용 정책 모듈을 제공합니다. 개발자는 이를 통해 HTTP 클라이언트의 정적 검사를 강화하거나, 사용자 정의 도구를 위해 원본 사양을 로드할 수 있습니다. 또한, 저장소에는 API 디버깅을 위한 Postman 컬렉션 생성 스크립트도 포함되어 있습니다.