ea44900700
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com> Co-authored-by: Felicity Chapman <felicitymay@github.com>
30 lines
1.3 KiB
Markdown
30 lines
1.3 KiB
Markdown
---
|
|
title: Breaking changes
|
|
shortTitle: Breaking changes
|
|
intro: Learn about breaking changes that were introduced in each REST API version.
|
|
versions:
|
|
fpt: '*'
|
|
ghes: '*'
|
|
ghec: '*'
|
|
redirect_from:
|
|
- /rest/overview/breaking-changes
|
|
---
|
|
|
|
## About breaking changes in the REST API
|
|
|
|
{% data reusables.rest-api.about-api-versions %}
|
|
|
|
For more information about API versions, see [AUTOTITLE](/rest/overview/api-versions).
|
|
|
|
## Upgrading to a new API version
|
|
|
|
Before upgrading to a new REST API version, you should read the section on this page that corresponds to the new API version to understand what breaking changes are included and to learn more about how to upgrade to that API version.
|
|
|
|
When you update your integration to specify the new API version in the `X-GitHub-Api-Version` header, you'll also need to make any changes required for your integration to work with the new API version.
|
|
|
|
Once your integration is updated, test your integration to verify that it works with the new API version.
|
|
|
|
## Breaking changes for {{ initialRestVersioningReleaseDate }}
|
|
|
|
Version `{{ initialRestVersioningReleaseDate }}` is the first version of the {% data variables.product.github %} REST API after date-based versioning was introduced. This version does not include any breaking changes.
|