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

.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'

.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'

.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"

.gitignore

@@ -1 +1,2 @@
-out/
+.DS_Store
+out/

.spectral.yml

@@ -0,0 +1 @@
+extends: ["spectral:oas"]