Sobre alterações interruptivas na API REST
A API REST do GitHub tem controle de versão. O nome da versão da API é baseado na data em que a versão da API foi lançada. Por exemplo, a versão 2022-11-28 da API foi lançada em Mon, 28 Nov 2022.
Quaisquer alterações interruptivas serão lançadas em uma nova versão da API. Alterações interruptivas são alterações que podem potencialmente interromper uma integração. As alterações interruptivas incluem:
- removendo uma operação inteira
- removendo ou renomeando um parâmetro
- removendo ou renomeando um campo de resposta
- adicionando um novo parâmetro obrigatório
- fazendo um parâmetro opcional anteriormente necessário
- alterando o tipo de um parâmetro ou campo de resposta
- removendo valores de enumeração
- adicionando uma nova regra de validação a um parâmetro existente
- alterando os requisitos de autenticação ou autorização
Quaisquer alterações aditivas (não interruptivas) estarão disponíveis em todas as versões da API com suporte. Alterações aditivas são alterações que não devem interromper uma integração. As alterações aditivas incluem:
- adicionando uma operação
- adicionando um parâmetro opcional
- adicionando um cabeçalho de solicitação opcional
- adicionando um campo de resposta
- adicionando um cabeçalho de resposta
- adicionando valores de enumeração
Quando uma nova versão da API REST for lançada, a versão anterior da API terá suporte por pelo menos mais 24 meses após o lançamento da nova versão da API.
Para obter mais informações sobre as versões da API, confira Versões da API.
Atualizando para o nova versão da API
Antes de atualizar para uma nova versão da API REST, leia a seção nesta página que corresponde à nova versão da API para entender quais alterações interruptivas estão incluídas e saber mais sobre como atualizar para essa versão da API.
Ao atualizar sua integração para especificar a nova versão da API no cabeçalho X-GitHub-Api-Version, você também precisará fazer as alterações necessárias para que sua integração funcione com a nova versão da API.
Após a atualização da integração, teste sua integração para verificar se ela funciona com a nova versão da API.
Alterações interruptivas para 2022-11-28
A versão 2022-11-28 é a primeira versão da API REST do GitHub após a introdução do controle de versão baseado em data. Esta versão não inclui nenhuma alteração interruptiva.