/v1 hata yanıtı, sabit bir alan kümesine sahip application/problem+json (RFC 9457) biçimindedir:
code üzerine kurun, detail üzerine kurmayın — code kararlı bir makine sözleşmesidir; detail ise insan tarafından okunabilir niteliktedir ve değişebilir. param, hata belirli bir istek parametresine atfedilebildiğinde bulunur. Destek ekibiyle iletişime geçerken request_id bilgisini ekleyin.
Hata kodları
Kod kümesi kapalıdır: yeni kodlar genel sözleşmede bir değişiklik anlamına gelir ve API değişiklik günlüğü aracılığıyla duyurulur.
retryable: true yanıtı, durumun kendiliğinden çözülebileceği anlamına gelir; bir yazma işleminin hiçbir etkisinin olmadığını kanıtlamaz. Okuma isteklerini sınırlı sayıda deneme ve sınırlı bir süre bütçesiyle, üstel geri çekilme (exponential backoff) ve jitter kullanarak yeniden deneyin. Yeniden denenebilir bir 409 veya 429 yanıtı da dahil olmak üzere, Retry-After mevcut olduğunda ona uyun.
Değişiklik yapan işlemlerde, ilgili işlemin belgelenmiş idempotency ve kurtarma sözleşmesini izleyin. Destekleniyorsa özgün anahtarı ve isteği koruyun. Zaman aşımından veya 5xx hatasından sonra yeni bir anahtar üretmeyin: bu, başarılı olmuş bir yazma işleminin yinelenmesine neden olabilir. Idempotency-Key üst bilgisi, bunu desteklemeyen bir işlemde herhangi bir koruma sağlamaz.