REST API の破壊的変更について
GitHub Enterprise Server REST API はバージョン管理されています。 API バージョンの名前は、その API バージョンがリリースされた日付に基づいています。 たとえば、API バージョン 2022-11-28 は Mon, 28 Nov 2022 にリリースされました。
すべての破壊的変更は、新しい API バージョンでリリースされます。 破壊的変更とは、統合を破損する可能性のある変更のことです。 破壊的変更には次のようなものが含まれます。
- 操作全体の削除
- パラメーターの削除または名前変更
- 応答フィールドの削除または名前変更
- 新しい必須パラメーターの追加
- 以前に省略可能だったパラメーターを必須にする
- パラメーターまたは応答フィールドの型の変更
- 列挙型の値の削除
- 既存のパラメーターへの新しい検証規則の追加
- 認証または認可の要件の変更
追加的な (破壊的でない) 変更は、サポートされているすべての API バージョンで使用できます。 追加的な変更とは、統合を破損しない変更のことです。 追加的な変更には次のようなものが含まれます。
- 操作の追加
- 省略可能なパラメーターの追加
- 省略可能な要求ヘッダーの追加
- 応答フィールドの追加
- 応答ヘッダーの追加
- 列挙型の値の追加
新しい REST API バージョンがリリースされた場合、以前の API バージョンは、新しい API バージョンのリリースから少なくとも 24 か月間はサポートされます。
API バージョンの詳細については、「API のバージョン」を参照してください。
新しい API バージョンへのアップグレード
新しい REST API バージョンにアップグレードする前に、新しい API バージョンに対応するこのページのセクションを読んで、どのような破壊的変更が含まれているかを理解し、その API バージョンにアップグレードする方法の詳細を確認する必要があります。
X-GitHub-Api-Version ヘッダーで新しい API バージョンを指定するように統合を更新する場合は、統合が新しい API バージョンで動作するために必要な変更を加える必要もあります。
統合が更新されたら、統合をテストして、新しい API バージョンで動作することを確認します。
2022-11-28 の破壊的変更
バージョン 2022-11-28 は、日付ベースのバージョン管理が導入されてから最初の GitHub Enterprise Server REST API のバージョンです。 このバージョンには、破壊的変更は含まれていません。