From 35c24b9810e70c4f211878641f6fa6a62d7e338d Mon Sep 17 00:00:00 2001
From: lorddaedra <lorddaedra@users.noreply.github.com>
Date: Mon, 13 Mar 2023 13:01:10 +0300
Subject: [PATCH] Fix #23 - Add OpenAPI validation tests to CI (#24)

* Fix #23 - Add OpenAPI validation tests to CI

* Move `workflows` to `.github` directory

* Run Spectral linter

* Add linter config file

* Split validation tasks

* Add validation through the editor

* Use editor.swagger.io

* Remove .DS_Store
---
 .DS_Store                                    | Bin 6148 -> 0 bytes
 .github/workflows/Spectral.yml               |  19 ++++++++++++++
 .github/workflows/editor-swagger-io.yml      |  20 ++++++++++++++
 .github/workflows/openapi-spec-validator.yml |  26 +++++++++++++++++++
 .gitignore                                   |   3 ++-
 .spectral.yml                                |   1 +
 6 files changed, 68 insertions(+), 1 deletion(-)
 delete mode 100644 .DS_Store
 create mode 100644 .github/workflows/Spectral.yml
 create mode 100644 .github/workflows/editor-swagger-io.yml
 create mode 100644 .github/workflows/openapi-spec-validator.yml
 create mode 100644 .spectral.yml

diff --git a/.DS_Store b/.DS_Store
deleted file mode 100644
index 944ccebda19cdeb34432fa4ff0a42094bec347ff..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001

literal 6148
zcmeHKO;5ux41IwLjd9tLWB&kDh(AzG<%YOSaAvTI4|Sv3T8Z8I(|Jz3q0;WUp~;q#
z=h$)MKB;jHz>VwK4KM;Q;1G<4oO(q3GCFdimNTN0XOz{;eZ8udT;Fzfo52_`2L2lZ
z^6f^L;R7pFt?ze&wb+njjs#EmLV=okPHTb;Q~IXV9=Xo3^wv+WNyM6-g8nzg{c2ZS
zmE5zSr{tN*pVJ@o_Sj}b|2g+9m|>1@T;rAJtPYZAe;%8Rd%Vnj*vkE#jLlITB>P>N
zZ1V5*^9@XnmjTvnk-<ekn~ecuz!=yvAooMeA($#Q0sYm%$+rN+h-NR;rI(PHSTR*>
z0@6cqA(R+GowgV*gwr1DzErUZ7{cMS`EYu&(+<V?)A{_^Z-+|*+H4FM18oLQ!*V3`
z|895x-wv{sF<=ZF6$38HCfS&;q_ws4a#Cw!j%N-L+1CX0A)K@vdqqm|C5IRKVo`{x
TViS-Siv0+98f-EK_R7Ey;fr`=

diff --git a/.github/workflows/Spectral.yml b/.github/workflows/Spectral.yml
new file mode 100644
index 0000000..22af330
--- /dev/null
+++ b/.github/workflows/Spectral.yml
@@ -0,0 +1,19 @@
+name: Validate OpenAPI schema - Spectral
+
+on:
+  push:
+    branches:
+      - 'main'
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: stoplightio/spectral-action@latest
+        with:
+          file_glob: 'swagger.yaml'
diff --git a/.github/workflows/editor-swagger-io.yml b/.github/workflows/editor-swagger-io.yml
new file mode 100644
index 0000000..ebf98b4
--- /dev/null
+++ b/.github/workflows/editor-swagger-io.yml
@@ -0,0 +1,20 @@
+name: Validate OpenAPI schema - editor.swagger.io
+
+on:
+  push:
+    branches:
+      - 'main'
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Validate OpenAPI definition
+        uses: char0n/swagger-editor-validate@v1
+        with:
+          definition-file: 'swagger.yaml'
diff --git a/.github/workflows/openapi-spec-validator.yml b/.github/workflows/openapi-spec-validator.yml
new file mode 100644
index 0000000..e72eb8b
--- /dev/null
+++ b/.github/workflows/openapi-spec-validator.yml
@@ -0,0 +1,26 @@
+name: Validate OpenAPI schema - openapi-spec-validator
+
+on:
+  push:
+    branches:
+      - 'main'
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.11'
+      - name: Install dependencies
+        run: |
+          python -m pip install "openapi-spec-validator"
+      - name: Run tests
+        run: |
+          python -m openapi_spec_validator "swagger.yaml"
diff --git a/.gitignore b/.gitignore
index 466e248..f6b93a3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,2 @@
-out/
\ No newline at end of file
+.DS_Store
+out/
diff --git a/.spectral.yml b/.spectral.yml
new file mode 100644
index 0000000..d47c47d
--- /dev/null
+++ b/.spectral.yml
@@ -0,0 +1 @@
+extends: ["spectral:oas"]