update README

cdimascio · Nov 27, 2019 · 6f3ac88 · 6f3ac88
1 parent 23e5c09
commit 6f3ac88
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -313,6 +313,7 @@ new OpenApiValidator(options).install({
   apiSpec: './openapi.yaml',
   validateRequests: true,
   validateResponses: true,
+  ignorePaths: /.*\/pets$/
   unknownFormats: ['phone-number', 'uuid'],
   multerOpts: { ... },
   securityHandlers: {
@@ -389,6 +390,16 @@ Determines whether the validator should validate responses. Also accepts respons
 	}
 	```
 
+### ▪️ ignorePaths (optional)
+
+Defines a regular expression that determines whether a path(s) should be ignored. Any path which matches the regular expression will not be validated.
+
+The following ignores any path that ends in `/pets`
+
+```
+ignorePaths: /.*\/pets$/
+```
+
 
 ### ▪️ unknownFormats (optional)