Added /api/health docs.

2018-11-08 07:58:14 +08:00
parent c9e3d46127
commit eff1dc261b
1 changed files with 5 additions and 0 deletions
--- a/bridge/api/api.go
+++ b/bridge/api/api.go
@@ -100,6 +100,11 @@ func (b *API) Send(msg config.Message) (string, error) {
 	return "", nil
 }

+// handleHealthcheck godoc
+// @Summary Checks if the server is alive.
+// @Description OK
+// @Success 200 {string} string
+// @Router /api/health [get]
 func (b *API) handleHealthcheck(c echo.Context) error {
 	return c.String(http.StatusOK, "OK")
 }