/v1-fejlsvar er application/problem+json (RFC 9457) med et fast feltsæt:
code som grundlag for forgrening, aldrig detail — code er en stabil maskinkontrakt, mens detail er beregnet til mennesker og kan ændres. param er til stede, når fejlen kan henføres til en bestemt forespørgselsparameter. Angiv request_id, når du kontakter support.
Fejlkoder
Kodesættet er lukket: nye koder udgør en ændring af den offentlige kontrakt og annonceres via API-ændringsloggen. Et
retryable: true-svar betyder, at tilstanden kan blive løst; det beviser ikke, at en skriveoperation ikke havde nogen effekt. Gentag læseoperationer med et begrænset antal forsøg og et begrænset tidsbudget, eksponentiel backoff og jitter. Respektér Retry-After, når den er til stede, også ved en 409 eller 429, der kan forsøges igen.
For mutationer skal du følge operationens dokumenterede kontrakt for idempotens og gendannelse. Bevar den oprindelige nøgle og forespørgsel, når det understøttes. Opret ikke en ny nøgle efter en timeout eller 5xx: Det kan medføre, at en vellykket skriveoperation gentages. En Idempotency-Key-header giver ingen beskyttelse ved en operation, der ikke understøtter den.