-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
543 lines (525 loc) · 14.5 KB
/
openapi.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
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
openapi: 3.0.2
info:
title: Confesi server
version: 0.1.0
servers:
- url: http://localhost:3000/
components:
schemas:
masked-id:
type: string
minLength: 22
maxLength: 22
#pattern: '^[0-9A-Za-z+/]+$'
contentEncoding: base64url
contentMediaType: application/vnd.confesi.masked-id
masked-sequential-id:
type: string
minLength: 22
maxLength: 22
#pattern: '^[0-9A-Za-z+/]+$'
contentEncoding: base64url
contentMediaType: application/vnd.confesi.masked-sequential-id
success:
type: object
required:
- error
properties:
error:
type: 'null'
example: {error: null}
username:
type: string
minLength: 1
maxLength: 32
pattern: '^[0-9A-Za-z]+$'
example: 'earlgrey'
votes:
type: 'object'
required:
- up
- down
properties:
up:
type: integer
minimum: 0
down:
type: integer
minimum: 0
responses:
unauthenticated:
description: The authentication token is not valid (missing, malformed, fake, or expired).
content:
application/json:
schema:
type: object
properties:
error:
type: string
enum:
- Unauthenticated
unexpected:
description: An unexpected error occurred. (Non-JSON bodies with other response codes and unexpected data types should also be treated as this error.)
content:
application/json:
schema:
type: object
properties:
error:
type: string
enum:
- Unexpected
securitySchemes:
bearer:
type: http
scheme: bearer
security:
- bearer: []
paths:
/login:
post:
summary: Log in
description: Authenticates with a username.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- username
properties:
username:
$ref: '#/components/schemas/username'
description: The username. Case-insensitive.
responses:
'200':
description: Authentication was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/success'
'400':
description: Authentication was unsuccessful.
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: string
enum:
- UsernameNotFound
'401':
$ref: '#/components/responses/unauthenticated'
'500':
$ref: '#/components/responses/unexpected'
/logout:
post:
responses:
'200':
description: The requesting session was valid, and was invalidated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/success'
'401':
$ref: '#/components/responses/unauthenticated'
'500':
$ref: '#/components/responses/unexpected'
/logout-all:
post:
responses:
'200':
description: All sessions belonging to the user were invalidated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/success'
'401':
$ref: '#/components/responses/unauthenticated'
'500':
$ref: '#/components/responses/unexpected'
/users/:
post:
summary: Create account
description: Registers a new account.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- username
- school_id
properties:
username:
$ref: '#/components/schemas/username'
description: The new account’s username.
school_id:
type: string
faculty:
type: string
year_of_study:
type: string
responses:
'200':
description: The account was created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/success'
'409':
description: An error occurred creating the account.
content:
application/json:
schema:
type: object
required:
- error
error:
type: string
enum:
- UsernameTaken
'500':
$ref: '#/components/responses/unexpected'
/users/profile/:
get:
summary: List user profile data
responses:
'200':
content:
application/json:
schema:
type: object
properties:
year_of_study:
type: string
faculty:
type: string
school_id:
type: string
username:
type: string
'400':
content:
application/json:
schema:
type: 'object'
properties:
BadRequest:
type: string
put:
summary: Update user profile data
requestBody:
content:
application/json:
schema:
type: object
properties:
year_of_study:
type: string
faculty:
type: string
school_id:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: null
value:
type: string
example: null
'400':
content:
application/json:
schema:
type: 'object'
properties:
BadRequest:
type: string
/users/watched/:
get:
summary: Get schools a user has watched
responses:
'200':
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
type: string
example: university name
'400':
content:
application/json:
schema:
type: 'object'
properties:
BadRequest:
type: string
post:
summary: Add to the list of schools a user has watched
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
example: UVIC
responses:
'200':
content:
application/json:
schema:
type: object
properties:
value:
type: string
example: null
error:
type: string
example: null
'400':
content:
application/json:
schema:
type: 'object'
properties:
BadRequest:
type: string
delete:
summary: Delete schools from the list a user has watched
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
example: UVIC
responses:
'200':
content:
application/json:
schema:
type: object
properties:
value:
type: string
example: null
error:
type: string
example: null
'400':
content:
application/json:
schema:
type: 'object'
properties:
BadRequest:
type: string
/posts/{post_id}/:
get:
summary: Get a singular post via masked post ID.
parameters:
- name: post_id
in: path
required: true
schema:
id:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
required:
- id
- sequential_id
- reply_context
- text
- created_at
- votes
properties:
id:
$ref: '#/components/schemas/masked-id'
sequential_id:
$ref: '#/components/schemas/masked-sequential-id'
reply_context:
anyOf:
- type: 'null'
- type: object
required:
- id
properties:
id:
$ref: '#/components/schemas/masked-id'
text:
type: string
created_at:
type: string
votes:
$ref: '#/components/schemas/votes'
/posts/:
get:
summary: List posts
parameters:
- name: sort
in: query
required: true
schema:
type: string
enum:
- recent
- trending
- name: before
in: query
required: false
schema:
$ref: '#/components/schemas/masked-sequential-id'
responses:
'200':
content:
application/json:
schema:
type: 'object'
required:
- value
properties:
value:
type: 'object'
required:
- posts
properties:
posts:
type: array
items:
type: object
required:
- id
- sequential_id
- reply_context
- text
- created_at
- votes
properties:
id:
$ref: '#/components/schemas/masked-id'
sequential_id:
$ref: '#/components/schemas/masked-sequential-id'
reply_context:
anyOf:
- type: 'null'
- type: object
required:
- id
properties:
id:
$ref: '#/components/schemas/masked-id'
text:
type: string
created_at:
type: string
votes:
$ref: '#/components/schemas/votes'
post:
summary: Create post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- text
properties:
text:
type: string
minLength: 1
maxLength: 1000
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/success'
'401':
$ref: '#/components/responses/unauthenticated'
'500':
$ref: '#/components/responses/unexpected'
/posts/{post_id}/vote:
put:
summary: Vote on post
parameters:
- name: post_id
in: path
required: true
schema:
$ref: '#/components/schemas/masked-id'
requestBody:
required: true
content:
application/json:
schema:
type: integer
enum:
- -1
- 0
- 1
responses:
'200':
content:
application/json:
schema:
type: 'object'
required:
- value
properties:
value:
$ref: '#/components/schemas/votes'
'401':
$ref: '#/components/responses/unauthenticated'
'500':
$ref: '#/components/responses/unexpected'
/schools/:
get:
summary: List schools along with distance to requester (based on IP address)
responses:
'200':
content:
application/json:
schema:
type: array
items:
type: object
required:
- id
- name
- distance
properties:
id:
type: string
name:
type: string
distance:
# TODO: is description allowed here?
description: Distance in kilometres.
anyOf:
- type: 'null'
- type: number
minimum: 0