Merge pull request #10 from canonical/openapi-html-only-on-main

Only run OpenAPI schema generator on main
canonical · Jan 23, 2024 · ba13ae4 · ba13ae4
2 parents e824191 + fe5c663
commit ba13ae4
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git 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
@@ -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