Merge pull request #82 from sei-protocol/feature/swagger-docs

Swagger docs howto
sei-protocol · Jun 7, 2024 · 39ef5da · 39ef5da
2 parents eca6dad + 9431e27
commit 39ef5da
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/pages/dev-node/_meta.json b/pages/dev-node/_meta.json
@@ -4,6 +4,7 @@
   "node-operators": "Node Operators",
   "node-configuration": "Node Configuration",
   "configure-general-settings": "Configure General Settings",
+  "swagger-docs-endpoint": "Swagger Docs Endpoint",
   "join-a-network": "Join a Network",
   "running-seid": "Running Seid"
 }
diff --git a/pages/dev-node/swagger-docs-endpoint.mdx b/pages/dev-node/swagger-docs-endpoint.mdx
@@ -0,0 +1,16 @@
+# Swagger Docs Endpoint
+To enable the Swagger docs endpoint, you need to update `api.swagger` value to `true` in the `app.toml` file.:
+
+```toml
+###############################################################################
+###                           API Configuration                             ###
+###############################################################################
+
+[api]
+
+# Swagger defines if swagger documentation should automatically be registered.
+swagger = true
+```
+
+Once node is restarted, swagger docs will be available at `http://<node-ip>:<port>/swagger/`
+