Repository navigation
Merge pull request #472 from flashcatcloud/api-review/20260925T081756Z #118
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Lint OpenAPI specs | |
| # Quality gate for the public API reference. Fails on undocumented schema | |
| # properties, epoch time fields without Unix/timestamp wording, string enums | |
| # whose values are not explained in the description, and operations without | |
| # request/response examples. See scripts/lint_openapi.py for the rules. | |
| on: | |
| pull_request: | |
| paths: | |
| - 'api-reference/*.json' | |
| - 'scripts/lint_openapi.py' | |
| - 'scripts/api_path_redirects.py' | |
| - 'docs.json' | |
| - '.github/workflows/openapi-lint.yml' | |
| push: | |
| branches: [main] | |
| paths: | |
| - 'api-reference/*.json' | |
| - 'scripts/lint_openapi.py' | |
| - 'scripts/api_path_redirects.py' | |
| - 'docs.json' | |
| - '.github/workflows/openapi-lint.yml' | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v7 | |
| - uses: actions/setup-python@v5 | |
| - name: Lint specs | |
| run: python3 scripts/lint_openapi.py | |
| - name: Check API path redirects in docs.json | |
| run: python3 scripts/api_path_redirects.py --check |