docs: add godocs comments to all routes

* disable serving docs by default
grassrootseconomics · Apr 14, 2023 · e91f82c · e91f82c
1 parent 223656b
commit e91f82c
Show file tree

Hide file tree

Showing 10 changed files with 548 additions and 38 deletions.
diff --git a/Makefile b/Makefile
@@ -11,6 +11,7 @@ build:
 	${BUILD_CONF} go build -ldflags="-X main.build=${BUILD_COMMIT} -s -w" -o ${BIN} cmd/service/*
 
 docs:
+	swag fmt --dir internal/api/
 	swag init --dir internal/api/ -g swagger.go
 
 run:

diff --git a/config.toml b/config.toml
@@ -3,7 +3,7 @@ address = ":5000"
 # Exposes Go process Prometheus metrics
 # /metrics endpoint
 metrics = true
-docs    = true
+docs    = false
 
 [chain]
 rpc_endpoint     = ""

diff --git a/docs/docs.go b/docs/docs.go
-Original file line number
+Diff line change
@@ Expand Up / @@ -11,6 +11,7 @@ build: @@
     	${BUILD_CONF} go build -ldflags="-X main.build=${BUILD_COMMIT} -s -w" -o ${BIN} cmd/service/*
     docs:
+    	swag fmt --dir internal/api/
     	swag init --dir internal/api/ -g swagger.go
     run:
@@ Expand Down @@