/v1 ist application/problem+json (RFC 9457) mit einem festen Satz an Feldern:
code, niemals anhand von detail – code ist ein stabiler maschinenlesbarer Vertrag; detail ist für Menschen lesbar und kann sich ändern. param ist vorhanden, wenn der Fehler einem bestimmten Anfrageparameter zugeordnet werden kann. Geben Sie request_id an, wenn Sie sich an den Support wenden.
Fehlercodes
Die Menge der Codes ist abgeschlossen: Neue Codes stellen eine Änderung des öffentlichen Vertrags dar und werden über das API-Changelog angekündigt. Eine
retryable: true-Antwort bedeutet, dass sich die Bedingung möglicherweise von selbst auflöst; sie belegt nicht, dass ein Schreibvorgang keine Auswirkung hatte. Wiederholen Sie Lesevorgänge mit einem begrenzten Versuchs- und Zeitbudget, exponentiellem Backoff und Jitter. Beachten Sie Retry-After, sofern vorhanden, auch bei einem wiederholbaren 409 oder 429.
Befolgen Sie bei Mutationen den dokumentierten Idempotenz- und Wiederherstellungsvertrag des jeweiligen Vorgangs. Behalten Sie, sofern unterstützt, den ursprünglichen Schlüssel und die ursprüngliche Anfrage bei. Erzeugen Sie nach einem Timeout oder 5xx keinen neuen Schlüssel: Dadurch könnte ein erfolgreicher Schreibvorgang wiederholt werden. Ein Idempotency-Key-Header bietet bei einem Vorgang, der ihn nicht unterstützt, keinen Schutz.