fix(oas2): collapse multiple object required property errors

Author: kylef

packages/openapi2-parser/CHANGELOG.md

@@ -8,8 +8,7 @@
   does not contain the `swagger` key, in prior versions the parser may have
   crashed under some inputs.
 
-- Improved clarity of validation error messages for Schema Object 'type'
-  property.
+- Improved clarity of validation error messages.
 
 ## 0.32.0 (2020-06-12)
 

packages/openapi2-parser/lib/parser.js

@@ -1550,6 +1550,15 @@ class Parser {
   createValidationAnnotation(error) {
     let message;
 
+    // join array of words
+    const oxfordJoin = array => array.map((item, index) => {
+      if (index === array.length - 1) {
+        return `or '${item}'`;
+      }
+
+      return `'${item}'`;
+    }).join(', ');
+
     if (error.code === 'ANY_OF_MISSING'
       && _.last(error.path) === 'type'
       && error.inner.length === 2
@@ -1577,15 +1586,17 @@ class Parser {
       return;
     }
 
-    if (error.code === 'ENUM_MISMATCH') {
-      const enumerations = error[ZSchema.schemaSymbol].enum.map((item, index, items) => {
-        if (index === items.length - 1) {
-          return `or '${item}'`;
-        }
-
-        return `'${item}'`;
-      }).join(', ');
+    if (error.code === 'ONE_OF_MISSING'
+      && error.inner.every(subError => subError.code === 'OBJECT_MISSING_REQUIRED_PROPERTY')) {
+      // collase a collection of "one of" required property validations into one message
+      const missingProperties = oxfordJoin(error.inner.map(subError => subError.params[0]));
+      message = `Object must contain either ${missingProperties} properties`;
+      this.createAnnotation(annotations.VALIDATION_ERROR, error.path, message);
+      return;
+    }
 
+    if (error.code === 'ENUM_MISMATCH') {
+      const enumerations = oxfordJoin(error[ZSchema.schemaSymbol].enum);
       const value = error.params[0];
       message = `Value must be either ${enumerations} not '${value}'`;
     } else {

packages/openapi2-parser/test/fixtures/schema-error-parameter.json

@@ -81,85 +81,7 @@
           ]
         }
       },
-      "content": "Data does not match any schemas from 'oneOf'"
-    },
-    {
-      "element": "annotation",
-      "meta": {
-        "classes": {
-          "element": "array",
-          "content": [
-            {
-              "element": "string",
-              "content": "error"
-            }
-          ]
-        },
-        "links": {
-          "element": "array",
-          "content": [
-            {
-              "element": "link",
-              "attributes": {
-                "relation": {
-                  "element": "string",
-                  "content": "origin"
-                },
-                "href": {
-                  "element": "string",
-                  "content": "http://docs.apiary.io/validations/swagger#swagger-validation"
-                }
-              }
-            }
-          ]
-        }
-      },
-      "attributes": {
-        "code": {
-          "element": "number",
-          "content": 4
-        }
-      },
-      "content": "Missing required property: schema"
-    },
-    {
-      "element": "annotation",
-      "meta": {
-        "classes": {
-          "element": "array",
-          "content": [
-            {
-              "element": "string",
-              "content": "error"
-            }
-          ]
-        },
-        "links": {
-          "element": "array",
-          "content": [
-            {
-              "element": "link",
-              "attributes": {
-                "relation": {
-                  "element": "string",
-                  "content": "origin"
-                },
-                "href": {
-                  "element": "string",
-                  "content": "http://docs.apiary.io/validations/swagger#swagger-validation"
-                }
-              }
-            }
-          ]
-        }
-      },
-      "attributes": {
-        "code": {
-          "element": "number",
-          "content": 4
-        }
-      },
-      "content": "Missing required property: type"
+      "content": "Object must contain either 'schema', or 'type' properties"
     }
   ]
 }