/v1 đều ở định dạng application/problem+json (RFC 9457) với một tập trường cố định:
code, không dựa trên detail — code là một hợp đồng máy ổn định; detail là nội dung dành cho người đọc và có thể thay đổi. param xuất hiện khi lỗi có thể quy cho một tham số yêu cầu cụ thể. Hãy đính kèm request_id khi liên hệ bộ phận hỗ trợ.
Mã lỗi
Tập mã lỗi là cố định: việc bổ sung mã mới là một thay đổi đối với hợp đồng công khai và sẽ được thông báo qua nhật ký thay đổi của API. Phản hồi
retryable: true cho biết tình trạng lỗi có thể tự khắc phục; điều này không chứng minh rằng thao tác ghi không có tác động nào. Hãy thử lại các thao tác đọc với số lần thử và ngân sách thời gian hữu hạn, cùng cơ chế backoff theo cấp số nhân và jitter. Hãy tuân thủ Retry-After khi có, kể cả với phản hồi 409 hoặc 429 có thể thử lại.
Đối với các thao tác thay đổi dữ liệu, hãy tuân theo hợp đồng về tính idempotent và khôi phục được ghi trong tài liệu của thao tác đó. Hãy giữ nguyên khóa gốc và yêu cầu gốc khi được hỗ trợ. Không tạo khóa mới sau khi hết thời gian chờ hoặc 5xx: làm vậy có thể lặp lại một thao tác ghi đã thành công. Tiêu đề Idempotency-Key không mang lại bất kỳ sự bảo vệ nào trên thao tác không hỗ trợ tiêu đề này.
