Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Carmine DiMascio committed Feb 13, 2020
1 parent c568111 commit 34ea5e3
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -535,10 +535,17 @@ Determines whether the validator should validate securities e.g. apikey, basic,

Defines the base directory for operation handlers. This is used in conjunction with express-openapi-validator's OpenAPI vendor extensions.

- `string` - the base directory containing operation handlers
- `false` - (default) do not validate security

```
ignorePaths: 'operations/base/path
operationHandlers: 'operations/base/path'
```

**Note** that the `x-eov-operation-handler` OpenAPI vendor extension specifies a path relative to `operationHandlers`. Thus if `operationHandlers` is `/handlers` and an `x-eov-operation-handler` has path `routes/ping`, then the handler file `/handlers/routes/ping.js` (or `ts`) is used.

Complete example [here](https://github.com/cdimascio/express-openapi-validator/tree/master/examples/2-eov-operations)

**api.yaml**

```yaml
Expand Down

0 comments on commit 34ea5e3

Please sign in to comment.