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

115
docs/docs.go
View File

@@ -1,6 +1,6 @@
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
// This file was generated by swaggo/swag at
// 2018-11-04 21:12:10.529569 +0800 CST m=+0.079119212
// 2018-11-05 01:51:14.853722 +0800 CST m=+0.078800065
package docs
@@ -17,12 +17,117 @@ var doc = `{
"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"
}
}
}`
type s struct{}

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"
}
}
}

73
docs/swagger/swagger.yaml
View File

@@ -1,5 +1,32 @@
basePath: /api
host: TODO
definitions:
config.Message:
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
type: object
info:
contact: {}
description: A read/write API for the Matterbridge chat bridge.
@@ -7,6 +34,46 @@ info:
name: Apache 2.0
url: https://github.com/42wim/matterbridge/blob/master/LICENSE
title: Matterbridge API
version: TODO
paths: {}
paths:
/message:
post:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/config.Message'
type: object
summary: Create/Update a message
/messages:
get:
produces:
- application/json
responses:
"200":
description: OK
schema:
items:
$ref: '#/definitions/config.Message'
type: array
summary: Lists messages
/stream:
get:
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/config.Message'
type: object
summary: Streams realtime messages
securityDefinitions:
"":
in: header
name: Authorization
type: apiKey
swagger: "2.0"