From 35cad4681a5adceefc753a2df0d735cfaf6df941 Mon Sep 17 00:00:00 2001 From: Carmine DiMascio Date: Sat, 6 Mar 2021 21:04:13 -0500 Subject: [PATCH] doc: update README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 7ab1df33..72da1d19 100644 --- a/README.md +++ b/README.md @@ -684,6 +684,8 @@ Determines whether the validator should validate securities e.g. apikey, basic, Determines whether the validator should validate the OpenAPI specification. Useful if you are certain that the api spec is syntactically correct and want to bypass this check. +*Warning:* e certain your spec is valid. And be sure you know what you're doing! express-openapi-validator _*expects*_ are valid spec. If incorrect, the validator will behave erradically and/or throw Javascript errors. + - `true` (**default**) - validate the OpenAPI specification. - `false` - do not validate the OpenAPI specification.