Em que alterações na resposta da API devemos aumentar a versão e em quais não?

A versão da API deve ser aumentada ao fazer alterações que quebrem a compatibilidade retroativa (alterações disruptivas). Essas alterações incluem:

• Remover ou renomear campos existentes na resposta.
• Alterar o tipo de dados dos campos.
• Alterar a estrutura da resposta, impedindo que os clientes processem corretamente os dados.

Alterações que não requerem aumento de versão:

• Adicionar novos campos opcionais na resposta (os clientes podem ignorá-los).
• Adicionar novos endpoints.
• Corrigir erros que não afetam a estrutura e o formato da resposta.

Assim, se as alterações podem quebrar clientes existentes, é necessário aumentar a versão da API.