From 7ba243ac810b5368b05164972e2caf3fffc75b40 Mon Sep 17 00:00:00 2001 From: Nicholas Wallace Date: Sat, 3 Aug 2024 21:49:38 -0700 Subject: [PATCH] Disable validator by default and add description comment --- server/Server.js | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/server/Server.js b/server/Server.js index ff1862ece..e358579d5 100644 --- a/server/Server.js +++ b/server/Server.js @@ -205,12 +205,15 @@ class Server { }) // Install the OpenApiValidator middleware if using a dev environment - if (Logger.isDev) { - // If you do not want to use this, you can comment out the entire section - // or only certain parts. + if (Logger.isDev && false) { + // This is a solution to validate the API responses, but is a work in progress. + // By default, this is disabled because invalide API requests or responses can cause + // crashes in the web client while developing other parts of the application. // - // The default value of `validateResponses` is false, so it can be safely commented - // out if the validation is causing problems. + // The OpenAPI spec is still a work in progress. + // + // If you would like to only validate responses or requests, you can adjust the + // `validateRequests` and `validateResponses` options accordingly. const apiSpec = Path.join(__dirname, '..', 'docs', 'openapi.json') app.use( OpenApiValidator.middleware({