ci(model-server-openapi): lint the specification with spectral in GHA

Encourages the well-known Zalando RESTful OpenAPI guidelines.

Author: languitar

.github/workflows/linting.yml

@@ -20,6 +20,16 @@ jobs:
       - uses: actions/setup-python@v5
       - uses: pre-commit/[email protected]
 
+  openapi-linting:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone repo
+        uses: actions/checkout@v4
+      - uses: stoplightio/[email protected]
+        with:
+          file_glob: 'model-server-openapi/specifications/model-server-*.yaml'
+        continue-on-error: true
+
   openapi-breaking-changes:
     runs-on: ubuntu-latest
     permissions:

.spectral.yaml

@@ -0,0 +1,16 @@
+extends:
+  - https://raw.githubusercontent.com/baloise-incubator/spectral-ruleset/5b2386ffa4d0ab4ccef0e1fc87f3d00fefc81eea/zalando.yml
+  - "spectral:oas"
+rules:
+  # We don't need an API info for internal use
+  must-have-info-contact-email: false
+  must-have-info-contact-name: false
+  must-have-info-contact-url: false
+  must-have-info-x-api-id: false
+  must-provide-api-audience: false
+
+  # The rule is based on an outdated problem specification
+  must-use-valid-problem-json-schema: false
+
+  # We would lose enum support from openapi-generator
+  should-use-x-extensible-enum: false

commitlint.config.js

@@ -15,6 +15,7 @@ module.exports = {
         "model-client",
         "model-datastructure",
         "model-server",
+        "model-server-openapi",
         "modelql",
         "mps-model-adapters",
         "mps-model-server",