Skip to content

Commit

Permalink
defaultTags
Browse files Browse the repository at this point in the history
  • Loading branch information
z0mt3c committed Aug 17, 2015
1 parent b992b0f commit d93c5f9
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ npm install hapi-swaggered-ui
* `defaultValue`: string, default value of the api-key field
* `placeholder`: string, placeholder of the api-key field
* `auth`: object, auth options as specified in [route options (hapi docs)](https://github.com/hapijs/hapi/blob/master/API.md#route-options), will be applied to all registered plugin routes

* `defaultTags`: array of strings, will be passed to the specs endpoint through the query param 'tags' ([hapi-swaggered feature: tag filtering](https://github.com/z0mt3c/hapi-swaggered#tag-filtering))

## Example
Since [hapi-swaggered](https://github.com/z0mt3c/hapi-swaggered) exposes its plugin configuration hapi-swaggered-ui should find it's swagger endpoint automatically. In case you want to use hapi-swaggered-ui without hapi-swaggered (or the auto-detection doesn't work) you can manually set the swagger endpoint by the swaggerEndpoint option. In addition the page title can be changed through the option title.
Expand Down
1 change: 1 addition & 0 deletions lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ var packageInfo = require('../package.json')

var optionsSchema = Joi.object({
title: Joi.string().required(),
defaultTags: Joi.array().items(Joi.string()).optional(),
path: Joi.string().optional(),
basePath: Joi.string().optional(),
swaggerEndpoint: Joi.string().optional(),
Expand Down

0 comments on commit d93c5f9

Please sign in to comment.