Política de depreciação

Nossa API ainda não está completa e por isso está em constante mudança. A maior parte das alterações adiciona campos, o que geralmente não requer nenhuma mudança de código dos usuários da API.

Nos casos que a mudança quebra o contrato, removendo ou modificando um campo, ela é feita um duas fases. O novo campo é adicionado e o campo antigo é marcado como deprecated. Eles coexistem por um período de no mínimo 3 meses, após este período o campo deprecated é removido. A ideia é permitir que usuários tenham tempo para ajustar o código que dependa de campos descontinuados.

Campos marcados como deprecated não aparecem na documentação da API porém continuam funcionando normalmente. O API Playground permite inspecionar o schema e identificar os campos marcados como deprecated bem como a sua documentação, caso exista.

Ainda não existe nenhum mecanismo formal de notificação caso o usuário da API esteja usando campos descontinuados. Hoje a única ferramenta disponível é inspecionar manualmente _API Playground_ ou fazendo solicitações de introspecção para a API.