Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Carmine DiMascio committed Dec 24, 2019
1 parent 59acc38 commit f0c0fc6
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -395,17 +395,17 @@ Determines whether the validator should validate responses. Also accepts respons
- `false` (**default**) - do not validate responses
- `{ ... }` - validate responses with options

**removeAdditional:**
**removeAdditional:**

- `"failing"` - additional properties that fail schema validation are automatically removed from the response.
- `"failing"` - additional properties that fail schema validation are automatically removed from the response.

For example:
For example:

```javascript
validateResponses: {
removeAdditional: 'failing'
}
```
```javascript
validateResponses: {
removeAdditional: 'failing'
}
```

### ▪️ validateSecurity (optional)

Expand Down Expand Up @@ -477,12 +477,13 @@ See this [issue](https://github.com/APIDevTools/json-schema-ref-parser/issues/10

e.g.

````javascript
```javascript
{
$refParser: {
mode: 'bundle'
}
}
```

## The Base URL

Expand All @@ -495,7 +496,7 @@ application. ([More detail about the base URL](https://swagger.io/docs/specifica
```yaml
servers:
- url: https://api.example.com/v1
````
```
The validation applies to all paths defined under this base URL. Routes in your app
that are _not_ under the base URL—such as pages—will not be validated.
Expand Down

0 comments on commit f0c0fc6

Please sign in to comment.