-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathswagger.lingr.yaml
431 lines (431 loc) · 10.2 KB
/
swagger.lingr.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
swagger: '2.0'
info:
title: Lingr API
description: ''
version: "2016-02-24"
# the domain of the service
host: lingr.com
# array of all schemes that your API supports
schemes:
- http
# will be prefixed to all paths
basePath: /api
consumes:
- application/json
produces:
- application/json
paths:
/session/create:
post:
summary: Login as a specific user
description: ''
parameters:
- name: user
description: ''
in: formData
required: true
type: string
- name: password
description: ''
in: formData
required: true
type: string
- name: app_key
description: ''
in: formData
required: false
type: string
tags:
- session
responses:
200:
description: A session object is created by this request.
schema:
$ref: '#/definitions/Session'
/session/verify:
get:
summary: Verify current session is still valid.
description: ''
parameters:
- name: session
description: session value was returned from /session/create response.
in: query
required: true
type: string
tags:
- session
responses:
200:
description: A session object was created by /session/create request.
schema:
$ref: '#/definitions/Session'
/session/destroy:
post:
summary: Logout from current session.
description: ''
parameters:
- name: session
description: session value was returned from /session/create response.
in: formData
required: true
type: string
tags:
- session
responses:
200:
description: ''
schema:
type: object
properties:
status: { type: string }
/user/get_rooms:
get:
summary: List of rooms which are joined by user.
description: ''
parameters:
- name: session
in: query
type: string
required: true
tags:
- user
responses:
200:
description: ''
schema:
$ref: '#/definitions/RoomList'
/room/show:
get:
summary: Get latest messages (up to 30) and room members.
description: ''
parameters:
- name: session
in: query
type: string
description: Current session id.
- name: room
in: query
type: string
description: Room id.
tags:
- room
responses:
200:
description: Room information.
schema:
$ref: '#/definitions/Room'
/room/get_archives:
get:
summary: Get archive messages.
description: ''
parameters:
- name: session
in: query
required: true
type: string
description: ''
- name: room
in: query
required: true
type: string
description: ''
- name: before
in: query
required: true
type: string
description: ''
- name: limit
in: query
required: true
type: string
description: ''
tags:
- room
responses:
200:
description: Archived messages.
schema:
$ref: '#/definitions/Archive'
/room/subscribe:
post:
summary: Subscribe room's events.
description: ''
parameters:
- name: session
in: query
required: true
type: string
description: ''
- name: room
in: query
required: true
type: string
description: ''
- name: reset
in: query
required: true
type: boolean
description: ''
tags:
- room
- event
responses:
200:
description: Subscription information.
schema:
type: object
properties:
status: { type: string }
counter: { type: integer, format: int64 }
/room/unsubscribe:
post:
summary: Subscribe room's events.
description: ''
parameters:
- name: session
in: query
required: true
type: string
description: ''
- name: room
in: query
required: true
type: string
description: ''
tags:
- room
- event
responses:
200:
description: Subscription information.
schema:
type: object
properties:
status: { type: string }
counter: { type: integer, format: int64 }
/room/say:
post:
summary: Post a message to a specific room.
description: ''
parameters:
- name: session
in: formData
required: true
type: string
description: ''
- name: room
in: formData
required: true
type: string
description: ''
- name: nickname
in: formData
required: true
type: string
description: ''
- name: text
in: formData
required: true
type: string
description: ''
tags:
- room
responses:
200:
description: A message just posted.
schema:
type: object
properties:
status: { type: string }
message:
$ref: '#/definitions/Message'
/favorite/add:
post:
summary: Mark a message as favorite.
description: ''
parameters:
- name: session
in: formData
required: true
type: string
description: ''
- name: message
in: formData
required: true
type: string
description: 'Message ID'
tags:
- favorite
responses:
200:
description: A message just faved.
schema:
type: object
properties:
status: { type: string }
message:
$ref: '#/definitions/Message'
/favorite/remove:
post:
summary: Unmark a message from favorite.
description: ''
parameters:
- name: session
in: formData
required: true
type: string
description: ''
- name: message
in: formData
required: true
type: string
description: 'Message ID'
tags:
- favorite
responses:
200:
description: A message just faved.
schema:
type: object
properties:
status: { type: string }
message:
$ref: '#/definitions/Message'
/event/observe:
get:
summary: Wait some events.
description: |
note: only this API uses port 8080.
parameters:
- name: session
in: query
required: true
type: string
- name: counter
in: query
required: true
type: integer
format: int64
tags:
- event
responses:
200:
description: A message just faved.
schema:
type: object
properties:
status: { type: string }
counter: { type: integer, format: int64 }
events:
type: array
items:
$ref: '#/definitions/Event'
definitions:
Session:
type: object
properties:
status: { type: string }
nickname: { type: string }
public_id: { type: string }
session: { type: string }
user:
type: object
properties:
name: { type: string }
username: { type: string }
RoomList:
type: object
properties:
status: { type: string }
rooms:
type: array
items:
type: string
Room:
type: object
properties:
status: { type: string }
rooms:
type: array
items:
type: object
properties:
id: { type: string }
name: { type: string }
blurb: { type: string }
faved_message_ids: { type: array, items: { type: string} }
is_public: { type: boolean }
roster:
$ref: '#/definitions/Roster'
messages:
type: array
items:
$ref: '#/definitions/Message'
Roster:
type: object
properties:
bots:
type: array
items:
$ref: '#/definitions/Bot'
members:
type: array
items:
$ref: '#/definitions/Member'
Bot:
type: object
properties:
id: { type: string }
name: { type: string }
icon_url: { type: string }
status: { type: string }
Member:
type: object
properties:
name: { type: string }
username: { type: string }
icon_url: { type: string }
is_online: { type: boolean }
is_owner: { type: boolean }
pokeable: { type: boolean }
timestamp: { type: string }
Message:
type: object
properties:
icon_url: { type: string }
id: { type: string }
local_id: { type: string }
nickname: { type: string }
public_session_id: { type: string }
room: { type: string }
speaker_id: { type: string }
text: { type: string }
timestamp: { type: string }
type: { type: string }
Archive:
type: object
properties:
status: { type: string }
messages:
type: array
items:
$ref: '#/definitions/Message'
Event:
type: object
properties:
event_id: { type: string }
presence:
$ref: '#/definitions/Presence'
message:
$ref: '#/definitions/Message'
Presence:
type: object
properties:
icon_url: { type: string }
nickname: { type: string }
public_session_id: { type: string }
room: { type: string }
status: { type: string }
text: { type: string }
timestamp: { type: string }
username: { type: string }