ポリシー

警告

以下のポリシーは、General Availabilityバージョンのリリース以降から適用されます。

下位互換性

API が継続的に改善されるにつれて、同じ API の仕様が一部異なる場合が存在します。

代表的にEnum値が追加される場合が存在することがあります。このような変更に対する影響はユーザーによって影響が異なり、場合によっては、一般的な動作だけでなく、バグまで再現してほしい場合が発生することがあります。

これにより、Delivery Trackerは下位互換性を保証し、API変更によるユーザーの影響範囲を減らすため、API Version Request Headerを提供しています。

別途定義されていない場合、latest-stable のバージョンとみなされます。

trackql-api-version: latest-stable

注意事項

TrackQL は配信トラッカーCloudシステムのコードネームです。

Backward Compatibilityの提供範囲は、ユーザーが使用しているService Planによって違いがあり、General Availabilityリリース前のPreview期間にはlatest-stableのみ提供されます。

[TBA - 詳細はcontact@tracker.delivery までお問い合わせください]

警告

既存のAPI仕様に定義されているが、あまり使用されていない仕様が存在する場合があります。この場合、今後使用される可能性がありますので、実装時にご注意ください。 (例：TrackStatusCode.UNKNOWNがよく使われないが、実装が欠落している場合、上位互換性に問題がある)

Deprecated予定となったAPIの場合、一般的な場合、発表時点から1年後に削除することを基準にしています。この時点は、サービスの安定性、使用量などにより、事前告知後に変動する可能性があります。

Experimental APIの場合、上記のPolicyとは別に、別途案内なしにいつでも修正/追加/削除することができます。