OCAPI バージョン管理と廃止予定ポリシー 23.1

このドキュメントでは、Open Commerce API (OCAPI) のバージョン管理と廃止予定ポリシーを説明します。このポリシーは以下の目的で策定されています:

  • 顧客とデベロッパーが簡単に理解できる
  • Commerce Cloud Digital が既存のクライアントアプリケーショに影響を与えずに、API の仕様変更を行う
  • 古くなった機能またはサポートされていない機能を Digital から削除する

Digital が次を行うたびに、新しい OCAPI バージョンが作成されます:

  • 新しいドキュメントプロパティ、リソースパラメーター、またはリソースの追加。
  • ドキュメントプロパティ、リソースパラメーター、またはリソースのタイプの変更。
  • ドキュメントプロパティ、リソースパラメーター、またはリソースの名前の変更。
  • ドキュメントプロパティ、リソースパラメーター、またはリソースの削除。

Digital は新しい OCAPI バージョンを作成するたびに、以前の OCAPI バージョンを廃止予定にします。これにより、顧客とデベロッパーには以下が推奨されます:

  • 現在の OCAPI バージョン上に新しいクライアントアプリケーションを実装する。
  • 既存のアプリケーションを定期的に更新する。

Digital では、現在の年の最後の 2 桁 (2013 年の場合は "13") の後にピリオド (.) を追加し、次に 1 から始まる連続番号を加えることによって、OCAPI バージョン番号を作成します。たとえば、"13.1" は 2013 年の最初のバージョンです。

コンテキストに応じてバージョン番号の指定方法が異なります。

  • URL では次の構文が使用されます: v<year>_<consecutive number>。例: "v13_1"。
  • ドキュメントでは次の構文が使用されます: <year>.<consecutive number>。例: "13.1" です。
バージョンの状態サポート説明
最新はい最新バージョンです。常に現在のバージョンを使用して新しいアプリケーションを開発してください。Commerce Cloud は OCAPI バージョンを最低 2 年間サポートします。Digital はこの期間中、バージョンに含まれる機能セットの安定性と旧バージョンとの互換性を保証します。
廃止予定はいDigital は OCAPI バージョンを廃止予定にし、新しいバージョンを公開します。サポート、安定性、旧バージョンとの互換性は、公開日から最高 2 年間保証されます。
廃止済みいいえ廃止予定バージョンは、公開から 2 年後に自動的に廃止されます。Digital は通知なしに廃止バージョンを削除します。

現在 OCAPI バージョンのメタデータは、バージョン番号のリストのみを提供しています。バージョンのライフサイクルをよりよく反映するために、バージョンのメタデータは次のように強化されます:

  • state 列挙型が、current、deprecated、obsolete の値とともに追加されます。

Digital は XChange ポータルと Digital リリースノートで、新しいバージョンと廃止バージョンについて顧客に通知します。