DMP-5275 (Dev only) Spectral setup + initial warning reductions darts-api

Added spectral config

Author: karen-hedges

.spectral.yaml

@@ -2,3 +2,83 @@ extends: [ "spectral:oas" ]
 rules:
   oas3-valid-media-example: off
   oas3-valid-schema-example: off
+  strings-need-bounds:
+    description: Strings must be bounded unless they already use format/enum/pattern
+    given:
+      - "$.components.schemas.*"
+      - "$.paths.*.*.parameters[*].schema"
+      - "$.paths.*.*.requestBody.content.*.schema"
+      - "$.paths.*.*.responses.*.content.*.schema"
+    then:
+      function: schema
+      functionOptions:
+        schema:
+          if:
+            properties: { type: { const: string } }
+            required: [ type ]
+          then:
+            anyOf:
+              - required: [ maxLength ]
+              - required: [ enum ]
+              - required: [ pattern ]
+              - required: [ format ]
+    severity: warn
+
+  arrays-need-maxitems:
+    given:
+      - "$.components.schemas.*"
+      - "$.paths.*.*.parameters[*].schema"
+      - "$.paths.*.*.requestBody.content.*.schema"
+      - "$.paths.*.*.responses.*.content.*.schema"
+    then:
+      function: schema
+      functionOptions:
+        schema:
+          if:
+            properties: { type: { const: array } }
+            required: [ type ]
+          then:
+            required: [ maxItems ]
+    severity: warn
+
+  path-string-params-need-format-or-pattern:
+    given:
+      - "$.paths.*.*.parameters[?(@.in=='path')].schema"
+    then:
+      function: schema
+      functionOptions:
+        schema:
+          if:
+            properties: { type: { const: string } }
+            required: [ type ]
+          then:
+            anyOf:
+              - required: [ format ]
+              - required: [ pattern ]
+    severity: warn
+
+  param-id-needs-format-or-pattern:
+    given:
+      - "$.paths.*.*.parameters[?(@.name=='id')].schema"
+    then:
+      function: schema
+      functionOptions:
+        schema:
+          anyOf:
+            - required: [ format ]
+            - required: [ pattern ]
+    severity: warn
+
+  schema-id-prop-needs-format-or-pattern:
+    given:
+      - "$.components.schemas.*.properties.id"
+      - "$.paths.*.*.requestBody.content.*.schema.properties.id"
+    then:
+      function: schema
+      functionOptions:
+        schema:
+          anyOf:
+            - required: [ format ]
+            - required: [ pattern ]
+    severity: warn
+

README.md

@@ -398,7 +398,7 @@ This repo contains overrides for the default dev environment configuration, cont
 This repository uses spectral to validate OpenAPI specifications. To validate the OpenAPI specification:
 
 ```bash
-spectral lint "src/main/resources/openapi/**/*.{yml,yaml}"
+spectral lint --verbose "src/main/resources/openapi/**/*.{yml,yaml}"
 ```
 
 Documentation: https://stoplight.io/open-source/spectral