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

Added loose docs for each endpoint.

Browse Source
This commit is contained in:
Patrick Connolly
2018-11-05 01:58:09 +08:00
parent b9d6c06c82
commit de00b56d9a
4 changed files with 309 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

113
docs/swagger/swagger.json
View File

@@ -7,10 +7,115 @@
"license": {
"name": "Apache 2.0",
"url": "https://github.com/42wim/matterbridge/blob/master/LICENSE"
},
"version": "TODO"
}
},
"host": "TODO",
"basePath": "/api",
"paths": {}
"paths": {
"/message": {
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Create/Update a message",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"$ref": "#/definitions/config.Message"
}
}
}
}
},
"/messages": {
"get": {
"produces": [
"application/json"
],
"summary": "Lists messages",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/config.Message"
}
}
}
}
}
},
"/stream": {
"get": {
"produces": [
"application/json"
],
"summary": "Streams realtime messages",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"$ref": "#/definitions/config.Message"
}
}
}
}
}
},
"definitions": {
"config.Message": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"avatar": {
"type": "string"
},
"channel": {
"type": "string"
},
"event": {
"type": "string"
},
"extra": {
"type": "object"
},
"gateway": {
"type": "string"
},
"id": {
"type": "string"
},
"protocol": {
"type": "string"
},
"text": {
"type": "string"
},
"timestamp": {
"type": "string"
},
"userid": {
"type": "string"
},
"username": {
"type": "string"
}
}
}
},
"securityDefinitions": {
"": {
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
}
}