Merge pull request #211 from JaredCE/do-not-throw-on-validation-warnings

Do not throw on validation warnings

Author: JaredCE

README.md

@@ -48,7 +48,7 @@ Options:
 --format                -f  Whether to output the OpenAPI Description as json or yaml. Default: json
 --indent                -i  File indentation in spaces. Default: 2
 --openApiVersion        -a  OpenAPI version to generate for. Default: 3.0.0
---postmanCollection     -p  Will generate a postman collection (from the generated OpenAPI Description), in json only, if passed in. Default postman.json
+--postmanCollection     -p  Will generate a postman collection (from the generated OpenAPI Description), in json only, if passed in. Default: postman.json
 --validationWarn        -w  Warn about validation errors only.  Will write the OpenAPI file if generation is successful.  Default: false
 ```
 
@@ -968,6 +968,8 @@ However, you can configure your own rules from the [ruleset available on the Red
 }
 ```
 
+Since rules can be set to "warn", you no longer are required to tell the plugin to ignore errors with the `--validationWarn` flag.
+
 ## Example configuration
 
 Please view the example [serverless.yml](test/serverless-tests/best/serverless.yml).

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-openapi-documenter",
-  "version": "0.0.100",
+  "version": "0.0.101",
   "description": "Generate OpenAPI v3 documentation and Postman Collections from your Serverless Config",
   "main": "index.js",
   "keywords": [

package.json

@@ -1021,19 +1021,13 @@ class DefinitionGenerator {
 
     const apiDesc = stringifyYaml(this.openAPI);
 
-    const results = await lintFromString({
+    return await lintFromString({
       source: apiDesc,
       config: config,
     }).catch((err) => {
       console.error(err);
       throw err;
     });
-
-    if (results.length) {
-      throw results;
-    }
-
-    return true;
   }
 }
 

src/definitionGenerator.js

@@ -195,23 +195,29 @@ class OpenAPIGenerator {
 
     this.log(`Validating generated OpenAPI Description`, this.logTypes.NOTICE);
 
-    await generator.validate().catch((err) => {
+    const validationResults = await generator.validate().catch((err) => {
       this.log(
         `ERROR: An error was thrown validating the OpenAPI v3 Description`,
         this.logTypes.ERROR
       );
 
-      this.validationErrorDetails(err);
+      throw new this.serverless.classes.Error(err);
+    });
 
-      if (this.config.validationWarn === false) {
-        let message = "Error validating OpenAPI Description:\r\n";
-        for (const errorMessage of err) {
-          message += `${errorMessage.message}\r\n`;
-        }
+    this.validationErrorDetails(validationResults);
 
-        throw new this.serverless.classes.Error(message);
+    if (validationResults.length && this.config.validationWarn === false) {
+      let message = "Error validating OpenAPI Description:\r\n";
+      let shouldThrow = false;
+      for (const error of validationResults) {
+        message += `${error.message}\r\n`;
+        if (error.severity === "error") {
+          shouldThrow = true;
+        }
       }
-    });
+
+      if (shouldThrow) throw new this.serverless.classes.Error(message);
+    }
 
     this.log(
       "OpenAPI v3 Description Successfully Generated",
@@ -306,24 +312,30 @@ class OpenAPIGenerator {
     this.config = config;
   }
 
-  validationErrorDetails(validationError) {
-    this.log(
-      `${chalk.bold.yellow(
-        "[VALIDATION]"
-      )} Validation errors found in OpenAPI Description: \n`,
-      this.logTypes.ERROR
-    );
-
-    for (const error of validationError) {
+  validationErrorDetails(validationErrors) {
+    if (validationErrors.length) {
       this.log(
-        `${chalk.bold.yellow("Message:")} ${error.message}`,
+        `${chalk.bold.yellow(
+          "[VALIDATION]"
+        )} Validation errors found in OpenAPI Description: \n`,
         this.logTypes.ERROR
       );
-      for (const location of error.location) {
+
+      for (const error of validationErrors) {
         this.log(
-          `${chalk.bold.yellow("found at location:")} ${location.pointer}`,
+          `${chalk.bold.red("Severity:")} ${error.severity}`,
           this.logTypes.ERROR
         );
+        this.log(
+          `${chalk.bold.yellow("Message:")} ${error.message}`,
+          this.logTypes.ERROR
+        );
+        for (const location of error.location) {
+          this.log(
+            `${chalk.bold.yellow("found at location:")} ${location.pointer}`,
+            this.logTypes.ERROR
+          );
+        }
       }
     }
   }