データ API ビルダーのポリシー

2025-06-11

一連のポリシーは、破壊的変更、通知、リリース、バージョン管理に関連するデータ API ビルダーを管理します。

バージョン管理とリリース

Data API ビルダーのコンテキストでの リリース とは、公開されているすべてのバージョンのソフトウェアを指し、 Major.Minor.Patch 形式で識別されます。これらのリリースは、 安定した、 破壊的変更、プレビューの 3 つのカテゴリに分類 されます。

コンテナーの更新の責任

データ API ビルダーコンテナーは自動的に更新されません。お客様は、新しいリリースを監視し、その重要度 (セキュリティ更新プログラムを含む) を評価し、それに応じてデプロイされたコンテナーを更新する責任があります。

コンテナーを最新の状態に保つことは、 お客様の責任です。

安定版リリース

安定したバージョンの Data API ビルダーは下位互換性があります。下位互換性は、データ API ビルダーの 1 つのバージョンに依存するコードを記述すると、コードの変更を必要とせずに、正確性や既存の機能を維持することなく、新しい安定したバージョンを採用できることを意味します。

破壊的変更リリース

データ API ビルダーの 破壊的変更バージョン には下位互換性がありません。既存のクライアントコードで破壊的変更バージョンを採用するには、以前のバージョンをターゲットにしたときとまったく同じようにクライアントが動作するようにコードを変更する必要がある場合があります。

破壊的変更バージョンは、破壊的変更リストの記事と GitHub リリースの変更の説明で発表されます。プレビュー/リリース候補バージョンの公開は、重大なセキュリティ、プライバシー、または法的な問題を修正しない限り、破壊的変更バージョンよりも前になります。以前のバージョンの Data API ビルダーは GitHub リリースページで引き続き使用できる場合がありますが、バグ修正を含む最新リリースにアップグレードすることをお勧めします。

プレビューリリース

データ API ビルダーのプレビューリリースは、 X.Y.Z-rc バージョン管理スキームで識別されます。 -rc サフィックスは、ビルドが "リリース候補" であることを示します。プレビューリリースは、新機能やその他の変更に関するフィードバックを収集するために使用されます。

最後の安定バージョンから意図的に大幅な変更を加える予定がない限り、最新の安定したリリースと新しいプレビュー機能からのすべてのものを含む次のプレビューバージョンを公開します。次の Data API ビルダーの更新プログラムでは、プレビューバージョン間で追加した新しいプレビュー機能の一部が中断される可能性があります。この破壊的動作は、コードを変更して再び動作させる必要がある場合があります。

プレビューバージョンは、長期的または運用環境での使用を目的としていません。新しい安定版またはプレビュー版が利用可能になると、古いプレビューバージョンにアクセスできなくなる可能性があります。プレビューバージョンは、新しい機能に積極的に取り組んでおり、リリース後すぐにプレビュー以外のバージョンに切り替える準備ができている場合にのみ使用することをお勧めします。プレビューバージョンの一部の機能が新しい安定バージョンに含まれている場合は、残りのプレビュー機能が新しいプレビューバージョンに追加され、試すことができます。

バージョン変更テーブル

Von Bedeutung

重要な製品のバグ、法的、セキュリティ、またはプライバシーに関する懸念に対処する場合、マイナーリリースまたはパッチリリースに破壊的変更が導入される可能性があります。

リリースの種類	以前のバージョン	新しいバージョン	注記
破壊的変更	`1.Y.Z`	`2.Y.Z`	新機能とバグ修正と、重大な変更。
安定	`1.1.Z`	`1.2.Z`	重要な製品のバグ、法的、セキュリティ、プライバシーに関する懸念に対処しない限り、破壊的変更のない新機能とバグ修正。
安定	`1.1.1`	`1.1.2`	重要な製品のバグ、法的、セキュリティ、プライバシーに関する懸念に対処しない限り、新機能のないバグ修正や破壊的変更。
プレビュー	`X.Y.1-rc`	`X.Y.2-rc`	新しいプレビュー機能とバグ修正。 (メジャーバージョンがバンプされた場合、破壊的変更が含まれます)。

重大な変更

セキュリティに優先順位を付け、機能を強化し、コードの品質を維持するために、新しいバージョンのソフトウェアには破壊的変更が含まれる場合があります。これらの変更は、慎重なアーキテクチャの選択によって最小限に抑えるように努めていますが、引き続き発生する可能性があります。このような場合は、それらを発表し、可能な解決策を提供することを優先します。

Von Bedeutung

変更が重大でないと見なされた場合、または重大な製品のバグや法的、セキュリティ、プライバシーに関する懸念に対処するために行われている破壊的変更である場合は、事前の通知なしに変更を行う場合があります。

破壊的変更とは

破壊的変更とは、中断を防ぐためにアプリケーションを更新する必要がある変更です。データ API ビルダーでは、破壊的変更には、REST API コントラクトの変更、GraphQL スキーマの生成、互換性と機能に影響するその他の要素が含まれる場合があります。

破壊的変更の例

次の例は、Data API ビルダーに対する重大な変更の 完全な 一覧です。

REST API コントラクトの変更
GraphQL スキーマ生成の変更
下位互換性に影響する変更
API またはパラメーターの削除または名前変更
エラーコードの変更
アクセス許可定義機能の調整
許可されたパラメーター、要求フィールド、または応答フィールドの削除
既定値のない必須パラメーターまたは要求フィールドの追加
目的の API エンドポイント機能に対する変更

非改行変更の定義

重大 でない変更 とは、中断を引き起こさずにアプリケーションに統合できる変更のことです。通常、非改行の変更は実装後に伝達されます。アプリケーションは、事前の通知なしにこれらの変更を処理するように設計する必要があります。

破壊的変更以外の例

次の例は、Data API ビルダーに対する非改行の変更の一覧です。

新しいエンドポイントの概要
既存のエンドポイントへのメソッドの追加
応答と要求に新しいフィールドを組み込む
応答内のフィールド順序の調整
省略可能な要求ヘッダーの概要
データ長と応答サイズの変更
エラーメッセージとコードの変更
HTTP 応答コードの修正
生成された OpenAPI ドキュメントの追加メタデータ

破壊的変更を伝える方法

重大な変更について迅速にお知らせすることが優先されます。破壊的変更通知は、GitHub の Data API Builder リリースのリリースノートと、専用の破壊的変更リストの記事で確認できます。

現在の破壊的変更リスト

この記事では、破壊的変更と機能の廃止についてお知らせします。

現時点では、重大な変更はありません