This repository has been archived by the owner on Feb 5, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yml
524 lines (524 loc) · 11 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
swagger: '2.0'
info:
version: 1.0.0
title: API for the JDIS training platform
basePath: /api
securityDefinitions:
cookieAuth:
type: apiKey
in: header
name: Cookie
paths:
# CHALLENGES
/challenges:
get:
summary: Get all challenges
tags:
- challenges
responses:
200:
description: OK
schema:
type: array
items:
$ref: "#/definitions/Challenge"
post:
summary: Create a challenge
tags:
- challenges
consumes:
- application/json
parameters:
- in: body
name: challenge
description: The challenge to create
schema:
$ref: "#/definitions/Challenge"
responses:
404:
description: Not found
200:
description: OK
schema:
$ref: "#/definitions/Challenge"
/challenges/seed:
post:
summary: Seed the database with stored challenges
tags:
- seed
responses:
200:
description: OK
/challenges/{challengeId}:
get:
summary: Get a challenge by ID
tags:
- challenges
parameters:
- in: path
name: challengeId
type: string
required: true
description: ID of the challenge
responses:
404:
description: Not found
200:
description: OK
schema:
$ref: "#/definitions/Challenge"
put:
summary: Update a challenge by ID
tags:
- challenges
parameters:
- in: path
name: challengeId
type: string
required: true
description: ID of the challenge to update
- in: body
name: challenge
description: The new challenge data
schema:
$ref: "#/definitions/Challenge"
responses:
200:
description: OK
schema:
$ref: "#/definitions/Challenge"
delete:
summary: Delete a challenge and tests by ID
tags:
- challenges
parameters:
- in: path
name: challengeId
type: string
required: true
description: ID of the challenge
responses:
200:
description: OK
/challenges/{challengeId}/tests:
get:
summary: Get tests for a challenge by ID
tags:
- challenges
parameters:
- in: path
name: challengeId
type: string
required: true
description: ID of the challenge
responses:
200:
description: OK
schema:
type: array
items:
$ref: "#/definitions/Challenge"
post:
summary: Create tests for a challenge by ID
tags:
- challenges
parameters:
- in: path
name: challengeId
type: string
required: true
description: ID of the challenge
- in: body
name: tests
description: The tests to create
schema:
type: array
items:
$ref: "#/definitions/Challenge"
responses:
200:
description: OK
schema:
type: array
items:
$ref: "#/definitions/Challenge"
put:
summary: Update tests for a challenge by ID
tags:
- challenges
parameters:
- in: path
name: challengeId
type: string
required: true
description: ID of the challenge
- in: body
name: tests
description: The tests to update
schema:
type: array
items:
$ref: "#/definitions/Challenge"
responses:
200:
description: OK
schema:
type: array
items:
$ref: "#/definitions/Challenge"
/challenges/{challengeId}/result:
get:
summary: Get result for challenge
tags:
- challenges
parameters:
- in: path
name: challengeId
type: string
required: true
description: ID of the challenge
responses:
200:
description: OK
schema:
$ref: "#/definitions/Challenge"
# CATEGORIES
/categories:
get:
summary: Get all categories
tags:
- categories
responses:
200:
description: OK
schema:
type: array
items:
$ref: "#/definitions/Category"
/categories/seed:
post:
summary: Seed the database with stored categories
tags:
- categories
- seed
responses:
200:
description: OK
# LANGUAGES
/languages:
get:
summary: Get supported languages
tags:
- languages
parameters:
- in: query
name: challenge
type: string
description: ID of the challenge
responses:
404:
description: Challenge not found
200:
description: OK
schema:
type: array
items:
$ref: "#/definitions/Language"
/languages/seed:
post:
summary: Seed the database with stored languages
tags:
- languages
- seed
responses:
200:
description: OK
# USERS
/users:
get:
summary: Get the all users
tags:
- users
responses:
200:
description: OK
schema:
type: array
items:
$ref: "#/definitions/User"
/users/me:
get:
summary: Get the current user
tags:
- users
responses:
200:
description: OK
schema:
$ref: "#/definitions/User"
/users/:userId/makeadmin:
post:
summary: Make a user admin
tags:
- users
parameters:
- in: path
name: userId
type: string
required: true
description: ID of the user
responses:
404:
description: Not found
200:
description: OK
schema:
$ref: "#/definitions/User"
# RESULTS
/results:
get:
summary: Get all results
tags:
- results
responses:
200:
description: OK
schema:
type: array
items:
$ref: "#/definitions/Result"
# CODES
/codes:
get:
summary: Get codes for challenge
tags:
- codes
parameters:
- in: query
name: challenge
type: string
description: ID of the challenge
required: true
responses:
200:
description: OK
schema:
type: array
items:
$ref: "#/definitions/Code"
post:
summary: Save code
tags:
- codes
parameters:
- in: body
name: code
description: The code to save
schema:
$ref: "#/definitions/Code"
responses:
200:
description: OK
/codes/submit:
post:
summary: Run code
tags:
- codes
parameters:
- in: body
name: code
description: The code to run
schema:
$ref: "#/definitions/Code"
responses:
200:
description: OK
# SETTINGS
/settings/submit/activate:
post:
summary: Activate submit
tags:
- settings
responses:
200:
description: OK
/settings/submit/deactivate:
post:
summary: Deactivate submit
tags:
- settings
responses:
200:
description: OK
/settings/challenges/activate:
post:
summary: Activate challenges
tags:
- settings
responses:
200:
description: OK
/settings/challenges/deactivate:
post:
summary: Deactivate challenges
tags:
- settings
responses:
200:
description: OK
definitions:
Challenge:
type: object
properties:
id:
type: string
readOnly: true
name:
type: string
description:
type: string
points:
type: integer
category:
type: string
isCodingChallenge:
type: boolean
timeAllowed:
type: integer
numberTests:
type: integer
languagesAllowed:
type: array
items:
type: string
boilerplates:
type: array
items:
type: object
properties:
language:
type: string
code:
type: string
Test:
type: object
properties:
id:
type: string
readOnly: true
name:
type: string
challenge:
type: string
isPublic:
type: boolean
isCode:
type: boolean
inputs:
type: array
items:
type: string
outputs:
type: array
items:
type: string
code:
type: string
Category:
type: object
properties:
name:
type: string
User:
type: object
properties:
id:
type: string
readOnly: true
cip:
type: string
preferredLanguage:
type: string
email:
type: string
name:
type: string
totalPoints:
type: integer
readOnly: true
isAdmin:
type: boolean
Result:
type: object
properties:
id:
type: string
readOnly: true
user:
type: string
challenge:
type: string
points:
type: number
percent:
type: number
tests:
type: array
items:
type: object
properties:
test:
type: string
output:
type: string
error:
type: string
percent:
type: number
isSuccess:
type: boolean
isTimeout:
type: boolean
isCompilationError:
type: boolean
Language:
type: object
properties:
id:
type: string
readOnly: true
name:
type: string
bin:
type: string
fileExtension:
type: string
dockerImage:
type: string
dockerCompiler:
type: string
compiledPostfix:
type: string
runPreArgs:
type: array
items:
type: string
interpreter:
type: boolean
highlight:
type: string
Code:
type: object
properties:
id:
type: string
readOnly: true
user:
type: string
readOnly: true
challenge:
type: string
language:
type: string
code:
type: string