Record

The thing asked for is not there, as far as the caller may know. 404.

Pattern

record.*

Raised with

fail()

Intents

Statuses

404

View as Markdown

Intents

record.missing404

The thing does not exist, or the caller may not know it does

Raising one

Name what went wrong. The intent sets the status, the message the caller sees, and any log it writes.

// The thing does not exist, or the caller may not know it does
return fail('record.missing', 'Profile not found.');

The caller gets (record.missing)

Terminal

HTTP 404

{
  "ok": false,
  "error": "Profile not found.",
  "code": "record.missing"
}

Is it a record error?

Find the row that describes your case, and use the domain on the right.

If the problem is
Use
The caller’s request was wrong: unreadable, incomplete, or a value that breaks a rule. 400 or 422.
request.*
No valid credentials: nobody signed in, an expired session, a bad token or secret. 401.
auth.*
Valid credentials, but not allowed to do this. 403.
permission.*
The thing asked for is not there, as far as the caller may know. 404.
record.* this page
The request clashes with the current state: it already exists, or it is not possible yet. 409.
conflict.*
Too many requests, or an allowance used up. 429.
limit.*
Our fault or a dependency’s. The caller sees a generic message; the details are logged. 5xx.
failure.*

For registry authors

Starter intents. These are the intents prongs add errors puts in your registry, raised with fail(). Change the messages to suit your app, and the statuses through the status.* intents they are built from.