Added support for reporting user errors with validation

postmanlabs · May 9, 2023 · 4428f77 · 4428f77
1 parent 54b02fa
commit 4428f77
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 9 deletions.
diff --git a/lib/common/generateValidationError.js b/lib/common/generateValidationError.js
@@ -4,7 +4,8 @@ const Ajv = require('ajv-draft-04'),
   openapi3Schema = require('../../assets/openapi3Schema.json'),
   swagger2Schema = require('../../assets/swagger2Schema.json'),
   openapi3Utils = require('../30XUtils/schemaUtils30X'),
-  swagger2Utils = require('../swaggerUtils/schemaUtilsSwagger');
+  swagger2Utils = require('../swaggerUtils/schemaUtilsSwagger'),
+  { jsonPointerDecodeAndReplace } = require('../jsonPointer');
 
 /**
  * Constructs Error message from given AJV Validation Error object.
@@ -13,16 +14,16 @@ const Ajv = require('ajv-draft-04'),
  * @returns {String} - Error message constructed (To be displayed as error message for invalid specs)
  */
 function constructErrorMessage (ajvError) {
-  let message = 'Provided API Specification is invalid, ';
+  let message = 'Provided API Specification is invalid. ';
 
   message += ajvError.message;
 
   if (ajvError.params) {
     message += ' ' + JSON.stringify(ajvError.params);
   }
 
-  if (ajvError.instancePath) {
-    message += ` at "${ajvError.instancePath}"`;
+  if (typeof ajvError.instancePath === 'string') {
+    message += ` at "${jsonPointerDecodeAndReplace(ajvError.instancePath)}"`;
   }
 
   return message;

diff --git a/lib/schemapack.js b/lib/schemapack.js
@@ -87,8 +87,10 @@ class SchemaPack {
 
     try {
       // We only convert if swagger is found otherwise this.openapi remains the same
-      return convertToOAS30IfSwagger(getConcreteSchemaUtils(this.input), this.openapi, (error, convertedOpenAPI) => {
-        if (error) {
+      return convertToOAS30IfSwagger(getConcreteSchemaUtils(this.input), this.openapi, (err, convertedOpenAPI) => {
+        if (err) {
+          const error = generateError(this.openapi, _.get(this.validationResult, 'specificationVersion'), err);
+
           return callback(error);
         }
 
@@ -310,8 +312,10 @@ class SchemaPack {
 
     try {
       // We only convert if swagger is found otherwise this.openapi remains the same
-      convertToOAS30IfSwagger(concreteUtils, this.openapi, (error, newOpenapi) => {
-        if (error) {
+      convertToOAS30IfSwagger(concreteUtils, this.openapi, (err, newOpenapi) => {
+        if (err) {
+          const error = generateError(this.openapi, _.get(this.validationResult, 'specificationVersion'), err);
+
           return callback(error);
         }
 
@@ -408,7 +412,9 @@ class SchemaPack {
           }
         }
         catch (e) {
-          return callback(e);
+          const error = generateError(this.openapi, _.get(this.validationResult, 'specificationVersion'), e);
+
+          return callback(error);
         }
 
         collectionJSON = generatedStore.collection.toJSON();