chore: Merge branch 'fix-api-docs' into adjust-api-docs

Author: tirumerla

.gitignore

@@ -42,6 +42,4 @@ node_modules
 # Ignore local signer keystore files everywhere
 **/local-signer.json
 
-openapi.json
-
 **/config/keys/*.json

Cargo.toml

@@ -115,7 +115,7 @@ path = "helpers/create_key.rs"
 name = "generate_uuid"
 path = "helpers/generate_uuid.rs"
 
-[[example]]
+[[gen-openapi]]
 name = "generate_openapi"
 path = "helpers/generate_openapi.rs"
 

Makefile.toml

@@ -2,8 +2,6 @@
 description = "Build Antora site and copy rust_docs"
 script = [
   "cargo doc --target-dir docs/rust_docs --release --no-deps --quiet --locked",
-  "cargo run --example generate_openapi",
-  "npx -y @redocly/cli@latest build-docs openapi.json --output docs/api_docs.html",
   "bash scripts/rust_antora.sh"
 ]
 [tasks.docker-compose-up]

docs/README.md

@@ -15,3 +15,9 @@
     ```
 
 - You can view the site `localhost:8080` or other port if it's in use.
+
+- To update openapi documentation, run:
+
+  ```sh
+  cargo run --gen-openapi generate_openapi -- ./docs/openapi.json
+  ```