Organize new openapi spec with tags and generate API docs with the new spec

This commit is contained in:
Gabe Kangas 2024-05-03 15:39:59 -07:00
parent ae76abbb34
commit 1ca7a877e4
2 changed files with 948 additions and 649 deletions

View file

@ -9,19 +9,19 @@ jobs:
name: Generate API Documentation name: Generate API Documentation
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout repo - name: Checkout repo
uses: actions/checkout@v4 uses: actions/checkout@v4
- name: Run redoc on openapi.yaml - name: Run redoc on openapi.yaml
run: | run: |
npx redoc-cli bundle openapi.yaml -o docs/api/index.html --options '{"hideHostname": true, "pathInMiddlePanel": true}' npx redoc-cli bundle spec/openapi.yaml -o docs/api/index.html --options '{"hideHostname": true, "pathInMiddlePanel": true}'
- name: Commit changes - name: Commit changes
uses: EndBug/add-and-commit@v9 uses: EndBug/add-and-commit@v9
with: with:
author_name: Owncast author_name: Owncast
author_email: owncast@owncast.online author_email: owncast@owncast.online
message: "Commit updated API documentation" message: 'Commit updated API documentation'
add: "docs/api/index.html" add: 'docs/api/index.html'
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

File diff suppressed because it is too large Load diff