Skip to main content

Module problem

Module problem 

Source
Expand description

RFC 9457 problem details, the error body of every JMAP HTTP resource.

RFC 8620 §3.6.1 sends request-level errors as problem details (citing RFC 7807, which RFC 9457 obsoletes). draft-atwood-jmap-updates-00 §7.2 asks that every JMAP HTTP resource do the same on a 4xx or 5xx: the Session resource, the API, upload, download, the event source, the WebSocket opening handshake, and the resources extensions add. Types that JMAP registers carry the urn:ietf:params:jmap:error: prefix (RFC 8620 §9.5); a problem with no specific type uses about:blank (RFC 9457 §4.2.1).

title and detail are display text: a server MAY localize them from Accept-Language and then labels the response with Content-Language. Clients act on ProblemDetails::problem_type and the HTTP status, never on title or detail.

Structs§

ProblemDetails
An RFC 9457 problem details object, with the limit member RFC 8620 §3.6.1 adds for limit errors.

Constants§

ABOUT_BLANK
The type of a problem with no more specific type (RFC 9457 §4.2.1): its title should be the HTTP status phrase.
JMAP_ERROR_URN_PREFIX
The prefix of JMAP problem type URIs (RFC 8620 §9.5: the JMAP Error Codes registry).
PROBLEM_JSON
The media type of a problem details body (RFC 9457 §3).