Değişiklik günlüğü ve kullanımdan kaldırma politikası

Kullanımdan kaldırma politikası#

• 12 ay önceden bildirim. Kırıcı bir değişiklik, duyurulduğu tarihten en az on iki ay sonra yürürlüğe girer. Kırıcı sayılanlar: bir ucun ya da alanın kaldırılması, bir alanın türünün ya da anlamının değişmesi, yeni bir zorunlu parametre ve mevcut bir isteğin artık hata vermesi. Bildirim süresi beklenmeden yürürlüğe giren istisna iki ölçütten birine dayanır: mevzuat ve uyum (mevcut davranışın yanlış bir hukuki sonuç doğurması) ya da güvenlik ve gizlilik. İstisna gerekirse gerekçesi günlükte yazılır. Yalnız alan eklenen sürümler kırıcı değildir ve bildirim süresi gerektirmez.
• Deprecation ve Sunset başlıkları. Kullanımdan kaldırılan bir uç ya da alan, duyurulduğu günden itibaren her yanıtında Deprecation: true ve Sunset başlıklarını taşır. Sunset, kapanış tarihini RFC 8594 biçiminde verir (örneğin Mon, 04 Jan 2027 00:00:00 GMT). Deprecation tarih taşımaz, yalnız bayraktır. Bu başlıkları kendi istemcinizin günlüğüne yazarsanız kapanışı bu sayfayı izlemeden de görürsünüz.
• Sessiz davranış değişikliği yapılmaz. Yanıtın anlamını değiştiren her değişiklik bu sayfada duyurulur.
• Şunlar kırıcı sayılmaz, istemciniz bunlara dayanıklı olmalıdır: yanıta yeni bir alan eklenmesi, yeni bir uç ya da yeni bir isteğe bağlı parametre, mevcut bir sözlüğe (örneğin status_detail) yeni bir değer girmesi, hata mesajının metninin değişmesi. Bilinmeyen alanları yok sayın, bilinmeyen kodları “diğer” olarak işleyin.
• Yol sürümlenir. Uyumsuz bir sözleşme /v1 yolunu değiştirmez, /v2 olarak yayımlanır.

Bugüne kadar kullanımdan kaldırılmış bir uç ya da alan yoktur. Olduğunda burada, kaldırma tarihiyle birlikte yazılır ve kayıt silinmez.

Günlük#

Henüz kırıcı bir değişiklik olmadı. Olduğunda burada, sözleşmenin info.version alanındaki sürüm numarasıyla duyurulur; en yeni sürüm üstte durur.