Skip to content

Commit

Permalink
Merge pull request #116 from ngot/fix-documentation
Browse files Browse the repository at this point in the history
fix documentation
  • Loading branch information
ngot authored Nov 16, 2021
2 parents c741b93 + fc66894 commit 977bdfd
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .changeset/chilled-donuts-sneeze.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"koa-oas3": patch
---

fix documentation
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ app.listen(8080);
* `validateResponse`:(default: false) - Validate response against Openapi schemas
* `validatePaths`:(default ['/']) - Only endpoints starting with the values specified here will be validated
* `swaggerUiBundleBasePath`: (default use swagger-ui-dist from [unpkg](https://unpkg.com/)) - [swaggerUiAssetPath](https://www.npmjs.com/package/swagger-ui-dist) needed for loading the swagger-ui
* `validationOptions`: Optional - options for sending to oas3-chow-chow/AJV
* `oasValidatorOptions`: Optional - options for sending to oas-validator. https://github.com/Mermade/oas-kit/blob/main/docs/options.md
* `qsParseOptions: { [key: string]: any}`: Optional - Options to be passed to the [query string](https://github.com/ljharb/qs) parse command. Default: `{ comma: true }`
* `errorHandler: (error: Error, ctx: Context) => void,`: Optional - custom error hanlder.
* `requestBodyHandler: { [key: string]: koa.Middleware }`: Optional - custom body handler. Defaults:
Expand Down

0 comments on commit 977bdfd

Please sign in to comment.