generate openapi docs

input-output-hk · Dec 12, 2023 · 92f7d7b · 92f7d7b
1 parent c59fdef
commit 92f7d7b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/catalyst-gateway/Earthfile b/catalyst-gateway/Earthfile
@@ -31,6 +31,9 @@ build-hosted:
 
     DO github.com/input-output-hk/catalyst-ci/earthly/rust:v2.0.11+SMOKE_TEST --bin="cat-gateway"
 
+    # generate OpenAPI docs
+    RUN ./target/$TARGETARCH/release/cat-gateway docs ./target/$TARGETARCH/doc/cat-gateway-api.json
+
     SAVE ARTIFACT target/$TARGETARCH/doc doc
     SAVE ARTIFACT target/$TARGETARCH/release/cat-gateway cat-gateway
 

diff --git a/docs/src/api/cat-gateway/openapi.md b/docs/src/api/cat-gateway/openapi.md
@@ -4,8 +4,8 @@ icon: material/server
 
 # OpenAPI docs
 
+[OPEN FILE](./rust-docs/cat-gateway-api.json)
+
 ```JSON
-{
-    "name": "Alex",
-}
+    {{ include_file('src/api/cat-gateway/rust-docs/cat-gateway-api.json') }}
 ```