REST API バージョン2026-03-10が利用可能に
GitHubがREST APIのカレンダーベースバージョン「2026-03-10」を公開し、初めて破壊的変更を含む新バージョンへの移行ガイドラインと旧バージョンの24ヶ月サポート期間を明記した。
キーポイント
カレンダーベースバージョン「2026-03-10」の公開と破壊的変更の初採用
既存の非破壊的変更に加え、初めて破壊的変更を含む新バージョンがリリースされ、移行ドキュメントとアップグレード手順が提供された。
旧バージョン「2022-11-28」の24ヶ月継続サポートとデフォルト維持
ヘッダー指定がない場合のデフォルトは旧バージョンのまま維持され、既存統合システムは24ヶ月間の猶予期間内で計画的にアップグレード可能。
X-GitHub-Api-Versionヘッダーによる簡易移行手順
ドキュメントのバージョンピッカーを活用し、ヘッダー値を「2026-03-10」に更新するだけで移行が完了するため、実務負荷は低く抑えられている。
新バージョン採用の推奨と将来の互換性確保
即時アップグレードは必須ではないが、機能強化の活用と将来のバージョン発行に伴う互換性維持のため、計画的な移行が統合開発者に促されている。
影響分析・編集コメントを表示
影響分析
GitHubはAPIの安定性と開発者の移行負担を両立させるため、カレンダーベースバージョン管理において初めて破壊的変更を含む新バージョンを公開した。これにより、既存の統合システムは24ヶ月間の猶予期間内で計画的にアップグレードでき、プラットフォーム側の機能強化と開発者の運用負荷のバランスが図られる。特に大規模なサードパーティツールやCI/CDパイプラインを持つ組織にとって、移行計画の策定とテスト環境での検証が求められる重要なマイルストーンとなる。
編集コメント
破壊的変更を含むカレンダーバージョンは開発者にとって移行リスクを伴うが、24ヶ月のサポート猶予と明確なヘッダー操作手順により実務負荷は低く抑えられている。今後は同様のAPI運用戦略が他プラットフォームにも広まる可能性があり、開発チームはバージョン管理ポリシーの監視を常時行う必要がある。
以前、当社は REST API にカレンダーベースのバージョニングを導入し、API を進化させる道筋を提供するとともに、インテグレーターの皆様に十分な時間と明確なアップグレードの指針をお伝えしてきました。
このたび、GitHub REST API の最新バージョンであるカレンダーバージョン 2026-03-10 をリリースします。これは破壊的変更を含む最初のカレンダーバージョンとなります。
今回のリリース内容
バージョン 2026-03-10 では、REST API に一連の破壊的変更が導入されています。変更点の完全なリストとアップグレードの手引きは、破壊的変更に関するドキュメントでご確認いただけます。
なお、非破壊的変更(例: 新規エンドポイント、オプションのパラメーター、追加のレスポンスフィールド)は、サポートされているすべての API バージョンで引き続き利用可能です。
既存のインテグレーションへの影響
バージョン 2022-11-28 は、本日から少なくとも 24 か月間、完全にサポートされ続けます。また、X-GitHub-Api-Version ヘッダーを含まないリクエストは、引き続き 2022-11-28 がデフォルトとなります。
アップグレードの準備が整いましたら、その手順は簡単です。新しいバージョンのドキュメントを確認し、破壊的変更に対応するために必要な変更をインテグレーションに加えた後、X-GitHub-Api-Version ヘッダーの値を 2026-03-10 に更新し、新しい API バージョンでインテグレーションが期待通りに動作することを検証してください。
当社の API ドキュメントにあるバージョン選択機能を使用すると、利用可能なすべてのバージョンのドキュメントを表示できます。
今後の展開
今後の API バージョンリリースについては、GitHub のチェンジログを通じて引き続きお知らせしてまいります。
インテグレーターの皆様には、最新の機能強化を活用するために 2026-03-10 への移行をご検討いただければ幸いです。すぐにアップグレードする必要はありませんが、新しいバージョンに移行することで、お客様のインテグレーションの互換性が確保され、今後リリースされる新バージョンに伴う継続的な改善の恩恵を受けることができます。
投稿「REST API version 2026-03-10 is now available」は、The GitHub Blog で最初に公開されました。
原文を表示
Previously, we introduced calendar-based versioning for our REST API, giving us a path to evolving our API while giving integrators plenty of time and clear guidance for upgrading.
Now, we’re releasing calendar version 2026-03-10, the newest version of the GitHub REST API. This is the first calendar version to include breaking changes.
What’s in this release
Version 2026-03-10 introduces a set of breaking changes to the REST API. You can find the full list of changes, along with upgrade guidance, in our breaking changes documentation.
As a reminder, non-breaking changes (e.g., new endpoints, optional parameters, additional response fields) continue to be available across all supported API versions.
What this means for existing integrations
Version 2022-11-28 will continue to be fully supported for at least 24 months from today, and requests that don’t include the X-GitHub-Api-Version header will continue to default to 2022-11-28.
When you’re ready to upgrade, it’s straightforward. After reviewing the new version documentation and making any necessary changes to your integration to account for breaking changes, update the X-GitHub-Api-Version header to 2026-03-10 and verify that your integration works as expected with the new API version.
Use the version picker in our API documentation to view the docs for all available versions.
What’s next
We’ll continue to communicate future API version releases through the GitHub changelog.
We’d love for integrators to adopt 2026-03-10 to take advantage of the latest enhancements and features. While there’s no pressure to upgrade immediately, moving to the new version will help ensure your integration remains compatible and benefits from ongoing improvements as we continue to release new versions over time.
The post REST API version 2026-03-10 is now available appeared first on The GitHub Blog.
関連記事
今日のまとめ
AI日報で今日の重要ニュースをまとめ読み