tileradotorg/synapse
1
0
Fork 0
forked from MirrorHub/synapse
Code Pull requests Activity

Whoops: Put /events parameters object in the right part of the api tree.

Browse source
This commit is contained in:
Kegan Dougal 2014-09-02 12:09:47 +01:00
parent 5539251d82
commit 4ac80b8570
1 changed files with 18 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
docs/client-server/swagger_matrix/api-docs-events
View file

@ -15,25 +15,26 @@
"summary": "Listen on the event stream", "summary": "Listen on the event stream",
"notes": "This can only be done by the logged in user. This will block until an event is received, or until the timeout is reached.", "notes": "This can only be done by the logged in user. This will block until an event is received, or until the timeout is reached.",
"type": "PaginationChunk", "type": "PaginationChunk",
"nickname": "get_event_stream" "nickname": "get_event_stream",
} "parameters": [
], {
"parameters": [ "name": "from",
{ "description": "The token to stream from.",
"name": "from", "required": false,
"description": "The token to stream from.", "type": "string",
"required": false, "paramType": "query"
"type": "string", },
"paramType": "query" {
}, "name": "timeout",
{ "description": "The maximum time in milliseconds to wait for an event.",
"name": "timeout", "required": false,
"description": "The maximum time in milliseconds to wait for an event.", "type": "integer",
"required": false, "paramType": "query"
"type": "integer", }
"paramType": "query" ]
} }
], ],
"responseMessages": [ "responseMessages": [
{ {
"code": 400, "code": 400,