-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
919 lines (891 loc) · 32.1 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
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
openapi: 3.0.2
info:
version: 1.0.0
title: The Tarpaulin API
description: API for an "alternative" to Canvas.
paths:
/users:
post:
summary: Create a new User.
description: >
Create and store a new application User with specified data and adds it to the application's database. Only an authenticated User with 'admin' role can create users with the 'admin' or 'instructor' roles.
operationId: createUser
tags:
- Users
requestBody:
required: true
description: A User object.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
responses:
'201':
description: New User successfully added
content:
application/json:
schema:
type: object
properties:
id:
oneOf:
- type: integer
- type: string
description: >
Unique ID of the created User. Exact type/format will depend on your implementation but will likely be either an integer or a string.
example: "123"
'400':
description: >
The request body was either not present or did not contain a valid User object.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: >
The request was not made by an authenticated User satisfying the authorization criteria described above.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/users/login:
post:
summary: Log in a User.
description: >
Authenticate a specific User with their email address and password.
operationId: authenticateUser
tags:
- Users
requestBody:
required: true
description: >
Email address and plain-text password for the User being authenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
example:
email: jdoe@oregonstate.edu
password: hunter2
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: >
A JWT authentication token.
example: aaaaaaaa.bbbbbbbb.cccccccc
'400':
description: >
The request body was either not present or did not contain all of the required fields.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: >
The specified credentials were invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: >
An internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/users/{id}:
parameters:
- name: id
in: path
description: >
Unique ID of a User. Exact type/format will depend on your implementation but will likely be either an integer or a string.
schema:
oneOf:
- type: integer
- type: string
example: "123"
required: true
get:
summary: Fetch data about a specific User.
description: >
Returns information about the specified User. If the User has the 'instructor' role, the response should include a list of the IDs of the Courses the User teaches (i.e. Courses whose `instructorId` field matches the ID of this User). If the User has the 'student' role, the response should include a list of the IDs of the Courses the User is enrolled in. Only an authenticated User whose ID matches the ID of the requested User can fetch this information.
operationId: getUserById
tags:
- Users
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Course'
'403':
description: >
The request was not made by an authenticated User satisfying the authorization criteria described above.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Specified Course `id` not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/courses:
get:
summary: Fetch the list of all Courses.
description: >
Returns the list of all Courses. This list should be paginated. The Courses returned should not contain the list of students in the Course or the list of Assignments for the Course.
operationId: getAllCourses
tags:
- Courses
parameters:
- name: page
in: query
description: >
Page of Courses to fetch.
schema:
type: integer
example: 3
default: 1
- name: subject
in: query
description: >
Fetch only Courses with the specified subject code.
schema:
type: string
example: "CS"
- name: number
in: query
description: >
Fetch only Courses with the specified course number.
schema:
type: string
example: "493"
- name: term
in: query
description: >
Fetch only Courses in the specified academic term.
schema:
type: string
example: "sp19"
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
submissions:
type: array
items:
$ref: '#/components/schemas/Course'
post:
summary: Create a new course.
description: >
Creates a new Course with specified data and adds it to the application's database. Only an authenticated User with 'admin' role can create a new Course.
operationId: createCourse
tags:
- Courses
requestBody:
required: true
description: A Course object.
content:
application/json:
schema:
$ref: '#/components/schemas/Course'
responses:
'201':
description: New Course successfully added
content:
application/json:
schema:
type: object
properties:
id:
oneOf:
- type: integer
- type: string
description: >
Unique ID of the created Course. Exact type/format will depend on your implementation but will likely be either an integer or a string.
example: "123"
'400':
description: >
The request body was either not present or did not contain a valid Course object.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: >
The request was not made by an authenticated User satisfying the authorization criteria described above.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/courses/{id}:
parameters:
- name: id
in: path
description: >
Unique ID of a Course. Exact type/format will depend on your implementation but will likely be either an integer or a string.
schema:
oneOf:
- type: integer
- type: string
example: "123"
required: true
get:
summary: Fetch data about a specific Course.
description: >
Returns summary data about the Course, excluding the list of students enrolled in the course and the list of Assignments for the course.
operationId: getCourseById
tags:
- Courses
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Course'
'404':
description: Specified Course `id` not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
patch:
summary: Update data for a specific Course.
description: >
Performs a partial update on the data for the Course. Note that enrolled students and assignments cannot be modified via this endpoint. Only an authenticated User with 'admin' role or an authenticated 'instructor' User whose ID matches the `instructorId` of the Course can update Course information.
operationId: updateCourseById
tags:
- Courses
requestBody:
description: >
Partial updates to be applied to the specified Course.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Course'
responses:
'200':
description: Success
'400':
description: >
The request body was either not present or did not contain any fields related to Course objects.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: >
The request was not made by an authenticated User satisfying the authorization criteria described above.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Specified Course `id` not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
summary: Remove a specific Course from the database.
description: >
Completely removes the data for the specified Course, including all enrolled students, all Assignments, etc. Only an authenticated User with 'admin' role can remove a Course.
operationId: removeCourseById
tags:
- Courses
responses:
'204':
description: Success
'403':
description: >
The request was not made by an authenticated User satisfying the authorization criteria described above.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Specified Course `id` not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/courses/{id}/students:
parameters:
- name: id
in: path
description: >
Unique ID of a Course. Exact type/format will depend on your implementation but will likely be either an integer or a string.
schema:
oneOf:
- type: integer
- type: string
example: "123"
required: true
get:
summary: Fetch a list of the students enrolled in the Course.
description: >
Returns a list containing the User IDs of all students currently enrolled in the Course. Only an authenticated User with 'admin' role or an authenticated 'instructor' User whose ID matches the `instructorId` of the Course can fetch the list of enrolled students.
operationId: getStudentsByCourseId
tags:
- Courses
responses:
'200':
description: >
Array of User IDs for students enrolled in the Course. Exact type/format of IDs will depend on your implementation but each will likely be either an integer or a string.
content:
application/json:
schema:
type: object
properties:
students:
type: array
items:
oneOf:
- type: integer
- type: string
example: [ "123", "456" ]
'403':
description: >
The request was not made by an authenticated User satisfying the authorization criteria described above.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Specified Course `id` not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
summary: Update enrollment for a Course.
description: >
Enrolls and/or unenrolls students from a Course. Only an authenticated User with 'admin' role or an authenticated 'instructor' User whose ID matches the `instructorId` of the Course can update the students enrolled in the Course.
operationId: updateEnrollmentByCourseId
tags:
- Courses
requestBody:
required: true
description: >
Arrays of User IDs for students to be enrolled/unenrolled in the Course. Exact type/format of IDs will depend on your implementation but each will likely be either an integer or a string.
content:
application/json:
schema:
type: object
properties:
add:
type: array
items:
oneOf:
- type: integer
- type: string
description: Students to be enrolled in the Course.
example: [ "123", "456" ]
remove:
type: array
items:
oneOf:
- type: integer
- type: string
description: Students to be unenrolled from the Course.
example: [ "123", "456" ]
responses:
'200':
description: Success
'400':
description: >
The request body was either not present or did not contain the fields described above.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: >
The request was not made by an authenticated User satisfying the authorization criteria described above.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Specified Course `id` not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/courses/{id}/roster:
parameters:
- name: id
in: path
description: >
Unique ID of a Course. Exact type/format will depend on your implementation but will likely be either an integer or a string.
schema:
oneOf:
- type: integer
- type: string
example: "123"
required: true
get:
summary: Fetch a CSV file containing list of the students enrolled in the Course.
description: >
Returns a CSV file containing information about all of the students currently enrolled in the Course, including names, IDs, and email addresses. Only an authenticated User with 'admin' role or an authenticated 'instructor' User whose ID matches the `instructorId` of the Course can fetch the course roster.
operationId: getRosterByCourseId
tags:
- Courses
responses:
'200':
description: >
A CSV file containing information about all of the students currently enrolled in the Course, including names, IDs, and email addresses.
content:
text/csv:
schema:
type: string
example: |
123,"Jane Doe",doej@oregonstate.edu
...
'403':
description: >
The request was not made by an authenticated User satisfying the authorization criteria described above.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Specified Course `id` not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/courses/{id}/assignments:
parameters:
- name: id
in: path
description: >
Unique ID of a Course. Exact type/format will depend on your implementation but will likely be either an integer or a string.
schema:
oneOf:
- type: integer
- type: string
example: "123"
required: true
get:
summary: Fetch a list of the Assignments for the Course.
description: >
Returns a list containing the Assignment IDs of all Assignments for the Course.
operationId: getAssignmentsByCourseId
tags:
- Courses
responses:
'200':
description: >
Array of Assignment IDs for all of the Course's Assignments. Exact type/format of IDs will depend on your implementation but each will likely be either an integer or a string.
content:
application/json:
schema:
type: object
properties:
assignments:
type: array
items:
oneOf:
- type: integer
- type: string
example: [ "123", "456" ]
'404':
description: Specified Course `id` not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/assignments:
post:
summary: Create a new Assignment.
description: >
Create and store a new Assignment with specified data and adds it to the application's database. Only an authenticated User with 'admin' role or an authenticated 'instructor' User whose ID matches the `instructorId` of the Course corresponding to the Assignment's `courseId` can create an Assignment.
operationId: createAssignment
tags:
- Assignments
requestBody:
required: true
description: An Assignment object.
content:
application/json:
schema:
$ref: '#/components/schemas/Assignment'
responses:
'201':
description: New Assignment successfully added
content:
application/json:
schema:
type: object
properties:
id:
oneOf:
- type: integer
- type: string
description: >
Unique ID of the created Assignment. Exact type/format will depend on your implementation but will likely be either an integer or a string.
example: "123"
'400':
description: >
The request body was either not present or did not contain a valid Assignment object.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: >
The request was not made by an authenticated User satisfying the authorization criteria described above.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/assignments/{id}:
parameters:
- name: id
in: path
description: >
Unique ID of an Assignment. Exact type/format will depend on your implementation but will likely be either an integer or a string.
schema:
oneOf:
- type: integer
- type: string
example: "123"
required: true
get:
summary: Fetch data about a specific Assignment.
description: >
Returns summary data about the Assignment, excluding the list of Submissions.
operationId: getAssignmentById
tags:
- Assignments
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Assignment'
'404':
description: Specified Assignment `id` not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
patch:
summary: Update data for a specific Assignment.
description: >
Performs a partial update on the data for the Assignment. Note that submissions cannot be modified via this endpoint. Only an authenticated User with 'admin' role or an authenticated 'instructor' User whose ID matches the `instructorId` of the Course corresponding to the Assignment's `courseId` can update an Assignment.
operationId: updateAssignmentById
tags:
- Assignments
requestBody:
description: >
Partial updates to be applied to the specified Assignment.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Assignment'
responses:
'200':
description: Success
'400':
description: >
The request body was either not present or did not contain any fields related to Assignment objects.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: >
The request was not made by an authenticated User satisfying the authorization criteria described above.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Specified Assignment `id` not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
summary: Remove a specific Assignment from the database.
description: >
Completely removes the data for the specified Assignment, including all submissions. Only an authenticated User with 'admin' role or an authenticated 'instructor' User whose ID matches the `instructorId` of the Course corresponding to the Assignment's `courseId` can delete an Assignment.
operationId: removeAssignmentsById
tags:
- Assignments
responses:
'204':
description: Success
'403':
description: >
The request was not made by an authenticated User satisfying the authorization criteria described above.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Specified Assignment `id` not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/assignments/{id}/submissions:
parameters:
- name: id
in: path
description: >
Unique ID of an Assignment. Exact type/format will depend on your implementation but will likely be either an integer or a string.
schema:
oneOf:
- type: integer
- type: string
example: "123"
required: true
get:
summary: Fetch the list of all Submissions for an Assignment.
description: >
Returns the list of all Submissions for an Assignment. This list should be paginated. Only an authenticated User with 'admin' role or an authenticated 'instructor' User whose ID matches the `instructorId` of the Course corresponding to the Assignment's `courseId` can fetch the Submissions for an Assignment.
operationId: getSubmissionsByAssignmentId
tags:
- Assignments
parameters:
- name: page
in: query
description: >
Page of Submissions to fetch.
schema:
type: integer
example: 3
default: 1
- name: studentId
in: query
description: >
Fetch assignments only for the specified student ID. Exact type/format will depend on your implementation but will likely be either an integer or a string.
schema:
oneOf:
- type: integer
- type: string
example: "123"
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
submissions:
type: array
items:
$ref: '#/components/schemas/Submission'
'403':
description: >
The request was not made by an authenticated User satisfying the authorization criteria described above.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Specified Assignment `id` not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
summary: Create a new Submission for an Assignment.
description: >
Create and store a new Assignment with specified data and adds it to the application's database. Only an authenticated User with 'student' role who is enrolled in the Course corresponding to the Assignment's `courseId` can create a Submission.
operationId: createSubmission
tags:
- Assignments
requestBody:
required: true
description: A Submission object.
content:
multipart/formdata:
schema:
$ref: '#/components/schemas/Submission'
responses:
'201':
description: New Submission successfully added
content:
application/json:
schema:
type: object
properties:
id:
oneOf:
- type: integer
- type: string
description: >
Unique ID of the created Submission. Exact type/format will depend on your implementation but will likely be either an integer or a string.
example: "123"
'400':
description: >
The request body was either not present or did not contain a valid Submission object.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: >
The request was not made by an authenticated User satisfying the authorization criteria described above.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Specified Assignment `id` not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
User:
description: >
An object representing information about a Tarpaulin application user.
type: object
properties:
name:
type: string
description: Full name of the User.
example: Jane Doe
email:
type: string
description: >
Email address for the User. This is required to be unique among all Users.
example: doej@oregonstate.edu
password:
type: string
description: >
The User's plain-text password. This is required when creating a new User and when logging in.
example: hunter2
role:
type: string
enum: [admin, instructor, student]
description: >
Permission role of the User. Can be either 'admin', 'instructor', or 'student'.
default: student
Course:
description: >
An object representing information about a specific course.
type: object
properties:
subject:
type: string
description: Short subject code.
example: CS
number:
type: string
description: Course number.
example: 493
title:
type: string
description: Course title.
example: Cloud Application Development
term:
type: string
description: Academic term in which Course is offered.
example: sp19
instructorId:
oneOf:
- type: integer
- type: string
description: >
ID for Course instructor. Exact type/format will depend on your implementation but will likely be either an integer or a string. This ID must correspond to a User with the 'instructor' role.
example: "123"
Assignment:
description: >
An object representing information about a single assignment.
type: object
properties:
courseId:
oneOf:
- type: integer
- type: string
description: >
ID of the Course associated with the Assignment. Exact type/format will depend on your implementation but will likely be either an integer or a string.
example: "123"
title:
type: string
description: Assignment description.
example: Assignment 3
points:
type: integer
description: Possible points for the Assignment.
example: 100
due:
type: string
format: date-time
description: >
Date and time Assignment is due. Should be in ISO 8601 format.
example: "2019-06-14T17:00:00-07:00"
Submission:
description: >
An object representing information about a single student submission for an Assignment.
type: object
properties:
assignmentId:
oneOf:
- type: integer
- type: string
description: >
ID of the Assignment to which the Submission corresponds. Exact type/format will depend on your implementation but will likely be either an integer or a string.
example: "123"
studentId:
oneOf:
- type: integer
- type: string
description: >
ID of the Student who created the submission. Exact type/format will depend on your implementation but will likely be either an integer or a string.
example: "123"
timestamp:
type: string
format: date-time
description: >
Date and time Submission was made. Should be in ISO 8601 format.
example: "2019-06-14T17:00:00-07:00"
file:
type: string
description: >
When the Submission is being created, this will be the binary data contained in the submitted file. When Submission information is being returned from the API, this will contain the URL from which the file can be downloaded.
Error:
description: >
An object representing an error response from the API.
type: object
properties:
error:
type: string
description: A message describing the Error.
tags:
- name: Users
description: >
API endpoints related to application Users.
- name: Courses
description: >
API endpoints related to Courses.
- name: Assignments
description: >
API endpoints related to Assignments.