Adopt Problem Detail as Our Standard

Date: 2024-05-10

Status

Accepted

Context

We have been using different formats for error responses across our APIs. This inconsistency makes it difficult for clients to handle errors effectively. We need a standard format for error responses that is flexible enough to accommodate a variety of error types.

Decision

We have decided to adopt the Problem Detail standard for our APIs. Problem Detail is a standard that provides a consistent format for error responses. It includes fields for a title, status, detail, and instance, along with the ability to include additional custom fields as needed.

Consequences

Adopting the Problem Detail standard will result in more consistent error responses across our APIs. Clients will be able to handle errors more effectively and with less confusion. However, existing clients may need to be updated to handle the new error format.

References

• RFC 7807: Problem Details for HTTP APIs (https://tools.ietf.org/html/rfc7807)