Geliştirici Portalı
Çağla Cabaoğlu Gallery API Versioning & Deprecation Policy
Bu sayfa, Çağla Cabaoğlu Gallery REST API'si ve MCP sunucusunun nasıl sürümlendiğini ve bir uç noktanın ne zaman, nasıl kullanımdan kaldırılacağını tanımlar. Ajanlar bu taahhüde güvenerek entegrasyon kurabilir.
1. Sürümleme
- Sürüm, URL yolunda taşınır: /api/v1/... Geçerli kararlı sürüm v1'dir.
- Her /api/v1 yanıtı X-API-Version: v1 başlığını döndürür.
- Geriye dönük uyumlu eklemeler (yeni alanlar, yeni uç noktalar) v1 içinde yapılır ve sürüm numarasını değiştirmez. İstemciler bilinmeyen alanları yok saymalıdır.
- Kırıcı değişiklikler yeni bir yol sürümü (/api/v2) altında yayımlanır; v1 aşağıdaki bildirim süresi boyunca çalışmaya devam eder.
- MCP sunucusu protokol sürümlerini MCP-Protocol-Version başlığıyla görüşür ve desteklenmeyen bir sürüm için 400 döndürür.
2. Kullanımdan Kaldırma Nasıl Bildirilir
- Uç nokta, RFC 9745 uyarınca Deprecation: true başlığını döndürmeye başlar.
- Yanıt, politika sayfasına ve halefine bağlantı verir: Link: </docs/deprecation-policy>; rel="deprecation" ve Link: </api/v1>; rel="successor-version".
- Kaldırma tarihi belirlendiğinde, RFC 8594 Sunset başlığı HTTP tarih biçiminde eklenir ve kaldırmadan en az 6 ay önce yayımlanır.
- Aynı bilgi openapi.json içinde deprecated: true ve x-sunset alanlarıyla, ayrıca /.well-known/api-catalog linkset belgesinde yayımlanır.
- Kaldırıldıktan sonra uç nokta 410 Gone döndürür ve halefine bağlantı verir.
3. Şu Anki Durum
| Yüzey | Durum | Sunset | Halefi |
|---|---|---|---|
| /api/v1/* | Kararlı | — | — |
| /api/mcp | Kararlı | — | — |
| /api/llm/* | Kullanımdan kaldırıldı | Henüz duyurulmadı | /api/v1/* |
Kullanımdan kaldırılmış uç noktalar çalışmaya devam eder. Bir Sunset tarihi duyurulmadan hiçbir uç nokta kaldırılmaz.
4. Değişiklikleri İzleme
Ajanlar her yanıtta Deprecation ve Sunset başlıklarını kontrol etmelidir. Kurumsal entegrasyonlar için önceden bildirim listesine katılmak üzere bize yazın: contactgallery@caglacabaoglu.com.