openapi-spec

O repositório WorkOS OpenAPI Specification é a fonte oficial de verdade para a API WorkOS, utilizando o padrão OpenAPI 3.1.1 e definido em formato YAML. Ele abrange as principais funcionalidades da plataforma, incluindo gerenciamento de usuários, organizações, sincronização de diretórios (SCIM), single sign-on (SSO), logs de auditoria, gerenciamento de chaves de API e controle de acesso baseado em funções (RBAC). O repositório também é o único ponto de origem para a geração dos SDKs oficiais da WorkOS. O fluxo de trabalho de geração de SDKs está totalmente integrado, com módulos de política em `src/policy/` definindo convenções de nomenclatura, lógica de montagem e funções de transformação para garantir que os SDKs gerados estejam alinhados com os padrões de engenharia da WorkOS. Os desenvolvedores podem executar scripts npm para resolver nomes de operações, gerar código de SDK em várias linguagens, comparar diferenças de especificações e validar compatibilidade. O repositório suporta lançamentos automatizados, gerando fragmentos de notas de lançamento estruturadas e detectando mudanças disruptivas no ambiente CI. Para desenvolvedores externos, a WorkOS publica a especificação como um pacote npm, `@workos/openapi-spec`. Este pacote inclui definições de tipo TypeScript geradas a partir da especificação, o caminho para o arquivo YAML bruto e módulos de política para geração de snippets de código. Os desenvolvedores podem importar os tipos para melhorar a verificação estática de clientes HTTP ou carregar a especificação bruta para desenvolver ferramentas personalizadas. O repositório também fornece scripts para gerar coleções Postman para depuração de API. No geral, este repositório é a infraestrutura crítica que conecta a definição da API WorkOS às implementações de clientes multilíngues, garantindo sincronização precisa e compatibilidade durante as atualizações da API.