Merge pull request #205 from feenst/update-validation-for-object

Align schema validation with specification for objects

Author: philsturgeon

lib/validators/spec.js

@@ -330,6 +330,14 @@ function validateRequiredPropertiesExist (schema, schemaId) {
     }
   }
 
+  // The "required" keyword is only applicable for objects
+  if (Array.isArray(schema.type) && !schema.type.includes("object")) {
+    return;
+  }
+  else if (!Array.isArray(schema.type) && schema.type !== "object") {
+    return;
+  }
+
   if (schema.required && Array.isArray(schema.required)) {
     let props = {};
     collectProperties(schema, props);

test/specs/validate-spec/valid/only-validate-required-properties-on-objects.yaml

@@ -0,0 +1,86 @@
+swagger: "2.0"
+info:
+  title: API documentation
+  version: "1.0.0"
+paths:
+  /product:
+    get:
+      responses:
+        "200":
+          schema:
+            $ref: "#/definitions/product"
+          description: Successful
+  /products:
+    get:
+      responses:
+        "200":
+          schema:
+            $ref: "#/definitions/products"
+          description: Successful
+  /mood:
+    get:
+      responses:
+        "200":
+          schema:
+            $ref: "#/definitions/mood"
+          description: Successful
+  /temperature:
+    get:
+      responses:
+        "200":
+          schema:
+            $ref: "#/definitions/temperature"
+          description: Successful
+  /age:
+    get:
+      responses:
+        "200":
+          schema:
+            $ref: "#/definitions/age"
+          description: Successful
+  /hunger:
+    get:
+      responses:
+        "200":
+          schema:
+            $ref: "#/definitions/hunger"
+          description: Successful
+definitions:
+  product:
+    type: object
+    properties:
+      expiration:
+        type: string
+        format: date
+      name:
+        type: string
+      weight:
+        type: number
+    required:
+      - name
+  products:
+    type: array
+    items:
+      $ref: "#/definitions/product"
+    required:
+      - items    # <--- Should not be validated since type is not object
+  mood:
+    type: string
+    example: nostalgic
+    required:
+      - length    # <--- Should not be validated since type is not object
+  temperature:
+    type: number
+    example: 86
+    required:
+      - precision    # <--- Should not be validated since type is not object
+  age:
+    type: integer
+    example: 42
+    required:
+      - factors    # <--- Should not be validated since type is not object
+  hunger:
+    type: boolean
+    example: true
+    required:
+      - truth    # <--- Should not be validated since type is not object

test/specs/validate-spec/validate-spec.spec.js

@@ -140,7 +140,12 @@ describe("Invalid APIs (Swagger 2.0 specification validation)", () => {
       valid: false,
       file: "array-response-body-no-items.yaml",
       error: 'Validation failed. /paths/users/get/responses/200/schema is an array, so it must include an \"items\" schema'
-    }
+    },
+    {
+      name: "only validate required properties on objects",
+      valid: true,
+      file: "only-validate-required-properties-on-objects.yaml"
+    },
   ];
 
   it('should pass validation if "options.validate.spec" is false', async () => {