Skip to content

Generate API reference from OpenAPI #7

Generate API reference from OpenAPI

Generate API reference from OpenAPI #7

name: Generate API reference from OpenAPI
on:
workflow_dispatch:
push:
branches: ["main"]
paths:
- "openapi_to_human.py"
- "requirements.txt"
- "examples/**"
jobs:
generate:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Generate Markdown
run: |
python openapi_to_human.py "examples/openapi-min.yaml" -o "examples/output.md"
- name: Verify output exists
run: |
echo "Listing examples/:"
ls -la "examples"
echo ""
echo "---- output.md (first 80 lines) ----"
test -f "examples/output.md"
sed -n '1,80p' "examples/output.md"
- name: Upload generated Markdown
uses: actions/upload-artifact@v4
with:
name: openapi-human-reference-output
path: examples/output.md