Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cdimascio committed Oct 10, 2020
1 parent cae389c commit 8e9678d
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Expand Up @@ -696,15 +696,6 @@ Specifies the options to passthrough to multer. express-openapi-validator uses m
}
```

### 鈻笍 coerceTypes (optional) - _deprecated_

Determines whether the validator should coerce value types to match the type defined in the OpenAPI spec.

_Applies **only** to path params, query string, headers, and cookies.

- `true` (**default**) - coerce scalar data types.
- `"array"` - in addition to coercions between scalar types, coerce scalar data to an array with one element and vice versa (as required by the schema).

### 鈻笍 \$refParser.mode (optional)

Determines how JSON schema references are resolved by the internal [json-schema-ref-parser](https://github.com/APIDevTools/json-schema-ref-parser). Generally, the default mode, `bundle` is sufficient, however if you use [escape characters in \$refs](https://swagger.io/docs/specification/using-ref/), `dereference` is necessary.
Expand All @@ -722,6 +713,15 @@ $refParser: {
}
```

### 鈻笍 coerceTypes (optional) - _deprecated_

Determines whether the validator should coerce value types to match the those defined in the OpenAPI spec. This option applies **only** to path params, query strings, headers, and cookies. _It is **highly unlikley** that will want to disable this. As such this option is deprecated and will be removed in the next major version_


- `true` (**default**) - coerce scalar data types.
- `"array"` - in addition to coercions between scalar types, coerce scalar data to an array with one element and vice versa (as required by the schema).


## The Base URL

The validator will only validate requests, securities, and responses that are under
Expand Down

0 comments on commit 8e9678d

Please sign in to comment.