Política de Migração e Versionamento
A API pública preserva a compatibilidade dentro de v1. As alterações disruptivas exigem uma revisão explícita de política, uma entrada no registo de alterações e um caminho de migração.
Compromissos de compatibilidade
- Podem ser lançados campos e endpoints aditivos dentro de
v1. - Os campos de resposta existentes não mudarão de significado dentro de
v1. - Não serão adicionados campos de pedido obrigatórios às escritas
v1existentes sem um plano de compatibilidade. - As superfícies do SDK e do MCP são verificadas contra o mesmo modelo de scope e operação da OpenAPI.
O que isto significa para si
- Tolere campos novos e não reconhecidos nas respostas (não falhe por causa deles).
- Fixe o SDK numa versão conhecida e atualize de forma deliberada.
- Acompanhe o Registo de Alterações para alterações aditivas.
Política de fonte
A política de alterações disruptivas é mantida em docs/developer-platform/openapi-breaking-change-policy.md e aplicada por verificações de contrato.