Merge pull request #176 from nationalarchives/FCL-283-move-some-API-d… #8
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Generate API docs and deploy to GitHub Pages | |
| on: | |
| push: | |
| branches: ["main"] | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| generate-api-docs: | |
| name: Generate API Documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Generate API docs and deploy to GitHub Pages | |
| uses: msayson/[email protected] | |
| with: | |
| api-configs: |- | |
| [ | |
| { | |
| "openapi-json-filepath": "doc/openapi/public_api.yml", | |
| "api-doc-filepath": "public.html" | |
| }, | |
| { | |
| "openapi-json-filepath": "doc/openapi/privileged_api.yml", | |
| "api-doc-filepath": "privileged.html" | |
| } | |
| ] | |
| api-docs-dir: doc/api-generated |