/v1 är application/problem+json (RFC 9457) med en fast uppsättning fält:
code, aldrig på detail – code är ett stabilt maskinkontrakt, medan detail är avsett för människor och kan ändras. param finns med när felet kan hänföras till en specifik begäranparameter. Ange request_id när du kontaktar supporten.
Felkoder
Uppsättningen koder är sluten: nya koder innebär en ändring av det offentliga kontraktet och tillkännages i API:ets ändringslogg. Ett
retryable: true-svar innebär att tillståndet kan komma att upphöra, men det bevisar inte att en skrivåtgärd saknade effekt. Försök läsningar igen med en begränsad budget för antal försök och tid, exponentiell backoff och jitter. Beakta Retry-After när den finns, även vid ett 409 eller 429 som kan försökas igen.
För mutationer gäller operationens dokumenterade kontrakt för idempotens och återhämtning. Behåll den ursprungliga nyckeln och begäran när det stöds. Skapa inte en ny nyckel efter en timeout eller 5xx: det kan upprepa en lyckad skrivåtgärd. En Idempotency-Key-header ger inget skydd för en operation som inte stöder den.