ProblemDetails

An HTTP API's error body, as other APIs often send one.

Use it to read errors from an outside service. In your own routes, declare failures instead.

Shape

Write every field when you build one, and give a field that isn't required as none.

Example

ProblemDetails {    type: none    status: 404    title: "Not Found"    detail: none    instance: none}

Good to know

• == tells you whether two are the same. < and list.sort_by don't take it, so sort by one of its parts instead.

In JSON

An object of its parts, in a request, a response or json.write:

{"type":"https://example.com/probs/out-of-credit","status":403,"title":"You do not have enough credit.","detail":"You have 30 credits, but that costs 50.","instance":"https://example.net/account/12345/msgs/abc"}{"status":404,"title":"Not Found"}{"status":503}

When you read one, a field that isn't required may be left out, or sent as null.

Details