Registo de Alterações
Todas as alterações ao contrato público v1 são revistas face à política de compatibilidade antes de serem lançadas. As alterações aditivas - novos endpoints, novos campos de pedido opcionais, novos campos de resposta, novos eventos de webhook - são lançadas continuamente dentro da v1 e nunca obrigam a migrar.
O que esperar
- Podem surgir novos endpoints e campos a qualquer momento. Tolere campos de resposta desconhecidos em vez de falhar por causa deles.
- As operações
v1existentes e os códigos de estado de sucesso documentados não são removidos, e as escritas existentes não passam a exigir novos parâmetros, corpos de pedido ou propriedades JSON. - O mapeamento de operações do SDK e as ferramentas MCP selecionadas são verificados em CI face ao contrato atual, para que as suas rotas e os seus âmbitos obrigatórios não possam divergir silenciosamente.
Acompanhar alterações
- A Referência da API reflete sempre o contrato atualmente lançado - compare-a com a sua integração ao atualizar.
- As alterações disruptivas regem-se pela Política de Migração e Versionamento, que define a revisão, o pré-aviso e o percurso de migração exigidos.