Versionamento e depreciação

A promessa

Uma rota marcada como contrato de parceiro tem o shape congelado. A 77Sol não remove campo,
não renomeia campo, não muda tipo e não muda código de status dentro da mesma versão.

O que a 77Sol pode fazer sem avisar

Adicionar campo novo na resposta.

Adicionar parâmetro opcional na requisição.

Adicionar valor novo num enum de resposta.

Adicionar rota nova.

Escreva seu cliente para ignorar campo desconhecido. Um campo novo não pode quebrar sua
integração.

O que exige versão nova

Remover ou renomear campo de resposta.

Mudar o tipo de um campo.

Tornar obrigatório um parâmetro que era opcional.

Mudar o código de status de um caminho de sucesso.

Mudar o significado de um valor de enum.

Como a versão aparece

A versão vive no caminho: /api/v1/.... Uma quebra gera /api/v2/... para aquela rota.
As duas versões respondem em paralelo durante a janela de depreciação.

Janela de depreciação

Etapa	Prazo
Aviso por email para todo parceiro que chamou a rota nos últimos 90 dias	Dia 0
A rota antiga passa a devolver o header `Deprecation` e o header `Sunset`	Dia 0
A rota antiga sai do ar	Dia 180

O header Sunset traz a data de desligamento em formato HTTP. O header Deprecation traz
a data em que o aviso começou. Monitore os dois nas suas respostas.

Como acompanhar

O changelog fica em 99-changelog.md e no site de documentação.

Endpoint depreciado aparece riscado na documentação, com a alternativa indicada.

A promessa#

O que a 77Sol pode fazer sem avisar#

O que exige versão nova#

Como a versão aparece#