check openapi spec in CI

Author: hydrosquall

.github/workflows/python-package.yml

@@ -35,8 +35,12 @@ jobs:
           pip install setuptools
         fi
         python setup.py develop
-        python -m pip install flake8 pytest-cov coverage vcrpy black
+        python -m pip install flake8 pytest-cov coverage vcrpy black openapi-spec-validator
         tools/install_pandas.sh
+    - name: Validate OpenAPI spec
+      continue-on-error: true
+      run: |
+        openapi-spec-validator openapi/openapi.yaml
     - name: black
       run: |
         black --check tiingo

Makefile

@@ -56,6 +56,9 @@ format: ## apply opinionated formatting
 format-check: ## check formatting for CI
 	black --check tiingo/
 
+validate-openapi: ## validate OpenAPI specification
+	openapi-spec-validator openapi/openapi.yaml
+
 test: ## run tests quickly with the default Python
 	py.test
 

requirements_dev.txt

@@ -12,3 +12,4 @@ pytest==8.3.4
 vcrpy==2.1.1
 twine==6.0.1
 black==24.10.0
+openapi-spec-validator==0.7.1