Skip to content

Commit

Permalink
Merge pull request #3131 from wprl/patch-1
Browse files Browse the repository at this point in the history
Improve wording of auth strategy mode/default
  • Loading branch information
hueniverse committed May 21, 2016
2 parents bc132b3 + c0d2617 commit 4657e34
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -649,10 +649,10 @@ Registers an authentication strategy where:
- `name` - the strategy name.
- `scheme` - the scheme name (must be previously registered using
[`server.auth.scheme()`](#serverauthschemename-scheme)).
- `mode` - if `true`, the scheme is automatically assigned as a required strategy to any route
without an `auth` config. Can only be assigned to a single server strategy. Value must be `true`
- `mode` - defaults to `false`. If set, the value must be `true`
(which is the same as `'required'`) or a valid authentication mode (`'required'`, `'optional'`,
`'try'`). Defaults to `false`.
`'try'`). If set to a value other than `false`, the scheme is automatically assigned as the default strategy for any route
without an `auth` config. Can only be assigned to a single server strategy.
- `options` - scheme options based on the scheme requirements.

```js
Expand Down

0 comments on commit 4657e34

Please sign in to comment.