feat: expose the total amount of validation schema errors (#254)

* feat: expose the total amount of validation schema errors * fix: broken test? * fix: broken test??? * fix: try again????
readmeio · Apr 18, 2024 · 115ddda · 115ddda
1 parent 99807aa
commit 115ddda
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/lib/validators/schema.js b/lib/validators/schema.js
@@ -68,6 +68,7 @@ function validateSchema(api, options) {
 
     let additionalErrors = 0;
     let reducedErrors = reduceAjvErrors(err);
+    const totalErrors = reducedErrors.length;
     if (reducedErrors.length >= LARGE_SPEC_ERROR_CAP) {
       try {
         if (JSON.stringify(api).length >= LARGE_SPEC_SIZE_CAP) {
@@ -92,7 +93,7 @@ function validateSchema(api, options) {
       message += `Plus an additional ${additionalErrors} errors. Please resolve the above and re-run validation to see more.`;
     }
 
-    throw ono.syntax(err, { details: err }, message);
+    throw ono.syntax(err, { details: err, totalErrors }, message);
   }
 }
 

diff --git a/test/specs/validate-schema/validate-schema.spec.js b/test/specs/validate-schema/validate-schema.spec.js
@@ -129,6 +129,7 @@ describe('Invalid APIs (Swagger 2.0 and OpenAPI 3.x schema validation)', () => {
       expect(err.message).to.match(/^OpenAPI schema validation failed.\n(.*)+/);
 
       expect(err.details).to.be.an('array').to.have.length(3);
+      expect(err.totalErrors).to.equal(2);
 
       expect(err.message).to.contain("REQUIRED must have required property 'url'");
       expect(err.message).to.contain('url is missing here');
@@ -161,6 +162,7 @@ describe('Invalid APIs (Swagger 2.0 and OpenAPI 3.x schema validation)', () => {
           }
 
           expect(err.details).to.be.an('array').with.length.above(0);
+          expect(err.totalErrors).to.be.at.least(1);
 
           // Make sure the Ajv error details object is valid
           const details = err.details[0];