lug/matterbridge
10
0
Fork 2
Code Issues 4 Pull Requests Actions Packages Projects Releases Wiki Activity

Updated config.Message API docs. Allow params to be input via swagger ui.

Browse Source
This commit is contained in:
Patrick Connolly
2018-11-05 04:32:39 +08:00
parent de00b56d9a
commit 110b840d48
5 changed files with 156 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
bridge/api/api.go
View File

@@ -108,6 +108,7 @@ func (b *Api) handleDocsRedirect(c echo.Context) error {
// @Summary Create/Update a message
// @Accept json
// @Produce json
// @Param body body object true "Message object to create"
// @Success 200 {object} config.Message
// @Router /message [post]
func (b *API) handlePostMessage(c echo.Context) error {
@@ -127,7 +128,7 @@ func (b *API) handlePostMessage(c echo.Context) error {
}
// handleMessages godoc
// @Summary Lists messages
// @Summary List of new messages
// @Produce json
// @Success 200 {array} config.Message
// @Router /messages [get]
@@ -141,7 +142,7 @@ func (b *API) handleMessages(c echo.Context) error {
// handleStream godoc
// @Summary Streams realtime messages
// @Produce json
// @Produce json-stream
// @Success 200 {object} config.Message
// @Router /stream [get]
func (b *API) handleStream(c echo.Context) error {

34
bridge/config/config.go
View File

@@ -27,18 +27,30 @@ const (
)
type Message struct {
Text string `json:"text"`
Channel string `json:"channel"`
Username string `json:"username"`
UserID string `json:"userid"` // userid on the bridge
Avatar string `json:"avatar"`
Account string `json:"account"`
Event string `json:"event"`
Protocol string `json:"protocol"`
Gateway string `json:"gateway"`
// Content of the message
Text string `json:"text" example:"Testing, testing, 1-2-3."`
// Human-readable channel name
Channel string `json:"channel" example:"test-channel"`
// Human-readable username
Username string `json:"username" example:"alice"`
// userid on the bridge
UserID string `json:"userid" example:"U4MCXJKNC"`
// URL to an avatar image
Avatar string `json:"avatar" example:"https://secure.gravatar.com/avatar/1234567890abcdef1234567890abcdef.jpg"`
// Unique account name of format "<protocol>.<slug>"
Account string `json:"account" example:"slack.myteam"`
// Can be blank.
Event string `json:"event" example:""`
// Chat protocol of incoming message
Protocol string `json:"protocol" example:"slack"`
// Name of the gateway
Gateway string `json:"gateway" example:"test-channel-gateway"`
// Unique ID of a parent message, if threaded
ParentID string `json:"parent_id"`
Timestamp time.Time `json:"timestamp"`
ID string `json:"id"`
Timestamp time.Time `json:"timestamp" example:"1541361213.030700"`
// Unique ID of message on the gateway
ID string `json:"id" example:"slack 1541361213.030700"`
// Extra data that doesn't fit in other fields. Used for processing incoming messages.
Extra map[string][]interface{}
}