From 8e9678dff29f25a89cab19442690c83955512c64 Mon Sep 17 00:00:00 2001 From: Carmine DiMascio Date: Fri, 9 Oct 2020 20:55:53 -0400 Subject: [PATCH] Update README.md --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d9283b19..c9f5505a 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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