Add type: array validation for parameters

Author: shockey

src/plugins/validation/semantic-validators/validators/parameters.js

@@ -0,0 +1,35 @@
+// Assertation 1:
+// The items property for a parameter is required when its type is set to array
+
+export function validate({ resolvedSpec }) {
+  let errors = []
+  let warnings = []
+
+  function walk(obj, path) {
+    if(typeof obj !== "object" || obj === null) {
+      return
+    }
+
+    // 1
+    if(path[path.length - 2] === "parameters") {
+      if(obj.type === "array" && typeof obj.items !== "object") {
+        errors.push({
+          path,
+          message: "Parameters with 'array' type require an 'items' property."
+        })
+      }
+    }
+
+    if(Object.keys(obj).length) {
+      return Object.keys(obj).map(k => walk(obj[k], [...path, k]))
+
+    } else {
+      return null
+    }
+
+  }
+
+  walk(resolvedSpec, [])
+
+  return { errors, warnings }
+}

test/plugins/validation/semantic/parameters.js

@@ -0,0 +1,29 @@
+import expect from "expect"
+import { validate } from "plugins/validation/semantic-validators/validators/parameters"
+
+describe("validation plugin - semantic - parameters", () => {
+  it("should return an error when an array type parameter omits an `items` property", () => {
+    const spec = {
+      "paths": {
+        "/pets": {
+          "get": {
+            "parameters": [
+              {
+                "name": "tags",
+                "in": "query",
+                "description": "tags to filter by",
+                "type": "array"
+              }
+            ]
+          }
+        }
+      }
+    }
+
+    let res = validate({ resolvedSpec: spec })
+    expect(res.errors.length).toEqual(1)
+    expect(res.errors[0].path).toEqual(["paths", "/pets", "get", "parameters", "0"])
+    expect(res.errors[0].message).toEqual("Parameters with 'array' type require an 'items' property.")
+    expect(res.warnings.length).toEqual(0)
+  })
+})