diff --git a/.github/workflows/openapi_gh_pages.yaml b/.github/workflows/openapi_gh_pages.yaml index 614432c8..ebe8d299 100644 --- a/.github/workflows/openapi_gh_pages.yaml +++ b/.github/workflows/openapi_gh_pages.yaml @@ -1,8 +1,5 @@ name: Publish OpenAPI on GitHub Pages on: - pull_request: - branches: - - main push: branches: - main diff --git a/README.md b/README.md index d825b91c..26073547 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,11 @@ poetry install poetry run uvicorn hi_api.main:app --reload ``` +## View OpenAPI schema for the server + +A HTML view of the OpenAPI schema matching the `main` branch is viewable at +[canonical.github.io/hardware-api](https://canonical.github.io/hardware-api) + ## Build and run the reference CLI tool (`hwctl`) ```bash