Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cdimascio authored Oct 12, 2019
1 parent a5f5da3 commit c3b61bf
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ new OpenApiValidator({ apiSpec }).install(app);

## Options

The options object takes the following form.

```javascript
new OpenApiValidator(options).install({
apiSpec: './openapi.yaml',
Expand All @@ -95,7 +97,9 @@ new OpenApiValidator(options).install({
});
```

**`apiSpec:`** a string value specifying the path to the OpenAPI 3.0.x spec or a JSON object representing an OpenAPI spec.
**Option details:**

**`apiSpec:` _required_** a string value specifying the path to the OpenAPI 3.0.x spec or a JSON object representing an OpenAPI spec.

**`validateRequests:`** enable response validation.

Expand Down

0 comments on commit c3b61bf

Please sign in to comment.