Сведения о критических изменениях в REST API
REST API GitHub — версия REST API. Имя версии API основано на дате выпуска версии API. Например, версия 2022-11-28 API была выпущена на Mon, 28 Nov 2022.
Критические изменения — это изменения, которые могут потенциально нарушить интеграцию. Мы предупредим заранее перед публикацией нерешительных изменений. Критические изменения включают:
- Удаление всей операции
- Удаление или переименование параметра
- Удаление или переименование поля ответа
- Добавление нового обязательного параметра
- Создание ранее необязательного параметра
- Изменение типа поля параметра или ответа
- Удаление значений перечисления
- Добавление нового правила проверки в существующий параметр
- Изменение требований к проверке подлинности или авторизации
Любые некритивные изменения будут доступны во всех поддерживаемых версиях API. Аддитивные изменения — это изменения, которые не должны прерывать интеграцию. К аддитивным изменениям относятся:
- Добавление операции
- Добавление необязательного параметра
- Добавление необязательного заголовка запроса
- Добавление поля ответа
- Добавление заголовка ответа
- Добавление значений перечисления
При выпуске новой версии REST API предыдущая версия API будет поддерживаться не менее 24 месяцев после выпуска новой версии API.
Дополнительные сведения о версиях API см. в разделе AUTOTITLE.
Обновление до новой версии API
Перед обновлением до новой версии REST API необходимо прочитать раздел на этой странице, соответствующий новой версии API, чтобы понять, какие критические изменения включены и узнать больше о том, как обновить эту версию API.
Когда вы обновляете интеграцию, чтобы указать новую версию API в заголовке X-#REF!-Api-Version, вам также нужно внести необходимые изменения для работы с новой версией API.
После обновления интеграции проверьте интеграцию, чтобы убедиться, что она работает с новой версией API.