باختصار#
رقم الإصدار الرئيسي في المسار: /v<n>/<endpoint>. التغيير الذي قد يكسر عميلاً يعمل يحتاج إلى إصدار رئيسي جديد، ويبقى الإصدار الرئيسي الموقوف متاحاً 30 يوماً بعد أن تعتمد المنصة إيقافه.
ما الذي يُعدّ كاسراً#
لأن «كاسر» كلمة يختلف الناس عليها، هذا هو التعريف المكتوب.
ليس كاسراً: قد يحدث بلا إشعار
- حقل جديد في الرد
- قيمة
enumجديدة في حقل اختياري - ترويسة جديدة
- تغيّر ترتيب الحقول
- تحسّن زمن الاستجابة
- رسالة خطأ أوضح بالـ
codeنفسه
كاسر: يحتاج إلى إصدار رئيسي جديد
- حذف حقل أو إعادة تسميته
- تغيير نوع حقل
- تغيير معنى قيمة قائمة
- تشديد التحقق على مُدخَل
- حذف قيمة
enum - تغيير رمز الحالة لحالة قائمة
كيف يعمل الإيقاف اليوم#
يبقى الإصدار الرئيسي الموقوف متاحاً 30 يوماً بعد أن تعتمد المنصة إيقافه. ويُخطَر المشتركون عند اعتماده. وبعد تاريخ الإزالة تُزال مسارات الإصدار وتردّ البوابة بـ 404.
إشعار لا يقل عن 90 يوماً، وترويستا Deprecation وSunset على الإصدار القديم، وإبقاء مساراته حتى تاريخ الإيقاف النهائي؛ ونشر القائمتين أعلاه ضمن إرشادات تصميم الواجهات.
ذات صلة#
- أنشئ إصداراً وأوقف آخر: جهة المزوّد.
- الأحداث والإشعارات