From eff1dc261b62db389e36720819ba656203c67d94 Mon Sep 17 00:00:00 2001
From: Patrick Connolly <patrick.c.connolly@gmail.com>
Date: Thu, 8 Nov 2018 07:58:14 +0800
Subject: [PATCH] Added /api/health docs.

---
 bridge/api/api.go | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/bridge/api/api.go b/bridge/api/api.go
index 3d9369c0..da5ad9fd 100644
--- 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")
 }