From fa9b3c8fde6586a7c63795cee36b9eded0dd0077 Mon Sep 17 00:00:00 2001
From: ariwk <adam.ruberti@sbb.ch>
Date: Mon, 28 Oct 2024 07:16:01 +0100
Subject: [PATCH] ci: document the implementation of openapi validation #279

---
 .github/workflows/main.yml               | 13 -------------
 .github/workflows/openapi-validation.yml | 16 ++++++++++++++++
 2 files changed, 16 insertions(+), 13 deletions(-)
 delete mode 100644 .github/workflows/main.yml
 create mode 100644 .github/workflows/openapi-validation.yml

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
deleted file mode 100644
index 3cf28f2..0000000
--- a/.github/workflows/main.yml
+++ /dev/null
@@ -1,13 +0,0 @@
-on: [push]
-
-jobs:
-  test_swagger_editor_validator_remote:
-    runs-on: ubuntu-latest
-    name: Swagger Editor Validator Remote
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Validate OpenAPI definition
-        uses: char0n/swagger-editor-validate@v1
-        with:
-          definition-file: docs/openapi.json
diff --git a/.github/workflows/openapi-validation.yml b/.github/workflows/openapi-validation.yml
new file mode 100644
index 0000000..691b6f7
--- /dev/null
+++ 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