lug/matterbridge
10
0
Fork 2
Code Issues 4 Pull Requests Actions 1 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

56
docs/swagger/swagger.json
View File

@@ -20,6 +20,17 @@
"application/json"
],
"summary": "Create/Update a message",
"parameters": [
{
"description": "Message object to create",
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "object"
}
}
],
"responses": {
"200": {
"description": "OK",
@@ -36,7 +47,7 @@
"produces": [
"application/json"
],
"summary": "Lists messages",
"summary": "List of new messages",
"responses": {
"200": {
"description": "OK",
@@ -53,7 +64,7 @@
"/stream": {
"get": {
"produces": [
"application/json"
"application/x-json-stream"
],
"summary": "Streams realtime messages",
"responses": {
@@ -73,40 +84,61 @@
"type": "object",
"properties": {
"account": {
"type": "string"
"description": "Unique account name of format \"\u003cprotocol\u003e.\u003cslug\u003e\"\n",
"type": "string",
"example": "slack.myteam"
},
"avatar": {
"type": "string"
"description": "URL to an avatar image\n",
"type": "string",
"example": "https://secure.gravatar.com/avatar/1234567890abcdef1234567890abcdef.jpg"
},
"channel": {
"type": "string"
"description": "Human-readable channel name\n",
"type": "string",
"example": "test-channel"
},
"event": {
"description": "Can be blank.\n",
"type": "string"
},
"extra": {
"description": "Extra data that doesn't fit in other fields. Used for processing incoming messages.\n",
"type": "object"
},
"gateway": {
"type": "string"
"description": "Name of the gateway\n",
"type": "string",
"example": "test-channel-gateway"
},
"id": {
"type": "string"
"description": "Unique ID of message on the gateway\n",
"type": "string",
"example": "slack 1541361213.030700"
},
"protocol": {
"type": "string"
"description": "Chat protocol of incoming message\n",
"type": "string",
"example": "slack"
},
"text": {
"type": "string"
"description": "Content of the message\n",
"type": "string",
"example": "Testing, testing, 1-2-3."
},
"timestamp": {
"type": "string"
"type": "string",
"example": "1541361213.030700"
},
"userid": {
"type": "string"
"description": "userid on the bridge\n",
"type": "string",
"example": "U4MCXJKNC"
},
"username": {
"type": "string"
"description": "Human-readable username\n",
"type": "string",
"example": "alice"
}
}
}

43
docs/swagger/swagger.yaml
View File

@@ -3,28 +3,60 @@ definitions:
config.Message:
properties:
account:
description: |
Unique account name of format "<protocol>.<slug>"
example: slack.myteam
type: string
avatar:
description: |
URL to an avatar image
example: https://secure.gravatar.com/avatar/1234567890abcdef1234567890abcdef.jpg
type: string
channel:
description: |
Human-readable channel name
example: test-channel
type: string
event:
description: |
Can be blank.
type: string
extra:
description: |
Extra data that doesn't fit in other fields. Used for processing incoming messages.
type: object
gateway:
description: |
Name of the gateway
example: test-channel-gateway
type: string
id:
description: |
Unique ID of message on the gateway
example: slack 1541361213.030700
type: string
protocol:
description: |
Chat protocol of incoming message
example: slack
type: string
text:
description: |
Content of the message
example: Testing, testing, 1-2-3.
type: string
timestamp:
example: "1541361213.030700"
type: string
userid:
description: |
userid on the bridge
example: U4MCXJKNC
type: string
username:
description: |
Human-readable username
example: alice
type: string
type: object
info:
@@ -39,6 +71,13 @@ paths:
post:
consumes:
- application/json
parameters:
- description: Message object to create
in: body
name: body
required: true
schema:
type: object
produces:
- application/json
responses:
@@ -59,11 +98,11 @@ paths:
items:
$ref: '#/definitions/config.Message'
type: array
summary: Lists messages
summary: List of new messages
/stream:
get:
produces:
- application/json
- application/x-json-stream
responses:
"200":
description: OK