Skip to content

Commit

Permalink
Generate static "bundled" openapi yaml (#347)
Browse files Browse the repository at this point in the history
This makes it possible to reference the openapi specification with a
link, in addition to having the JavaScript "Download" button of redocly.

"Bundled" == $ref:s are resolved
  • Loading branch information
tors42 authored Jun 5, 2024
1 parent 39ff215 commit 19e77a8
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ jobs:
- uses: actions/checkout@v3
- run: npm ci
- run: npm run build
- run: npm run bundle
- uses: actions/configure-pages@v3
- uses: actions/upload-pages-artifact@v2
with:
Expand Down
1 change: 1 addition & 0 deletions doc/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"scripts": {
"spectral": "spectral lint --fail-severity=warn specs/*.yaml",
"lint": "npx @redocly/cli lint specs/lichess-api.yaml",
"bundle": "npx @redocly/cli bundle specs/lichess-api.yaml --output public/openapi.yaml",
"build": "npx @redocly/cli build-docs specs/lichess-api.yaml --output public/index.html",
"serve": "npx @redocly/cli preview-docs specs/lichess-api.yaml --port 8089"
}
Expand Down

0 comments on commit 19e77a8

Please sign in to comment.