Критические изменения

Сведения о критических изменениях в REST API

Интерфейс REST API GitHub имеет версию. Имя версии API основано на дате выпуска версии API. Например, версия 2022-11-28 API была выпущена на Mon, 28 Nov 2022.

Все критические изменения будут выпущены в новой версии API. Критические изменения — это изменения, которые могут потенциально нарушить интеграцию. Критические изменения включают:

Удаление всей операции
Удаление или переименование параметра
Удаление или переименование поля ответа
добавление нового обязательного параметра
создание ранее необязательного параметра
изменение типа поля параметра или ответа
Удаление значений перечисления
добавление нового правила проверки в существующий параметр
изменение требований к проверке подлинности или авторизации

Любые некритивные изменения будут доступны во всех поддерживаемых версиях API. Аддитивные изменения — это изменения, которые не должны прерывать интеграцию. К аддитивным изменениям относятся:

добавление операции
добавление необязательного параметра
добавление необязательного заголовка запроса
добавление поля ответа
добавление заголовка ответа
добавление значений перечисления

При выпуске новой версии REST API предыдущая версия API будет поддерживаться не менее 24 месяцев после выпуска новой версии API.

Дополнительные сведения о версиях API см. в разделе Версии API.

Обновление до новой версии API

Перед обновлением до новой версии REST API необходимо прочитать раздел на этой странице, соответствующий новой версии API, чтобы понять, какие критические изменения включены и узнать больше о том, как обновить эту версию API.

При обновлении интеграции, чтобы указать новую версию API в заголовке X-GitHub-Api-Version , вам также потребуется внести все изменения, необходимые для интеграции для работы с новой версией API.

После обновления интеграции проверьте интеграцию, чтобы убедиться, что она работает с новой версией API.