chore: switch out spectral for vacuum

.github/workflows/lint.yml

@@ -6,10 +6,11 @@ on: # yamllint disable-line rule:truthy
     branches: [main]
     paths-ignore:
       - 'README.md'
+      - 'src/**'
 
 jobs:
   build:
-    name: Lint
+    name: API Linting
     runs-on: ubuntu-latest
 
     permissions:
@@ -21,15 +22,16 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-        with:
-          # super-linter needs the full git history to get the
-          # list of files that changed across commits
-          fetch-depth: 0
 
-      - name: Super-linter
-        uses: super-linter/super-linter/[email protected]
-        env:
-          DEFAULT_BRANCH: main
-          FILTER_REGEX_INCLUDE: ^openapi.yaml
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          VALIDATE_OPENAPI: true
+      - name: Install vacuum npm package
+        run: npm install -g vacuum
+
+      - name: Lint API
+        run: vacuum report --junit openapi.yaml lint-results
+
+      - name: Publish Test Results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        if: always()
+        with:
+          files: |
+            lint-results-*.xml

.vacuum/ruleset.yaml

@@ -0,0 +1,11 @@
+extends: 
+  - spectral:oas
+  # - "@apisyouwonthate/style-guide"
+  # - "@stoplight/spectral-owasp-ruleset"
+
+rules:
+  # The API doesn't have these (yet?)
+  # api-home: off
+  # api-health: off
+
+  oas3-missing-example: off

openapi.yaml

@@ -45,10 +45,10 @@ security:
   - OAuth2:
       - read
 
-x-topics:
-  - title: Getting started
-    content:
-      $ref: ./docs/getting-started.md
+# x-topics:
+#   - title: Getting started
+#     content:
+#       $ref: ./docs/getting-started.md
 
 tags:
   - name: Stations

vacuum.conf.yaml

@@ -0,0 +1 @@
+ruleset: ./.vacuum/ruleset.yaml