Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Sürümleme

Bu sayfa, Open Play’de karşılaşacağınız sürüm numaralarını (API yolu, protokol, eklenti şeması, SDK) ve bir uç ya da işlem kullanımdan kalkarken sunucunun size nasıl haber verdiğini anlatır. Önemli: yazılı bir kırıcı değişiklik ve kaldırma politikası henüz yok; aşağıda yalnız bugün kodda olan davranış anlatılır.

Hangi sürüm neyi söyler

SürümNerede görünürAnlamı
API yolu /v1Tüm uç yollarıTek yol sürümü; /v2 yoktur
Realtime protocolVersionHer çerçevede (1)Soket protokolü ana sürümü; farklı değer UnsupportedProtocol alır
Eklenti protocolVersionŞema belgesi (1)Eklenti sözleşmesinin ana sürümü
codecProfileŞema belgesi (plugin-v1-decimal-int64)Tel kodlaması; şimdilik tek profil
Eklenti versionŞema belgesi (ör. 1.44.0)Eklentinin sürüm metni
schemaVersionHer işlem ve mesaj tanımı; x-crx-schema-version başlığıTek bir mesajın şema sürümü (pozitif tam sayı)
schemaSha256Şema belgesiŞemaların özeti; sabitleme anahtarı (bağlamalar)
SDK sürümüPaket sürümüTypeScript @ferdiunal/open-play-ts (0.x), Unity com.openplay.sdk (0.x)

/v1 ve sunucu sürümü

Tüm HTTP uçları /v1 altındadır. Sunucunun ayrı bir “API sürüm” başlığı yoktur; hangi uçların var olduğunu uç nokta referansı ve (çekirdek REST için) GET /openapi.json gösterir. /openapi.json elle derlenmiş, çekirdek REST’i kapsayan bir belgedir: eklentileri, WebSocket’leri ve panel API’sini kapsamaz ve her uç için tam olmayabilir.

Protokol sürümü

Realtime çerçevelerinde protocolVersion: 1 zorunludur; başka değer UnsupportedProtocol hatası alır ve soket kapanır. İstemciniz bu hatayı alırsa yeniden denemek yerine kullanıcıdan güncelleme isteyin (TypeScript SDK’sı bu durumda upgradeRequired durumuna geçer).

Eklenti şema sürümleri

Bir eklenti şeması iki düzeyde sürümlenir:

  1. İşlem/mesaj düzeyi schemaVersion: her istekte x-crx-schema-version ile bildirilir. Sunucunun bildiğinden farklı bir sürüm gönderirseniz 400 invalid_argument alırsınız.
  2. Belge düzeyi schemaSha256: şemalarda herhangi bir değişiklik özeti değiştirir. İstemcinizi bu özete sabitlersiniz.

Sürüm metni (1.44.0) bilgilendiricidir; uyumluluk kararını özetle verin. Eklenti sürümünü ve özet eşleşmesini nasıl doğrulayacağınız için bağlamalar.

Kullanımdan kalkma (Deprecation)

Bir uç ya da işlem kullanımdan kalkarken çalışmaya devam eder; davranışı, durum kodları ve gövdesi değişmez. Kalkış size şu işaretlerle bildirilir:

İşaretNerede
Deprecation: @<unix saniye> yanıt başlığı (RFC 9745)Kullanımdan kalkan her yanıtta (başarılı ya da hatalı)
OpenAPI deprecated: true/openapi.json içindeki ilgili işlemde
Şema belgesinde deprecated nesnesiEklenti işlemlerinde: since (sürüm metni), sinceUnixS ve replacement (yerine geçen yüzeyin kısa adı)
SDK’da @deprecatedÜretilen TypeScript bağlamasında ilgili işlem

Bugün kullanımdan kalkanlar:

YüzeyBaşlık değeriYerine
/v1/auth/organization/* (oyuncu organizasyonları, 19 uç)@1793491200 (2026-11-01 UTC)Yok; organizasyon özelliği kullanımdan kalkıyor, stüdyo kavramıyla karıştırmayın
package-ride eklentisinin günlük skor sorguları (getDailyBoard, getLeaderboard)@1793577600 (2026-11-02 UTC)Çekirdek skor tablosu (“Günlük kazanç”)
package-ride operatör oyuncu görünümü (operatorPlayer, operatorPlayers)@1793577600Çekirdek karakter profili ve listesi

Başlığın değeri, kullanımdan kalkmanın başladığı anı (UTC unix saniyesi) verir; bir kaldırma tarihi vermez. Yanıtta Sunset başlığı yoktur.

Uyarı

Kaldırma tarihi, minimum duyuru süresi ya da “kullanımdan kalkan uç en az N ay çalışır” gibi bir söz yoktur. Kullanımdan kalkan bir yüzeye yeni bağımlılık eklemeyin ve Deprecation başlığını görünce geçiş planı yapın. Başlığı günlüğünüzde izlemek için yanıt başlıklarını kaydedin.

SDK sürümleri

  • TypeScript SDK’sı 0.x sürümlerindedir; 0.x sürümler arasında kırıcı değişiklik olabilir. Her sürümün değişikliklerini paketin değişiklik günlüğünden ve sürüm notlarından izleyin; sürümü tam (0.1.15 gibi) sabitleyin, ^ aralığı kullanmayın.
  • Unity SDK’sı 0.1.0 sürümündedir ve yalnız Unity 6000.6.7f1 ile doğrulanmıştır (Unity SDK).
  • SDK ve sunucu birlikte gelişir: yeni bir SDK özelliği (ör. skor tablosu, mağaza), o özelliği taşıyan sunucu sürümünü gerektirir. SDK’yı sunucudan önce güncellemeyin.
  • Eklenti bağlamalarında uyum, SDK sürümüne değil schemaSha256 sabitlemesine bağlıdır (bağlamalar).

Ne yapmalı

  1. SDK sürümünüzü ve eklenti schemaSha256 değerlerinizi sürüm manifestinize yazın.
  2. Her sunucu güncellemesinden sonra şema belgesini karşılaştırın ve gerekirse bağlamayı yeniden üretin.
  3. Deprecation başlığı gören her çağrı için geçiş işi açın.
  4. Realtime ve eklenti protokol sürümü uyuşmazlığında kullanıcıdan güncelleme isteyin; yeniden deneme döngüsü kurmayın.