api_spec_ci

bencherdev · Oct 3, 2023 · f65df05 · f65df05
1 parent 9dde65e
commit f65df05
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/.github/workflows/bencher.yml b/.github/workflows/bencher.yml
@@ -116,6 +116,22 @@ jobs:
           name: perf.jpeg
           path: ./lib/bencher_plot/perf.jpeg
 
+  open_api_spec:
+    name: OpenAPI Spec
+    runs-on: ubuntu-latest
+    needs:
+      - cargo_fmt
+      - cargo_clippy
+    steps:
+      - uses: actions/checkout@v4
+      - uses: rui314/setup-mold@v1
+        with:
+          mold-version: ${{ env.MOLD_VERSION }}
+      - name: Generate OpenAPI Spec
+        run: cargo xtask swagger
+      - name: Check for changes
+        run: git diff --exit-code
+
   # API Smoke Test
   api_smoke_test:
     name: API Smoke Test
@@ -528,6 +544,7 @@ jobs:
     needs:
       # Test
       - cargo_test
+      - open_api_spec
       - api_smoke_test
       - api_smoke_test_compat
       - cargo_bench
@@ -638,6 +655,7 @@ jobs:
     needs:
       # Test
       - cargo_test
+      - open_api_spec
       - api_smoke_test
       - api_smoke_test_compat
       - cargo_check_api_minus

diff --git a/services/api/src/lib.rs b/services/api/src/lib.rs
@@ -15,5 +15,7 @@ pub const API_VERSION: &str = env!("CARGO_PKG_VERSION");
 // This is run via a `pre-push` git hook
 // So if the `SWAGGER_PATH` below is ever updated
 // also update `./git/hooks/pre-push` accordingly.
+#[cfg(feature = "swagger")]
 pub const SWAGGER_PATH: &str = "../console/src/content/api/swagger.json";
+#[cfg(not(feature = "swagger"))]
 pub const SWAGGER_SPEC: &str = include_str!("../../console/src/content/api/swagger.json");