Merge pull request #145 from JaredCE/improve-circular-reference-handling

Improve circular reference handling

Author: JaredCE

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-openapi-documenter",
-  "version": "0.0.80",
+  "version": "0.0.81",
   "description": "Generate OpenAPI v3 documentation and Postman Collections from your Serverless Config",
   "main": "index.js",
   "keywords": [
@@ -40,20 +40,20 @@
     "@apidevtools/json-schema-ref-parser": "^9.1.0",
     "chalk": "^4.1.2",
     "js-yaml": "^4.1.0",
-    "json-schema-for-openapi": "^0.3.2",
+    "json-schema-for-openapi": "^0.4.1",
     "lodash.isequal": "^4.5.0",
     "oas-validator": "^5.0.8",
-    "openapi-to-postmanv2": "^4.16.0",
+    "openapi-to-postmanv2": "^4.17.0",
     "swagger2openapi": "^7.0.8",
     "uuid": "^9.0.0"
   },
   "engines": {
     "node": ">=14"
   },
   "devDependencies": {
-    "chai": "^4.3.7",
+    "chai": "^4.3.8",
     "mocha": "^10.2.0",
-    "nock": "^13.3.0",
-    "sinon": "^15.0.3"
+    "nock": "^13.3.3",
+    "sinon": "^16.0.0"
   }
 }

package.json

@@ -68,17 +68,10 @@ class SchemaHandler {
       ).catch((err) => {
         if (err.errors) {
           for (const error of err?.errors) {
-            if (error.message.includes("HTTP ERROR")) {
-              //   throw err;
-              throw new Error(
-                `There was an error dereferencing ${
-                  model.name
-                } schema.  \n\n dereferencing message: ${
-                  error.message
-                } \n\n Model received: ${JSON.stringify(model)}`
-              );
-            }
+            this.__HTTPError(error);
           }
+        } else {
+          this.__HTTPError(err);
         }
         return modelSchema;
       });
@@ -108,7 +101,11 @@ class SchemaHandler {
         throw new Error(
           `There was an error converting the ${
             model.name
-          } schema. Model received looks like: \n\n${JSON.stringify(model)}`
+          } schema. Model received looks like: \n\n${JSON.stringify(
+            model
+          )}.  The convereted schema looks like \n\n${JSON.stringify(
+            convertedSchemas
+          )}`
         );
       }
     }
@@ -230,6 +227,19 @@ class SchemaHandler {
       Object.assign(this.openAPI, components);
     }
   }
+
+  __HTTPError(error) {
+    if (error.message.includes("HTTP ERROR")) {
+      //   throw err;
+      throw new Error(
+        `There was an error dereferencing ${
+          model.name
+        } schema.  \n\n dereferencing message: ${
+          error.message
+        } \n\n Model received: ${JSON.stringify(model)}`
+      );
+    }
+  }
 }
 
 module.exports = SchemaHandler;