-
Notifications
You must be signed in to change notification settings - Fork 6
/
swagger.yml
534 lines (534 loc) · 14 KB
/
swagger.yml
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
openapi: 3.0.1
info:
title: Its Going To Be API
description: ""
license:
name: GPLv3
url: https://www.gnu.org/licenses/gpl-3.0.en.html
version: 0.0.1
externalDocs:
description: Find out more about Swagger
url: http://swagger.io
servers:
- url: https://itsgoingto.be/api
- url: http://itsgoingto.be/api
tags:
- name: Polls
description: ""
- name: Responses
description: ""
- name: Admin
description: ""
paths:
/polls:
get:
tags:
- Polls
summary: Retrieve all polls, only accessible when authorised
security:
- bearerAuth: []
operationId: ""
parameters:
- name: page
in: query
description: The page to return.
schema:
type: integer
default: 1
- name: pageSize
in: query
description: The ammount of results to return per page.
schema:
type: integer
default: 20
- name: sort
in: query
description: The field to sort on.
schema:
type: string
default: id
enum:
- id
- identifier
- question
- responsesCount
- name: sortDirection
in: query
description: The direction to sort.
schema:
type: string
default: asc
enum:
- asc
- desc
responses:
200:
description: Ok
content:
application/json:
schema:
type: object
properties:
count:
type: integer
example: 20
total:
type: integer
example: 100
entities:
type: array
items:
$ref: '#/components/schemas/Poll'
400:
description: Bad request. Invalid **sort** option or **sortDirection** provided.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: invalid-sort-option
401:
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: unauthorised
post:
tags:
- Polls
summary: Create a new poll
operationId: ""
requestBody:
description: The poll to create.
content:
application/json:
schema:
required:
- answers
- question
type: object
properties:
question:
type: string
answers:
type: array
items:
type: string
multipleChoice:
type: boolean
endDate:
type: string
format: datetime
passphrase:
type: string
required: false
responses:
200:
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Poll'
400:
description: Bad request. Invalid question params.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
example:
- No question has been provided
items:
type: string
x-codegen-request-body-name: poll
/polls/{identifier}:
get:
tags:
- Polls
summary: Retrieve poll
security:
- {}
- bearerAuth: []
operationId: ""
parameters:
- name: identifier
in: path
description: The poll identifier
required: true
schema:
type: string
- name: passphrase
in: query
description: Passphrase to access the poll
schema:
type: string
responses:
200:
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Poll'
403:
description: Forbidden. Poll has a passcode which is not provided or invallid.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: incorrect-passphrase
404:
description: Not found. Poll could not be found.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: poll-not-found
delete:
tags:
- Polls
summary: Delete poll, only accessible when authorised
security:
- bearerAuth: []
operationId: ""
parameters:
- name: identifier
in: path
description: The poll identifier
required: true
schema:
type: string
responses:
200:
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Poll'
400:
description: Bad request. Poll has already been deleted.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: poll-already-deleted
404:
description: Not found. Poll could not be found.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: poll-not-found
/polls/{identifier}/responses:
get:
tags:
- Responses
summary: Retrieve responses for poll
security:
- {}
- bearerAuth: []
operationId: ""
parameters:
- name: identifier
in: path
description: The poll identifier
required: true
schema:
type: string
- name: passphrase
in: query
description: Passphrase to access the poll
schema:
type: string
responses:
200:
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/PollResponses'
403:
description: Forbidden. Poll has a passcode which is not provided or invallid.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: incorrect-passphrase
404:
description: Not found. Poll could not be found.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: poll-not-found
post:
tags:
- Responses
summary: Submit responses for poll
operationId: ""
parameters:
- name: identifier
in: path
description: The poll identifier
required: true
schema:
type: string
- name: passphrase
in: query
description: Passphrase to access the poll
schema:
type: string
requestBody:
description: The poll to create.
content:
application/json:
schema:
type: object
properties:
answers:
type: array
items:
type: integer
example: 1
responses:
200:
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/PollResponses'
400:
description: Bad request. Poll has ended, or invalid answers provided.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: poll-ended
403:
description: Forbidden. Poll has a passcode which is not provided or invallid.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: incorrect-passphrase
404:
description: Not found. Poll could not be found.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: poll-not-found
/login:
post:
tags:
- Admin
summary: ""
operationId: ""
requestBody:
description: The poll to create.
content:
application/json:
schema:
required:
- username
- password
type: object
properties:
username:
type: string
password:
type: string
responses:
200:
description: Ok
content:
application/json:
schema:
type: object
properties:
token:
type: string
400:
description: Bad request. Invalid Username or Password.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: integer
example: [Username is required, Password is required, Invalid Username or Password.]
/stats:
get:
tags:
- Admin
summary: Get stats on polls
security:
- bearerAuth: []
operationId: ""
responses:
200:
description: Ok
content:
application/json:
schema:
type: object
properties:
polls:
type: integer
example: 156
responses:
type: integer
example: 454
401:
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: unauthorised
components:
schemas:
Poll:
required:
- question
type: object
properties:
id:
type: integer
description: Unique server generated ID
example: 1
identifier:
type: string
description: Unique generate poll identifier
example: v90034d6
question:
type: string
description: The question asked
example: Is this a question?
multipleChoice:
type: boolean
description: Does the poll allow multiple choice responses
example: false
default: false
endDate:
type: string
description: The end date for the poll, can be empty if no end date
format: date-time
example: 2020-10-09T19:56:35Z
ended:
type: boolean
description: Has the poll ended
example: false
deleted:
type: boolean
description: Has the poll been deleted
example: false
created:
type: string
description: When the poll was created
format: date-time
example: 2020-10-09T19:56:35Z
updated:
type: string
description: When the poll was last updated
format: date-time
example: 2020-10-09T19:56:35Z
answers:
type: array
items:
$ref: '#/components/schemas/Answer'
responsesCount:
type: integer
description: Total number of responses for all answers
example: 5
userResponses:
type: array
description: Total number of responses for all answers
example:
- 1
items:
type: integer
Answer:
required:
- answer
type: object
properties:
id:
type: integer
description: Unique server generated ID
example: 1
answer:
type: string
description: The answer
example: Answer Text
responsesCount:
type: integer
description: Total number of responses for the answer
example: 5
PollResponses:
type: object
properties:
ended:
type: boolean
description: Has the poll ended
example: false
answers:
type: array
items:
$ref: '#/components/schemas/Answer'
responsesCount:
type: integer
description: Total number of responses for all answers
example: 5
userResponses:
type: array
description: Total number of responses for all answers
example:
- 1
items:
type: integer
securitySchemes:
bearerAuth: # arbitrary name for the security scheme
type: http
scheme: bearer
bearerFormat: JWT