ci: document the implementation of openapi validation #279

SchweizerischeBundesbahnen · Oct 28, 2024 · fa9b3c8 · fa9b3c8
1 parent 6379c74
commit fa9b3c8
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 13 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
diff --git a/.github/workflows/openapi-validation.yml b/.github/workflows/openapi-validation.yml
@@ -0,0 +1,16 @@
+---
+name: openapi-validate
+on: [push]
+jobs:
+  check-openapi-definition:
+    runs-on: ubuntu-latest
+    name: Swagger Editor Validator Remote
+    steps:
+      - name: 📄 Checkout the repository
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871  # v4
+        with:
+          fetch-depth: 0
+      - name: 🧪 Validate OpenAPI definition
+        uses: char0n/swagger-editor-validate@v1
+        with:
+          definition-file: docs/openapi.json