From 9431e27ef35fe8ad6913ca06c26bce1042dce33e Mon Sep 17 00:00:00 2001 From: _dssei_ Date: Fri, 7 Jun 2024 14:20:28 -0700 Subject: [PATCH] swagger docs howto --- pages/dev-node/_meta.json | 1 + pages/dev-node/swagger-docs-endpoint.mdx | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 pages/dev-node/swagger-docs-endpoint.mdx diff --git a/pages/dev-node/_meta.json b/pages/dev-node/_meta.json index bf2785d..b438145 100644 --- 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 new file mode 100644 index 0000000..97929a2 --- /dev/null +++ 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://:/swagger/` +