Skip to content

Commit

Permalink
Merge branch 'master' of github.com:hapijs/hapi
Browse files Browse the repository at this point in the history
  • Loading branch information
hueniverse committed Sep 1, 2016
2 parents 63f7d89 + f502385 commit 2ec641a
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -617,10 +617,11 @@ The `scheme` method must return an object with the following keys:

When the scheme `authenticate()` method implementation calls `reply()` with an error condition,
the specifics of the error affect whether additional authentication strategies will be attempted
if configured for the route. If the `err` returned by the `reply()` method includes a message, no
(if configured for the route). If the `err` passed to the `reply()` method includes a message, no
additional strategies will be attempted. If the `err` does not include a message but does include
a scheme name (e.g. `Boom.unauthorized(null, 'Custom')`), additional strategies will be attempted
in order of preference.
the scheme name (e.g. `Boom.unauthorized(null, 'Custom')`), additional strategies will be attempted
in the order of preference (defined in the route configuration). If authentication fails the
scheme names will be present in the 'WWW-Authenticate' header.

When the scheme `payload()` method returns an error with a message, it means payload validation
failed due to bad payload. If the error has no message but includes a scheme name (e.g.
Expand Down Expand Up @@ -2987,7 +2988,7 @@ Each request object includes the following properties:
[Path parameters](#path-parameters).
- `paramsArray` - an array containing all the path `params` values in the order they appeared in
the path.
- `path` - the request URI's path component.
- `path` - the request URI's [pathname](https://nodejs.org/api/url.html#url_urlobject_pathname) component.
- `payload` - the request payload based on the route `payload.output` and `payload.parse` settings.
- `plugins` - plugin-specific state. Provides a place to store and pass request-level plugin data.
The `plugins` is an object where each key is a plugin name and the value is the state.
Expand Down

0 comments on commit 2ec641a

Please sign in to comment.