Skip to content

Commit b823c91

Browse files
committed
fix API documentation
1 parent 199f58c commit b823c91

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,12 +105,12 @@ server.route([
105105
## API
106106
#### Plugin Options
107107

108-
- `client {Object}`: The configuration of [`keycloak-auth-utils`][keycloak-auth-utils] its [`GrantManager`][keycloak-auth-utils-gm].<br/>
108+
- `client {Object}`: The configuration of [`keycloak-auth-utils`][keycloak-auth-utils] its [`GrantManager`][keycloak-auth-utils-gm]. The suggested minimum configuration contains `realmUrl`, `clientId` and `secret`.<br/>
109109
Required.
110110

111-
- `cache {Object|false}`: The configuration of the [hapi.js cache](https://hapijs.com/api#servercacheoptions) powered by [catbox][catbox]. If `false` the cache is disabled. Use an empty object to use the built-in default cache.<br/>
112-
Optional.<br/>
113-
Default: `false`.
111+
- `cache {Object|false}`: The configuration of the [hapi.js cache](https://hapijs.com/api#servercacheoptions) powered by [catbox][catbox].<br/>
112+
If `false` the cache is disabled. Use an empty object to use the built-in default cache.<br/>
113+
Optional. Default: `false`.<br/>
114114

115115
#### `server.kjwt.validate(field <string>, done <Function>)`
116116
Uses internally [`GrantManager.prototype.validateAccessToken()`][keycloak-auth-utils-gm-validate].

0 commit comments

Comments
 (0)