Remove examples from apiDoc when validating requests

[HairyMike]

I'd like to remove the examples from the api doc in the request validator. I don't think they're needed while validating the request.

This could be a way to bypass this weird bug: #773

[josecampana]

meanwhile you merge it, I'm disabling the request validation

[cdimascio]

this will only remove top level examples under components. how are other handled?

[dan-trewin]

this also needs to be applied to openapi.response.validator.ts

[cdimascio]

Merging as is. It will be great to also add this to the response validator as suggested

[dan-trewin]

For anyone else running into this issue, I have a solution that recursively removes all examples keys from the OpenAPI spec for request and response validation. Here is a patch-package solution for anyone wanting to fix this before a PR is approved/merged:

express-openapi-validator+5.0.4.patch

diff --git a/node_modules/express-openapi-validator/dist/middlewares/openapi.request.validator.js b/node_modules/express-openapi-validator/dist/middlewares/openapi.request.validator.js
index e3e8df4..3ef5b30 100644
--- a/node_modules/express-openapi-validator/dist/middlewares/openapi.request.validator.js
+++ b/node_modules/express-openapi-validator/dist/middlewares/openapi.request.validator.js
@@ -7,12 +7,34 @@ const types_1 = require("../framework/types");
 const body_parse_1 = require("./parsers/body.parse");
 const schema_parse_1 = require("./parsers/schema.parse");
 const req_parameter_mutator_1 = require("./parsers/req.parameter.mutator");
+
+function removeExamplesKeys(obj) {
+	if (typeof obj === "object" && obj !== null) {
+		if (Array.isArray(obj)) {
+			obj.forEach(function (item) {
+				removeExamplesKeys(item);
+			});
+		} else {
+			for (var key in obj) {
+				if (key === "examples") {
+					delete obj[key];
+				} else {
+					removeExamplesKeys(obj[key]);
+				}
+			}
+		}
+	}
+}
+
 class RequestValidator {
     constructor(apiDoc, options = {}) {
         this.middlewareCache = {};
         this.requestOpts = {};
         this.middlewareCache = {};
         this.apiDoc = apiDoc;
+        // Examples not needed for validation. The following line is needed to bypass weird "id" example bug. 
+        // See: https://github.com/cdimascio/express-openapi-validator/issues/773 and https://github.com/cdimascio/express-openapi-validator/pull/774
+        removeExamplesKeys(this.apiDoc);
         this.requestOpts.allowUnknownQueryParameters =
             options.allowUnknownQueryParameters;
         this.ajv = (0, ajv_1.createRequestAjv)(apiDoc, Object.assign(Object.assign({}, options), { coerceTypes: true }));
diff --git a/node_modules/express-openapi-validator/dist/middlewares/openapi.response.validator.js b/node_modules/express-openapi-validator/dist/middlewares/openapi.response.validator.js
index ea14edf..ba398ec 100644
--- a/node_modules/express-openapi-validator/dist/middlewares/openapi.response.validator.js
+++ b/node_modules/express-openapi-validator/dist/middlewares/openapi.response.validator.js
@@ -7,10 +7,32 @@ const util_1 = require("./util");
 const types_1 = require("../framework/types");
 const mediaTypeParser = require("media-typer");
 const contentTypeParser = require("content-type");
+
+function removeExamplesKeys(obj) {
+	if (typeof obj === "object" && obj !== null) {
+		if (Array.isArray(obj)) {
+			obj.forEach(function (item) {
+				removeExamplesKeys(item);
+			});
+		} else {
+			for (var key in obj) {
+				if (key === "examples") {
+					delete obj[key];
+				} else {
+					removeExamplesKeys(obj[key]);
+				}
+			}
+		}
+	}
+}
+
 class ResponseValidator {
     constructor(openApiSpec, options = {}, eovOptions = {}) {
         this.validatorsCache = {};
         this.spec = openApiSpec;
+        // Examples not needed for validation. The following line is needed to bypass weird "id" example bug. 
+        // See: https://github.com/cdimascio/express-openapi-validator/issues/773 and https://github.com/cdimascio/express-openapi-validator/pull/774
+        removeExamplesKeys(this.spec);
         this.ajvBody = (0, ajv_1.createResponseAjv)(openApiSpec, options);
         this.eovOptions = eovOptions;
         // This is a pseudo-middleware function. It doesn't get registered with

[allenrinmar]

I'm curious what the status of this PR is. We've entered a similar issue in testing an upgrade to v5 and this looks to solve it. Does anyone need help that I could assist with?

[cdimascio]

@allenrinmar will fix this shortly, have a PR here: #890