「破壊的な変更」とは具体的には何か
「破壊的な変更」について、その概念は理解が難しいものではないが、具体的な実例としてクラウドサインの WEBAPI 利用ガイドでの記述が分かりやすかったため引用する。
クラウドサインは顧客向けに WEBAPI をサービスとして提供しており、これを利用している顧客に対して、「破壊的な変更の定義はこれで、その場合事前に告知します。」と明文化している。誤解する余地が少なくすごく良い利用ガイドだと思った。
クラウドサイン Web API を便利にご利用いただくために、日々機能追加・機能変更が行われております。破壊的な変更を行う際には、事前にいただいている技術担当者の方に 1 ヶ月以上前に E メールにてご連絡差し上げます。なお、破壊的な変更とは以下を指します。リクエスト
- URL の廃止・変更
- HTTP メソッドの廃止・変更
- 必須パラメータ・ヘッダの追加
- パラメータの解釈の変更
レスポンス
- メンバー削除
- メンバーの型変更
一方、以下の場合は破壊的な変更とはせず、随時リリースを行います。リクエスト
- URL の追加
- HTTP メソッドの追加
- オプションパラメータ（未指定の場合にはこれまでと挙動を変えない）の追加
レスポンス
- メンバーの追加