Fix type-checking rules to accept allOf, anyOf, and oneOf

.spectral.backend.yaml

@@ -15,10 +15,10 @@ rules:
   oas3-schema: true
   oas3-operation-security-defined: true
   schema-ids-must-have-alphanumeric-characters-only: true
-  schemas-properties-must-have-a-type: true
-  path-schema-properties-must-have-a-type: true
-  schema-object-must-have-a-type: true
-  items-must-have-a-type: true
+  schemas-properties-must-have-a-type-backend: true
+  path-schema-properties-must-have-a-type-backend: true
+  schema-object-must-have-a-type-backend: true
+  items-must-have-a-type-backend: true
   schema-name-length-must-be-short: true
   must-not-use-base-server-url: true
   # Backend to Backend specific rules

.spectral.frontend.yaml

@@ -15,10 +15,10 @@ rules:
   oas3-schema: true
   oas3-operation-security-defined: true
   schema-ids-must-have-alphanumeric-characters-only: true
-  schemas-properties-must-have-a-type: true
-  path-schema-properties-must-have-a-type: true
-  schema-object-must-have-a-type: true
-  items-must-have-a-type: true
+  schemas-properties-must-have-a-type-frontend: true
+  path-schema-properties-must-have-a-type-frontend: true
+  schema-object-must-have-a-type-frontend: true
+  items-must-have-a-type-frontend: true
   schema-name-length-must-be-short: true
   must-not-use-base-server-url: true
   must-use-get-post-methods: true

.workleap.rules.yaml

@@ -25,12 +25,12 @@ rules:
       functionOptions:
         match: '^[a-zA-Z0-9]+$'
 
-  schemas-properties-must-have-a-type:
+  schemas-properties-must-have-a-type-backend:
     description: "All schemas properties must have a type or schema reference. Refer to: https://gsoftdev.atlassian.net/wiki/spaces/TEC/pages/3858235678/IDP+OpenAPI+Rulesets#schemas-properties-must-have-a-type-and-path-schema-properties-must-have-a-type"
     recommended: true
     severity: warn
     given: $..schemas.*.properties.*
-    then:
+    then: &type-or-ref-check
       - function: truthy
       - function: schema
         functionOptions:
@@ -39,47 +39,64 @@ rules:
               - required: ["type"]
               - required: ["$ref"]
 
-  path-schema-properties-must-have-a-type:
-    description: "All path schema properties must have a type or schema reference. Refer to: https://gsoftdev.atlassian.net/wiki/spaces/TEC/pages/3858235678/IDP+OpenAPI+Rulesets#schemas-properties-must-have-a-type-and-path-schema-properties-must-have-a-type"
+  schemas-properties-must-have-a-type-frontend:
+    description: "All schemas properties must have a type, schema reference, or composition keyword (allOf/anyOf/oneOf). Refer to: https://gsoftdev.atlassian.net/wiki/spaces/TEC/pages/3858235678/IDP+OpenAPI+Rulesets#schemas-properties-must-have-a-type-and-path-schema-properties-must-have-a-type"
     recommended: true
     severity: warn
-    given: $..schema.properties.*
-    then:
+    given: $..schemas.*.properties.*
+    then: &type-or-composition-check
       - function: truthy
       - function: schema
         functionOptions:
           schema:
             anyOf:
               - required: ["type"]
               - required: ["$ref"]
+              - required: ["allOf"]
+              - required: ["anyOf"]
+              - required: ["oneOf"]
+
+  path-schema-properties-must-have-a-type-backend:
+    description: "All path schema properties must have a type or schema reference. Refer to: https://gsoftdev.atlassian.net/wiki/spaces/TEC/pages/3858235678/IDP+OpenAPI+Rulesets#schemas-properties-must-have-a-type-and-path-schema-properties-must-have-a-type"
+    recommended: true
+    severity: warn
+    given: $..schema.properties.*
+    then: *type-or-ref-check
 
-  schema-object-must-have-a-type:
+  path-schema-properties-must-have-a-type-frontend:
+    description: "All path schema properties must have a type, schema reference, or composition keyword (allOf/anyOf/oneOf). Refer to: https://gsoftdev.atlassian.net/wiki/spaces/TEC/pages/3858235678/IDP+OpenAPI+Rulesets#schemas-properties-must-have-a-type-and-path-schema-properties-must-have-a-type"
+    recommended: true
+    severity: warn
+    given: $..schema.properties.*
+    then: *type-or-composition-check
+
+  schema-object-must-have-a-type-backend:
     description: "All schema objects must have a type or schema reference. Refer to: https://gsoftdev.atlassian.net/wiki/spaces/TEC/pages/3858235678/IDP+OpenAPI+Rulesets#schema-object-must-have-a-type"
     recommended: true
     severity: warn
     given: $.components.schemas.*
-    then:
-      - function: truthy
-      - function: schema
-        functionOptions:
-          schema:
-            anyOf:
-              - required: ["type"]
-              - required: ["$ref"]
+    then: *type-or-ref-check
+
+  schema-object-must-have-a-type-frontend:
+    description: "All schema objects must have a type, schema reference, or composition keyword (allOf/anyOf/oneOf). Refer to: https://gsoftdev.atlassian.net/wiki/spaces/TEC/pages/3858235678/IDP+OpenAPI+Rulesets#schema-object-must-have-a-type"
+    recommended: true
+    severity: warn
+    given: $.components.schemas.*
+    then: *type-or-composition-check
 
-  items-must-have-a-type:
+  items-must-have-a-type-backend:
     description: "All items must have a type or schema reference. Refer to: https://gsoftdev.atlassian.net/wiki/spaces/TEC/pages/3858235678/IDP+OpenAPI+Rulesets#items-must-have-a-type"
     recommended: true
     severity: warn
     given: $.components.schemas..items
-    then:
-      - function: truthy
-      - function: schema
-        functionOptions:
-          schema:
-            anyOf:
-              - required: ["type"]
-              - required: ["$ref"]
+    then: *type-or-ref-check
+
+  items-must-have-a-type-frontend:
+    description: "All items must have a type, schema reference, or composition keyword (allOf/anyOf/oneOf). Refer to: https://gsoftdev.atlassian.net/wiki/spaces/TEC/pages/3858235678/IDP+OpenAPI+Rulesets#items-must-have-a-type"
+    recommended: true
+    severity: warn
+    given: $.components.schemas..items
+    then: *type-or-composition-check
 
   schema-name-length-must-be-short:
     description: "Schema name must not be too long to support client generation. Current limitation comes from Ruby packages which uses tar and has a limit of 100 characters. Refer to: https://gsoftdev.atlassian.net/wiki/spaces/TEC/pages/3858235678/IDP+OpenAPI+Rulesets#schema-name-length-must-be-short"
@@ -147,4 +164,4 @@ rules:
       functionOptions:
         values:
           - get
-          - post
+          - post

TestSpecs/items-must-have-a-type-valid-composition.yaml

@@ -0,0 +1,21 @@
+openapi: 3.0.1
+info:
+  title: dummy
+components:
+  schemas:
+    Signal:
+      type: object
+      properties:
+        id:
+          type: string
+    ReviewSignal:
+      type: object
+      properties:
+        reviewType:
+          type: string
+    SignalList:
+      type: array
+      items:
+        oneOf:
+          - $ref: '#/components/schemas/Signal'
+          - $ref: '#/components/schemas/ReviewSignal'

TestSpecs/path-schema-properties-must-have-a-type-valid-composition.yaml

@@ -0,0 +1,25 @@
+openapi: 3.0.1
+info:
+  title: dummy
+paths:
+  /test:
+    get:
+      operationId: getTest
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  composedProperty:
+                    oneOf:
+                      - type: object
+                        properties:
+                          option1:
+                            type: string
+                      - type: object
+                        properties:
+                          option2:
+                            type: integer

TestSpecs/schema-object-must-have-a-type-valid-composition.yaml

@@ -0,0 +1,37 @@
+openapi: 3.0.1
+info:
+  title: dummy
+components:
+  schemas:
+    BaseSchema:
+      type: object
+      properties:
+        id:
+          type: string
+    AllOfSchema:
+      allOf:
+        - $ref: '#/components/schemas/BaseSchema'
+        - type: object
+          properties:
+            extra:
+              type: string
+    AnyOfSchema:
+      anyOf:
+        - type: object
+          properties:
+            option1:
+              type: string
+        - type: object
+          properties:
+            option2:
+              type: integer
+    OneOfSchema:
+      oneOf:
+        - type: object
+          properties:
+            option1:
+              type: string
+        - type: object
+          properties:
+            option2:
+              type: integer

TestSpecs/schemas-properties-must-have-a-type-valid-composition.yaml

@@ -0,0 +1,18 @@
+openapi: 3.0.1
+info:
+  title: dummy
+components:
+  schemas:
+    SampleObject:
+      type: object
+      properties:
+        composedProperty:
+          allOf:
+            - type: object
+              properties:
+                field1:
+                  type: string
+            - type: object
+              properties:
+                field2:
+                  type: string

test.ps1

@@ -8,9 +8,14 @@ spectral --version
 $ruleset = Join-Path $PSScriptRoot ".workleap.rules.yaml"
 
 $testSpecs = @(
-    @{ rule = "items-must-have-a-type"; expectError = $false; filename = "items-must-have-a-type-valid.yaml" },
-    @{ rule = "items-must-have-a-type"; expectError = $false; filename = "items-must-have-a-type-valid-ref.yaml" },
-    @{ rule = "items-must-have-a-type"; expectError = $true; filename = "items-must-have-a-type-invalid.yaml" },
+    @{ rule = "items-must-have-a-type-backend"; expectError = $false; filename = "items-must-have-a-type-valid.yaml" },
+    @{ rule = "items-must-have-a-type-backend"; expectError = $false; filename = "items-must-have-a-type-valid-ref.yaml" },
+    @{ rule = "items-must-have-a-type-backend"; expectError = $true; filename = "items-must-have-a-type-valid-composition.yaml" },
+    @{ rule = "items-must-have-a-type-backend"; expectError = $true; filename = "items-must-have-a-type-invalid.yaml" },
+    @{ rule = "items-must-have-a-type-frontend"; expectError = $false; filename = "items-must-have-a-type-valid.yaml" },
+    @{ rule = "items-must-have-a-type-frontend"; expectError = $false; filename = "items-must-have-a-type-valid-ref.yaml" },
+    @{ rule = "items-must-have-a-type-frontend"; expectError = $false; filename = "items-must-have-a-type-valid-composition.yaml" },
+    @{ rule = "items-must-have-a-type-frontend"; expectError = $true; filename = "items-must-have-a-type-invalid.yaml" },
     @{ rule = "must-accept-content-types"; expectError = $false; filename = "must-accept-content-types-valid.yaml" },
     @{ rule = "must-accept-content-types"; expectError = $true; filename = "must-accept-content-types-invalid.yaml" },
     @{ rule = "must-not-use-base-server-url"; expectError = $false; filename = "must-not-use-base-server-url-valid.yaml" },
@@ -21,26 +26,42 @@ $testSpecs = @(
     @{ rule = "must-support-client-credentials-oauth2"; expectError = $true; filename = "must-support-client-credentials-oauth2-invalid.yaml" },
     @{ rule = "must-use-get-post-methods"; expectError = $false; filename = "must-use-get-post-methods-valid.yaml" },
     @{ rule = "must-use-get-post-methods"; expectError = $true; filename = "must-use-get-post-methods-invalid.yaml" },
-    @{ rule = "path-schema-properties-must-have-a-type"; expectError = $false; filename = "path-schema-properties-must-have-a-type-valid.yaml" },
-    @{ rule = "path-schema-properties-must-have-a-type"; expectError = $false; filename = "path-schema-properties-must-have-a-type-valid-ref.yaml" },
-    @{ rule = "path-schema-properties-must-have-a-type"; expectError = $true; filename = "path-schema-properties-must-have-a-type-invalid.yaml" },
-    @{ rule = "schemas-properties-must-have-a-type"; expectError = $false; filename = "schemas-properties-must-have-a-type-valid.yaml" },
-    @{ rule = "schemas-properties-must-have-a-type"; expectError = $false; filename = "schemas-properties-must-have-a-type-valid-ref.yaml" },
-    @{ rule = "schemas-properties-must-have-a-type"; expectError = $true; filename = "schemas-properties-must-have-a-type-invalid.yaml" },
+    @{ rule = "path-schema-properties-must-have-a-type-backend"; expectError = $false; filename = "path-schema-properties-must-have-a-type-valid.yaml" },
+    @{ rule = "path-schema-properties-must-have-a-type-backend"; expectError = $false; filename = "path-schema-properties-must-have-a-type-valid-ref.yaml" },
+    @{ rule = "path-schema-properties-must-have-a-type-backend"; expectError = $true; filename = "path-schema-properties-must-have-a-type-valid-composition.yaml" },
+    @{ rule = "path-schema-properties-must-have-a-type-backend"; expectError = $true; filename = "path-schema-properties-must-have-a-type-invalid.yaml" },
+    @{ rule = "path-schema-properties-must-have-a-type-frontend"; expectError = $false; filename = "path-schema-properties-must-have-a-type-valid.yaml" },
+    @{ rule = "path-schema-properties-must-have-a-type-frontend"; expectError = $false; filename = "path-schema-properties-must-have-a-type-valid-ref.yaml" },
+    @{ rule = "path-schema-properties-must-have-a-type-frontend"; expectError = $false; filename = "path-schema-properties-must-have-a-type-valid-composition.yaml" },
+    @{ rule = "path-schema-properties-must-have-a-type-frontend"; expectError = $true; filename = "path-schema-properties-must-have-a-type-invalid.yaml" },
+    @{ rule = "schemas-properties-must-have-a-type-backend"; expectError = $false; filename = "schemas-properties-must-have-a-type-valid.yaml" },
+    @{ rule = "schemas-properties-must-have-a-type-backend"; expectError = $false; filename = "schemas-properties-must-have-a-type-valid-ref.yaml" },
+    @{ rule = "schemas-properties-must-have-a-type-backend"; expectError = $true; filename = "schemas-properties-must-have-a-type-valid-composition.yaml" },
+    @{ rule = "schemas-properties-must-have-a-type-backend"; expectError = $true; filename = "schemas-properties-must-have-a-type-invalid.yaml" },
+    @{ rule = "schemas-properties-must-have-a-type-frontend"; expectError = $false; filename = "schemas-properties-must-have-a-type-valid.yaml" },
+    @{ rule = "schemas-properties-must-have-a-type-frontend"; expectError = $false; filename = "schemas-properties-must-have-a-type-valid-ref.yaml" },
+    @{ rule = "schemas-properties-must-have-a-type-frontend"; expectError = $false; filename = "schemas-properties-must-have-a-type-valid-composition.yaml" },
+    @{ rule = "schemas-properties-must-have-a-type-frontend"; expectError = $true; filename = "schemas-properties-must-have-a-type-invalid.yaml" },
     @{ rule = "schema-ids-must-have-alphanumeric-characters-only"; expectError = $false; filename = "schema-ids-must-have-alphanumeric-characters-only-valid.yaml" },
     @{ rule = "schema-ids-must-have-alphanumeric-characters-only"; expectError = $true; filename = "schema-ids-must-have-alphanumeric-characters-only-invalid.yaml" },
-    @{ rule = "schema-object-must-have-a-type"; expectError = $false; filename = "schema-object-must-have-a-type-valid.yaml" },
-    @{ rule = "schema-object-must-have-a-type"; expectError = $false; filename = "schema-object-must-have-a-type-valid-ref.yaml" },
-    @{ rule = "schema-object-must-have-a-type"; expectError = $true; filename = "schema-object-must-have-a-type-invalid.yaml" },
+    @{ rule = "schema-object-must-have-a-type-backend"; expectError = $false; filename = "schema-object-must-have-a-type-valid.yaml" },
+    @{ rule = "schema-object-must-have-a-type-backend"; expectError = $false; filename = "schema-object-must-have-a-type-valid-ref.yaml" },
+    @{ rule = "schema-object-must-have-a-type-backend"; expectError = $true; filename = "schema-object-must-have-a-type-valid-composition.yaml" },
+    @{ rule = "schema-object-must-have-a-type-backend"; expectError = $true; filename = "schema-object-must-have-a-type-invalid.yaml" },
+    @{ rule = "schema-object-must-have-a-type-frontend"; expectError = $false; filename = "schema-object-must-have-a-type-valid.yaml" },
+    @{ rule = "schema-object-must-have-a-type-frontend"; expectError = $false; filename = "schema-object-must-have-a-type-valid-ref.yaml" },
+    @{ rule = "schema-object-must-have-a-type-frontend"; expectError = $false; filename = "schema-object-must-have-a-type-valid-composition.yaml" },
+    @{ rule = "schema-object-must-have-a-type-frontend"; expectError = $true; filename = "schema-object-must-have-a-type-invalid.yaml" },
     @{ rule = "schema-name-length-must-be-short"; expectError = $false; filename = "schema-name-length-must-be-short-valid.yaml" },
     @{ rule = "schema-name-length-must-be-short"; expectError = $true; filename = "schema-name-length-must-be-short-invalid.yaml" }
 )
 
 function RunSpectralTests($ruleset, $tests, $testSpecsPath)
 {
     $fileCount = Get-ChildItem (Join-Path $PSScriptRoot $testSpecsPath) | Measure-Object | Select-Object -ExpandProperty Count
-    if ($tests.Count -ne $fileCount) {
-        throw "Number of tests does not match number of specs. Add the missing specs to the `$tests variable. Files: $fileCount, Tests: $($tests.Count)"
+    $uniqueTestFiles = $tests | ForEach-Object { $_.filename } | Sort-Object -Unique | Measure-Object | Select-Object -ExpandProperty Count
+    if ($uniqueTestFiles -ne $fileCount) {
+        throw "Number of unique test spec files does not match number of specs. Add the missing specs to the `$tests variable. Files: $fileCount, Unique test files: $uniqueTestFiles"
     }
 
     # We expect spectral to fail, so we need to capture the error