From cdc942d6768a4fc34140537f1cb5c2557ffd4af4 Mon Sep 17 00:00:00 2001
From: Patrick Connolly <patrick.c.connolly@gmail.com>
Date: Thu, 29 Nov 2018 04:32:58 +0800
Subject: [PATCH] Fixed API description docs.

---
 bridge/api/api.go         | 8 +++++---
 docs/docs.go              | 6 +++---
 docs/swagger/swagger.json | 4 ++--
 docs/swagger/swagger.yaml | 4 ++--
 4 files changed, 12 insertions(+), 10 deletions(-)

diff --git a/bridge/api/api.go b/bridge/api/api.go
index 29c50ad1..38eba8f3 100644
--- a/bridge/api/api.go
+++ b/bridge/api/api.go
@@ -9,15 +9,14 @@ import (
 
 	"github.com/42wim/matterbridge/bridge"
 	"github.com/42wim/matterbridge/bridge/config"
+	_ "github.com/42wim/matterbridge/docs"
 	"github.com/labstack/echo"
 	"github.com/labstack/echo/middleware"
 	"github.com/swaggo/echo-swagger"
 	"github.com/zfjagann/golang-ring"
-	_ "github.com/42wim/matterbridge/docs"
 )
 
 // @title Matterbridge API
-// @description A read/write API for the Matterbridge chat bridge.
 
 // @license.name Apache 2.0
 // @license.url https://github.com/42wim/matterbridge/blob/master/LICENSE
@@ -110,7 +109,6 @@ func (b *API) Send(msg config.Message) (string, error) {
 
 // handleHealthcheck godoc
 // @Summary Checks if the server is alive.
-// @Description OK
 // @Success 200 {string} string
 // @Router /health [get]
 func (b *API) handleHealthcheck(c echo.Context) error {
@@ -122,6 +120,7 @@ func (b *API) handleDocsRedirect(c echo.Context) error {
 }
 
 // handlePostMessage godoc
+// @Description Required fields: text, gateway. Optional fields: username, avatar.
 // @Summary Create/Update a message
 // @Accept json
 // @Produce json
@@ -193,3 +192,6 @@ func (b *API) handleStream(c echo.Context) error {
 		}
 	}
 }
+
+// Must go at the bottom due to bug where endpoint descriptions override.
+// @description A read/write API for the Matterbridge chat bridge.
diff --git a/docs/docs.go b/docs/docs.go
index e9553da0..612e60e6 100644
--- a/docs/docs.go
+++ b/docs/docs.go
@@ -1,6 +1,6 @@
 // GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
 // This file was generated by swaggo/swag at
-// 2018-11-29 03:59:40.172197 +0800 CST m=+0.084842487
+// 2018-11-29 04:32:21.768173 +0800 CST m=+0.082341511
 
 package docs
 
@@ -11,7 +11,7 @@ import (
 var doc = `{
     "swagger": "2.0",
     "info": {
-        "description": "OK",
+        "description": "A read/write API for the Matterbridge chat bridge.",
         "title": "Matterbridge API",
         "contact": {},
         "license": {
@@ -23,7 +23,6 @@ var doc = `{
     "paths": {
         "/health": {
             "get": {
-                "description": "OK",
                 "summary": "Checks if the server is alive.",
                 "responses": {
                     "200": {
@@ -42,6 +41,7 @@ var doc = `{
                         "ApiKeyAuth": []
                     }
                 ],
+                "description": "Required fields: text, gateway. Optional fields: username, avatar.",
                 "consumes": [
                     "application/json"
                 ],
diff --git a/docs/swagger/swagger.json b/docs/swagger/swagger.json
index 6668e113..b7848a6a 100644
--- a/docs/swagger/swagger.json
+++ b/docs/swagger/swagger.json
@@ -1,7 +1,7 @@
 {
     "swagger": "2.0",
     "info": {
-        "description": "OK",
+        "description": "A read/write API for the Matterbridge chat bridge.",
         "title": "Matterbridge API",
         "contact": {},
         "license": {
@@ -13,7 +13,6 @@
     "paths": {
         "/health": {
             "get": {
-                "description": "OK",
                 "summary": "Checks if the server is alive.",
                 "responses": {
                     "200": {
@@ -32,6 +31,7 @@
                         "ApiKeyAuth": []
                     }
                 ],
+                "description": "Required fields: text, gateway. Optional fields: username, avatar.",
                 "consumes": [
                     "application/json"
                 ],
diff --git a/docs/swagger/swagger.yaml b/docs/swagger/swagger.yaml
index 47fbb3bb..1fbb96b9 100644
--- a/docs/swagger/swagger.yaml
+++ b/docs/swagger/swagger.yaml
@@ -65,7 +65,7 @@ definitions:
     type: object
 info:
   contact: {}
-  description: OK
+  description: A read/write API for the Matterbridge chat bridge.
   license:
     name: Apache 2.0
     url: https://github.com/42wim/matterbridge/blob/master/LICENSE
@@ -73,7 +73,6 @@ info:
 paths:
   /health:
     get:
-      description: OK
       responses:
         "200":
           description: OK
@@ -84,6 +83,7 @@ paths:
     post:
       consumes:
       - application/json
+      description: 'Required fields: text, gateway. Optional fields: username, avatar.'
       parameters:
       - description: Message object to create
         in: body