/v1 er application/problem+json (RFC 9457) med et fast sett med felt:
code, aldri på detail – code er en stabil maskinkontrakt, mens detail er menneskelesbar og kan endres. param er til stede når feilen kan tilskrives en bestemt forespørselsparameter. Oppgi request_id når du kontakter support.
Feilkoder
Kodesettet er lukket: nye koder er en endring i den offentlige kontrakten og kunngjøres gjennom API-endringsloggen. Et
retryable: true-svar betyr at tilstanden kan gå over, men det beviser ikke at en skriveoperasjon ikke hadde noen effekt. Prøv lesinger på nytt med et begrenset antall forsøk og en begrenset tidsramme, eksponentiell backoff og jitter. Respekter Retry-After når den er til stede, også ved et 409- eller 429-svar som kan prøves på nytt.
For mutasjoner må du følge operasjonens dokumenterte kontrakt for idempotens og gjenoppretting. Behold den opprinnelige nøkkelen og forespørselen når det støttes. Ikke opprett en ny nøkkel etter en tidsavbrytelse eller 5xx: det kan gjenta en skriveoperasjon som allerede var vellykket. En Idempotency-Key-header gir ingen beskyttelse for en operasjon som ikke støtter den.