API: generate /api/state documentation from UI types (#32431)
Co-authored-by: Michael Geers <michael@geers.tv>
This commit is contained in:
parent
c7c744f54e
commit
c3f3384bfc
44 changed files with 8757 additions and 3347 deletions
3
.github/workflows/default.yml
vendored
3
.github/workflows/default.yml
vendored
|
|
@ -176,6 +176,9 @@ jobs:
|
|||
- name: Install
|
||||
run: make install-ui
|
||||
|
||||
- name: OpenAPI
|
||||
run: make openapi
|
||||
|
||||
- name: Lint
|
||||
run: make lint-ui
|
||||
|
||||
|
|
|
|||
2
.github/workflows/documentation.yml
vendored
2
.github/workflows/documentation.yml
vendored
|
|
@ -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
|
||||
|
|
|
|||
3
.github/workflows/openapi-validate.yml
vendored
3
.github/workflows/openapi-validate.yml
vendored
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue