feat: error for oneOf, anyOf, allOf schema that does not use array (#143

)

The fields for compose models must be arrays for an OpenAPI definition. This check raises an error if this is not the case

src/plugins/validation/2and3/semantic-validators/schema-ibm.js

@@ -50,14 +50,33 @@ module.exports.validate = function({ jsSpec, isOAS3 }, config) {
             This includes responses, request bodies, parameters (with content rather than schema),
             both at the operation level and within the top-level "components" object
     */
+
     const modelLocations = ['definitions', 'schemas', 'properties'];
     if (
       current === 'schema' ||
       current === 'items' ||
-      modelLocations.indexOf(path[path.length - 2]) > -1
+      modelLocations.includes(path[path.length - 2])
     ) {
       const pushLeafSchemas = (obj, path) => {
-        if (obj.allOf && Array.isArray(obj.allOf)) {
+        if (obj.allOf && !Array.isArray(obj.allOf)) {
+          messages.addMessage(
+            path.concat(['allOf']),
+            'allOf value should be an array',
+            'error'
+          );
+        } else if (isOAS3 && obj.oneOf && !Array.isArray(obj.oneOf)) {
+          messages.addMessage(
+            path.concat(['oneOf']),
+            'oneOf value should be an array',
+            'error'
+          );
+        } else if (isOAS3 && obj.anyOf && !Array.isArray(obj.anyOf)) {
+          messages.addMessage(
+            path.concat(['anyOf']),
+            'anyOf value should be an array',
+            'error'
+          );
+        } else if (obj.allOf && Array.isArray(obj.allOf)) {
           obj.allOf.forEach((e, i) =>
             pushLeafSchemas(e, [...path, 'allOf', i])
           );

test/cli-validator/mockFiles/oas3/complexTestComposeModel.yaml

@@ -0,0 +1,22 @@
+openapi: 3.0.0
+components:
+  schemas:
+    A:
+      description: a schema
+      type: string
+      format: byte
+    complexOneOfError:
+      description: second oneOf should be array
+      oneOf:
+        - oneOf:
+            $ref: '#/components/schemas/A'
+    complexAllOfError:
+      description: allOf should be array
+      oneOf:
+        - allOf:
+            type: string
+    complexAnyOfError:
+      description: anyOf should be array
+      oneOf:
+        - anyOf:
+            $ref: '#/components/schemas/A'

test/cli-validator/mockFiles/oas3/composeModelItems.yaml

@@ -0,0 +1,21 @@
+openapi: 3.0.0
+components:
+  schemas:
+    one_of_array:
+      type: array
+      description: a oneOf array schema
+      items:
+        oneOf:
+          type: string
+    all_of_array:
+      type: array
+      description: an allOf array schema
+      items:
+        allOf:
+          type: string
+    any_of_array:
+      type: array
+      description: an anyOf array schema
+      items:
+        anyOf:
+          type: string

test/cli-validator/mockFiles/oas3/composeModelProps.yaml

@@ -0,0 +1,22 @@
+openapi: 3.0.0
+components:
+  schemas:
+    object1:
+      type: object
+      description: an object schema
+      properties:
+        one_of_error_prop:
+          description: oneOf should be array
+          schema:
+            oneOf:
+              type: string
+        all_of_error_prop:
+          description: allOf should be array
+          schema:
+            allOf:
+              type: string
+        any_of_error_prop:
+          description: anyOf should be array
+          schema:
+            anyOf:
+              type: string

test/cli-validator/mockFiles/oas3/composeModelsUseArray.yaml

@@ -0,0 +1,22 @@
+openapi: 3.0.0
+components:
+  schemas:
+    object1:
+      type: object
+      description: an object schema
+      properties:
+        one_of_error_prop:
+          description: oneOf should be array
+          schema:
+            oneOf:
+              - type: string
+        all_of_error_prop:
+          description: allOf should be array
+          schema:
+            allOf:
+              - type: string
+        any_of_error_prop:
+          description: anyOf should be array
+          schema:
+            anyOf:
+              - type: string

test/cli-validator/mockFiles/oas3/testComposeModel.yaml

@@ -0,0 +1,19 @@
+openapi: 3.0.0
+components:
+  schemas:
+    A:
+      description: a schema
+      type: string
+      format: byte
+    oneOfError:
+      description: should be array but instead just a ref
+      oneOf:
+        $ref: '#/components/schemas/A'
+    allOfError:
+      description: should be array but instead just a type
+      allOf:
+        type: string
+    anyOfError:
+      description: should be array but instead just a ref
+      anyOf:
+        $ref: '#/components/schemas/A'

test/cli-validator/mockFiles/oas3/testoneof.yaml

@@ -20,6 +20,7 @@ components:
       - $ref: '#/components/schemas/A'
       - $ref: '#/components/schemas/B'
     C:
+      description: one of two allOf schemas
       oneOf:
         - allOf:
           - type: foo
@@ -29,6 +30,7 @@ components:
             format: url
             description: 'url string'
     Ok:
+      description: ok object
       type: object
       properties:
         ok: