Skip to content

Commit

Permalink
fix: docs added for disabled option
Browse files Browse the repository at this point in the history
  • Loading branch information
theoomoregbee committed Jun 25, 2018
1 parent 6b38ae3 commit a5e58a6
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ check the **./swagger/swagger.json** for sample generated swagger documentation
It comes with some default settings which can be override by creating **config/swaggergenerator.js**
```javascript
module.exports["swagger-generator"] = {
disabled: false,
swaggerJsonPath: "./swagger/swagger.json",
parameters: { //we can add up custom parameters here
PerPageQueryParam: {
Expand Down Expand Up @@ -56,6 +57,7 @@ module.exports["swagger-generator"] = {
}
};
```
* **disabled** attribute is used to disable the module. (e.g you may want to disable it on production)
* **swaggerJsonPath** where to generate the `swagger.json` file to, default to `sails.config.appPath + "/swagger/swagger.json"`
* **parameters** we can create your own custom parameter to be referenced by api service methods and it's totally based on swagger specification for parameter object. Any one added here is added to the default parameters which are
```javascript
Expand Down

0 comments on commit a5e58a6

Please sign in to comment.