Versionamento

Os padrões de versionamento das APIs do Open Insurance Brasil.

Este anexo tem como objetivo detalhar quando a versão das APIs do Open Insurance é alterada, conforme a classificação da modificação.Ele poderá ser acessado clicando aqui..

Major: inclui novas características da implementação, mudanças, correções a serem incorporadas e que podem ser incompatíveis com versões anteriores, por exemplo, v1.0.0 e v2.0.0;

Minor: pequenas mudanças nos elementos já existentes, com manutenção da compatibilidade com as versões até a major imediatamente anterior, por exemplo, v1.1.0 e v1.2.0;

Patch: esclarecimentos às especificações minor, não incluem alterações funcionais, por exemplo, v1.1.1, v1.1.2;

Release candidate: versões de pré-lançamento de qualquer versão futura do tipo patch, minor ou major, por exemplo, v1.0.0-rc e v1.0.0-rc2.

OBS: A instituição deve obrigatoriamente refazer a certificação das APIs no Diretório de Participantes conforme release de uma versão major, minor ou patch.

Alteração	Versionamento

Alteração	Versionamento
Adição de obrigatoriedade de campo	minor
Alteração de pattern que impacta a validação	minor
Retirada de campo	minor
Adição de campo	minor
Ajuste na grafia do campo	minor
Alteraçao do tipo do campo	minor
Diminuição de número de caracteres	minor
Atualizações de REGEX para início de validação de campos antes não validados	minor
Atualização de patterns que não impactam a validação	patch
Retirada de obrigatoriedade de campo	patch
Aumento no número de caracteres	patch
Adição de enum	patch
Ajuste na descrição do campo	patch
Alteração nos exemplos do campo	patch
Atualizações de REGEX que não impactam a validação	patch
Alteração de pattern que não impacta a validação	patch
Retirada de campo não obrigatório	patch
Adição de campo não obrigatório	patch
Retirada da obrigatoriedade de um Campo	patch