docs: add ttl_seconds, deadline_at, and bulk-cancel to intent API docs #159
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: ci | |
| on: | |
| pull_request: | |
| push: | |
| branches: ["main"] | |
| permissions: | |
| contents: read | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| env: | |
| AXME_CONTROL_PLANE_READ_TOKEN: ${{ secrets.AXME_CONTROL_PLANE_READ_TOKEN }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install -e ".[dev]" | |
| - name: Run docs validator | |
| run: python scripts/validate_docs.py | |
| - name: Verify OpenAPI sync against control-plane full contract | |
| if: ${{ env.AXME_CONTROL_PLANE_READ_TOKEN != '' }} | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: AxmeAI/axme-control-plane | |
| token: ${{ env.AXME_CONTROL_PLANE_READ_TOKEN }} | |
| path: axme-control-plane | |
| persist-credentials: false | |
| - name: Compare OpenAPI artifacts with control-plane | |
| if: ${{ env.AXME_CONTROL_PLANE_READ_TOKEN != '' }} | |
| run: | | |
| python -m pip install -r axme-control-plane/requirements.txt | |
| python axme-control-plane/scripts/export_gateway_openapi.py | |
| diff -u docs/openapi/gateway.v1.json axme-control-plane/docs/openapi/gateway.v1.json | |
| diff -u docs/openapi/gateway.track-f-sprint1.v1.json axme-control-plane/docs/openapi/gateway.track-f-sprint1.v1.json | |
| - name: Require cross-repo token for OpenAPI sync gate | |
| if: ${{ env.AXME_CONTROL_PLANE_READ_TOKEN == '' }} | |
| run: | | |
| echo "::error::AXME_CONTROL_PLANE_READ_TOKEN must be configured to enforce non-optional OpenAPI sync gate." | |
| exit 1 | |
| - name: Run tests | |
| run: python -m pytest -q |