Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions api-design/errors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -172,11 +172,11 @@ up) but it _can_, and that covers the "link to documentation" requirement too.

![API Documentation for the SignatureAPI, with an explanation of what the error is, what happened, and how to fix it](./assets/errors-documentation.png)

Why have both a `title` and a `description`? This allows the error to be used in
Why have both a `title` and a `detail`? This allows the error to be used in
a web interface, where certain errors are caught and handled internally, but
other errors are passed on to the user to help errors be considered as
functionality instead of just "Something went wrong, erm, maybe try again or
phone us". This can reduce incoming support requests, and allow applications to
phone us". As per RFC 9457, the `title` should be the same for all responses with the same `type`, whereas the `detail` can include details about the specific problem instance/occurrence. This can reduce incoming support requests, and allow applications to
evolve better when handling unknown problems before the interface can be
updated.

Expand Down
Loading