openapi-spec

WorkOS OpenAPI Specification リポジトリは、WorkOS API の公式な仕様ソースであり、OpenAPI 3.1.1 標準を使用して YAML 形式で定義されています。このリポジトリには、ユーザー管理、組織管理、ディレクトリ同期 (SCIM)、シングルサインオン (SSO)、監査ログ、API キー管理、およびロールベースのアクセス制御 (RBAC) を含む WorkOS プラットフォームのコア機能のインターフェイスが含まれています。また、WorkOS の公式 SDK を生成するための唯一の権威あるデータ ソースとしても機能します。 リポジトリには、SDK 生成とオーケストレーションのための完全なワークフローが組み込まれています。`src/policy/` ディレクトリ内のポリシー モジュールは、命名規則、マウント ロジック、および変換関数を定義し、生成された SDK が WorkOS のエンジニアリング標準に準拠することを保証します。開発者は、npm スクリプトを使用して、操作名の解決、複数のプログラミング言語での SDK コードの生成、仕様の差分比較、および互換性の検証を実行できます。さらに、リポジトリは自動化されたリリース プロセスをサポートしており、構造化された変更ログの断片を生成し、CI 環境で破壊的な変更を自動的に検出できます。 外部開発者のために、WorkOS はこの仕様を npm パッケージ `@workos/openapi-spec` として公開しています。このパッケージには、仕様から生成された TypeScript のタイプ定義、生の YAML ファイルへのパス、およびコード スニペット生成用のポリシー モジュールが含まれています。開発者は、HTTP クライアントの静的チェックを強化するためにタイプを直接インポートしたり、カスタム ツールの開発のために生の仕様をロードしたりできます。リポジトリには、API デバッグ用の Postman コレクションを生成するスクリプトも含まれています。全体として、このリポジトリは、WorkOS API の定義と多言語クライアントの実装を接続する重要なインフラストラクチャであり、SDK エコシステム全体で API の変更が正確に同期され、互換性が維持されることを保証します。