mirrors/owncast
1
0
Fork 0
mirror of https://github.com/owncast/owncast.git synced 2024-11-24 13:50:06 +03:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source
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
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.github/workflows/generate-api-documentation.yaml vendored
View file

@ -14,14 +14,14 @@ jobs:
- 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 }}

1557
spec/openapi.yaml
View file

File diff suppressed because it is too large Load diff