Repository navigation
docs(api-reference): document the 9 RUM custom dashboard endpoints #195
Workflow file for this run
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, enums whose | |
| # values are not explained in the description, `required` entries that name | |
| # undeclared properties, operations without examples or a 403 response, | |
| # examples that do not match their schema, and over-long operation | |
| # descriptions. 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 |