Fixed up Swagger formatting.

This commit is contained in:
Patrick Connolly
2018-11-05 15:12:30 +08:00
parent b855dc8ec5
commit e873280794
5 changed files with 22 additions and 19 deletions

View File

@@ -23,11 +23,12 @@
"parameters": [
{
"description": "Message object to create",
"name": "body",
"name": "message",
"in": "body",
"required": true,
"schema": {
"type": "object"
"type": "object",
"$ref": "#/definitions/config.Message"
}
}
],
@@ -47,7 +48,7 @@
"produces": [
"application/json"
],
"summary": "List of new messages",
"summary": "List new messages",
"responses": {
"200": {
"description": "OK",
@@ -66,7 +67,7 @@
"produces": [
"application/x-json-stream"
],
"summary": "Streams realtime messages",
"summary": "Stream realtime messages",
"responses": {
"200": {
"description": "OK",
@@ -84,7 +85,7 @@
"type": "object",
"properties": {
"account": {
"description": "Unique account name of format \"\u003cprotocol\u003e.\u003cslug\u003e\"\n",
"description": "Unique account name of format \"[protocol].[slug]\"\n",
"type": "string",
"example": "slack.myteam"
},

View File

@@ -4,7 +4,7 @@ definitions:
properties:
account:
description: |
Unique account name of format "<protocol>.<slug>"
Unique account name of format "[protocol].[slug]"
example: slack.myteam
type: string
avatar:
@@ -74,9 +74,10 @@ paths:
parameters:
- description: Message object to create
in: body
name: body
name: message
required: true
schema:
$ref: '#/definitions/config.Message'
type: object
produces:
- application/json
@@ -98,7 +99,7 @@ paths:
items:
$ref: '#/definitions/config.Message'
type: array
summary: List of new messages
summary: List new messages
/stream:
get:
produces:
@@ -109,7 +110,7 @@ paths:
schema:
$ref: '#/definitions/config.Message'
type: object
summary: Streams realtime messages
summary: Stream realtime messages
securityDefinitions:
"":
in: header