add swagger docs

coadler · coadler · commit 69055eab601e · 2023-01-25T14:57:08.000-06:00
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -630,9 +630,7 @@ func New(options *Options) *API {
 				},
 			)
 
-			r.HandleFunc("/coordinator", func(w http.ResponseWriter, r *http.Request) {
-				(*api.TailnetCoordinator.Load()).ServeHTTPDebug(w, r)
-			})
+			r.HandleFunc("/coordinator", api.debugCoordinator)
 		})
 	})
 
diff --git a/coderd/debug.go b/coderd/debug.go
@@ -0,0 +1,14 @@
+package coderd
+
+import "net/http"
+
+// @Summary Wireguard Coordinator Debug Info
+// @ID debuginfo-coordinator
+// @Security CoderSessionToken
+// @Produce html
+// @Tags Debug
+// @Success 200
+// @Router /debug/coordinator [get]
+func (api *API) debugCoordinator(rw http.ResponseWriter, r *http.Request) {
+	(*api.TailnetCoordinator.Load()).ServeHTTPDebug(rw, r)
+}
diff --git a/docs/api/debug.md b/docs/api/debug.md
@@ -0,0 +1,21 @@
+# Debug
+
+## Wireguard Coordinator Debug Info
+
+### Code samples
+
+```shell
+# Example request using curl
+curl -X GET http://coder-server:8080/api/v2/debug/coordinator \
+  -H 'Coder-Session-Token: API_KEY'
+```
+
+`GET /debug/coordinator`
+
+### Responses
+
+| Status | Meaning                                                 | Description | Schema |
+| ------ | ------------------------------------------------------- | ----------- | ------ |
+| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK          |        |
+
+To perform this operation, you must be authenticated. [Learn more](authentication.md).
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -364,6 +364,10 @@
           "title": "Builds",
           "path": "./api/builds.md"
         },
+        {
+          "title": "Debug",
+          "path": "./api/debug.md"
+        },
         {
           "title": "Enterprise",
           "path": "./api/enterprise.md"

Original file line number	Diff line number	Diff line change
`@@ -630,9 +630,7 @@ func New(options Options) API {`
`630`	`630`	`},`
`631`	`631`	`)`
`632`	`632`
`633`		`- r.HandleFunc("/coordinator", func(w http.ResponseWriter, r *http.Request) {`
`634`		`- (*api.TailnetCoordinator.Load()).ServeHTTPDebug(w, r)`
`635`		`- })`
	`633`	`+ r.HandleFunc("/coordinator", api.debugCoordinator)`
`636`	`634`	`})`
`637`	`635`	`})`
`638`	`636`