API: generate /api/state documentation from UI types (#32431)

Co-authored-by: Michael Geers <michael@geers.tv>
This commit is contained in:
andig 2026-08-03 13:06:37 +02:00 • committed by GitHub
parent c7c744f54e
commit c3f3384bfc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
44 changed files with 8757 additions and 3347 deletions

View file

@ -176,6 +176,9 @@ jobs:
- name: Install
run: make install-ui
- name: OpenAPI
run: make openapi
- name: Lint
run: make lint-ui

View file

@ -58,7 +58,7 @@ jobs:
- name: Prepare OpenAPI spec
run: |
mkdir -p ./openapi-deploy
cp ./server/openapi.yaml ./openapi-deploy/openapi.yaml
npx --yes @redocly/cli@2 bundle ./server/openapi.yaml -o ./openapi-deploy/openapi.yaml
- name: Deploy OpenAPI spec to docs repo
uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453 # v4

View file

@ -8,6 +8,7 @@ on:
pull_request:
paths:
- "server/openapi.yaml"
- "server/openapi.state.yaml"
- ".github/workflows/openapi-validate.yml"
jobs:
@ -22,4 +23,4 @@ jobs:
with:
go-version: stable
- name: Validate OpenAPI spec
run: go run github.com/getkin/kin-openapi/cmd/validate@v0.133.0 -- server/openapi.yaml
run: go run github.com/getkin/kin-openapi/cmd/validate@v0.133.0 -ext -- server/openapi.yaml