Páginas filhas
  • Validador Automatizado de APIs: Validações realizadas e formas de correção

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Tradução de termos

...

Esse arquivo OpenAPI é referente a uma nova versão minormenor, porém o mesmo está apresentando quebra de compatibilidade ("breaking changes"/ quebra de compatibilidade ) em relação à versão minor menor anterior.

Mudanças permitidas: 

...

Mudanças que exigem uma nova versão majormaior:

→ Endpoints removidos ou com assinatura alterada

...

Informações

De acordo com o versionamento semântico, somente trabalhamos com versões minor menores enquanto não existe quebra de contrato.

Quando a quebra de contrato se faz necessária, é preciso subir uma versão majormaior.

2.000 -> 2.001 : Subindo versão minormenor

2.000 -> 3.000 : Subindo versão majormaior

Quando esse erro acontece, ele apresenta um sumário completo da comparação entre as duas APIs, para ficar claro o que está ok e o que está causando essa quebra

...

Atenção para o valor de "isBackwardCompatible".  Sempre que for "false", aponta aonde ocorreu a quebra de contrato, enquanto, se possuir valor "true", representa uma mudança aceitável, sem comprometer a compatibilidade com a versão minor menor anterior.

should have anything different from the previous minor version, beside x-totvs

...