Сведения о критических изменениях в REST API
REST API GitHub Enterprise Cloud имеет версию. Имя версии 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.
Критические изменения для 2022-11-28
Версия 2022-11-28
— это первая версия REST API GitHub Enterprise Cloud после того, как было введено управление версиями на основе даты. Эта версия не содержит критических изменений.