-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathschema.yml
2797 lines (2698 loc) · 74.1 KB
/
schema.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
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
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: ''
version: 0.0.0
paths:
/api/classrooms/:
get:
operationId: classrooms_list
description: |-
API view to retrieve a list of classrooms created by the authenticated teacher.
This view is accessible only to authenticated users who have a `TeacherProfile`.
The view will return a list of all classrooms created by the authenticated teacher.
Permissions:
- `IsAuthenticated`: Ensures that the user is logged in.
- `IsTeacher`: Ensures that the user has a `TeacherProfile`.
Serializer:
- Uses the `ClassroomSerializer` to serialize the classroom data.
Methods:
- `get_queryset`: Retrieves the list of classrooms for the authenticated teacher.
tags:
- classrooms
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Classroom'
description: ''
/api/classrooms/{classroom_id}/posts/:
get:
operationId: classrooms_posts_list
description: |-
API view to list all CoursePost objects for a specific classroom.
This view handles the retrieval of CoursePost objects, ensuring that the
user is authenticated and is a member of the specified classroom.
Attributes:
serializer_class (Serializer): The serializer class to use for
serializing output.
permission_classes (list): A list of permission classes that the user
must pass to access this view.
parameters:
- in: path
name: classroom_id
schema:
type: string
format: uuid
required: true
tags:
- classrooms
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CoursePost'
description: ''
/api/classrooms/{classroom_id}/posts/{post_id}/:
get:
operationId: classrooms_posts_retrieve
description: |-
Handles GET requests to retrieve the CoursePost object.
Args:
request (Request): The HTTP request object.
classroom_id (uuid): The ID of the classroom.
post_id (uuid): The ID of the CoursePost object.
*args: Additional arguments.
**kwargs: Additional keyword arguments.
Returns:
Response: The serialized CoursePost object and a 200 OK status.
parameters:
- in: path
name: classroom_id
schema:
type: string
format: uuid
required: true
- in: path
name: post_id
schema:
type: string
format: uuid
required: true
tags:
- classrooms
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CoursePost'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
put:
operationId: classrooms_posts_update
description: |-
Handles PUT requests to update the CoursePost object.
Args:
request (Request): The HTTP request object.
classroom_id (uuid): The ID of the classroom.
post_id (uuid): The ID of the CoursePost object.
*args: Additional arguments.
**kwargs: Additional keyword arguments.
Returns:
Response: The serialized updated CoursePost object and a 200 OK status.
parameters:
- in: path
name: classroom_id
schema:
type: string
format: uuid
required: true
- in: path
name: post_id
schema:
type: string
format: uuid
required: true
tags:
- classrooms
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CoursePost'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CoursePost'
multipart/form-data:
schema:
$ref: '#/components/schemas/CoursePost'
required: true
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CoursePost'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
delete:
operationId: classrooms_posts_destroy
description: |-
Handles DELETE requests to delete the CoursePost object.
Args:
request (Request): The HTTP request object.
classroom_id (uuid): The ID of the classroom.
post_id (uuid): The ID of the CoursePost object.
*args: Additional arguments.
**kwargs: Additional keyword arguments.
Returns:
Response: A 204 No Content status.
parameters:
- in: path
name: classroom_id
schema:
type: string
format: uuid
required: true
- in: path
name: post_id
schema:
type: string
format: uuid
required: true
tags:
- classrooms
security:
- jwtAuth: []
responses:
'204':
description: No response body
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/api/classrooms/{classroom_id}/posts/{post_id}/comments/:
get:
operationId: classrooms_posts_comments_list
description: |-
API view to retrieve a list of Comment objects for a specific post.
This view handles GET requests to list all comments associated with a specific post,
ensuring that the user is authenticated and a member of the classroom associated with the post.
Attributes:
serializer_class (Serializer): The serializer class for Comment objects.
permission_classes (list): The list of permission classes that the user must pass to access this view.
Methods:
get_queryset: Retrieves the queryset of comments for the specified post, ensuring that the post exists
and that the user has the appropriate permissions.
parameters:
- in: path
name: classroom_id
schema:
type: string
format: uuid
required: true
- in: path
name: post_id
schema:
type: string
format: uuid
required: true
tags:
- classrooms
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Comment'
description: ''
/api/classrooms/{classroom_id}/posts/{post_id}/comments/{comment_id}/:
get:
operationId: classrooms_posts_comments_retrieve
description: |-
Handles GET requests to retrieve the comment.
Args:
request (Request): The HTTP request object.
classroom_id (uuid): The ID of the classroom.
post_id (uuid): The ID of the post.
comment_id (uuid): The ID of the comment.
Returns:
Response: The response containing the serialized comment data and HTTP status 200 OK.
parameters:
- in: path
name: classroom_id
schema:
type: string
format: uuid
required: true
- in: path
name: comment_id
schema:
type: string
format: uuid
required: true
- in: path
name: post_id
schema:
type: string
format: uuid
required: true
tags:
- classrooms
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Comment'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
put:
operationId: classrooms_posts_comments_update
description: |-
Handles PUT requests to update the comment.
Args:
request (Request): The HTTP request object.
classroom_id (uuid): The ID of the classroom.
post_id (uuid): The ID of the post.
comment_id (uuid): The ID of the comment.
Returns:
Response: The response containing the serialized updated comment data and HTTP status 200 OK.
parameters:
- in: path
name: classroom_id
schema:
type: string
format: uuid
required: true
- in: path
name: comment_id
schema:
type: string
format: uuid
required: true
- in: path
name: post_id
schema:
type: string
format: uuid
required: true
tags:
- classrooms
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Comment'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Comment'
multipart/form-data:
schema:
$ref: '#/components/schemas/Comment'
required: true
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Comment'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
delete:
operationId: classrooms_posts_comments_destroy
description: |-
Handles DELETE requests to delete the comment.
Args:
request (Request): The HTTP request object.
classroom_id (uuid): The ID of the classroom.
post_id (uuid): The ID of the post.
comment_id (uuid): The ID of the comment.
Returns:
Response: The response with HTTP status 204 NO CONTENT.
parameters:
- in: path
name: classroom_id
schema:
type: string
format: uuid
required: true
- in: path
name: comment_id
schema:
type: string
format: uuid
required: true
- in: path
name: post_id
schema:
type: string
format: uuid
required: true
tags:
- classrooms
security:
- jwtAuth: []
responses:
'204':
description: No response body
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/api/classrooms/{classroom_id}/posts/{post_id}/comments/create/:
post:
operationId: classrooms_posts_comments_create_create
description: |-
API view to create a new Comment object.
This view handles POST requests to create a new Comment object, ensuring that the user is authenticated
and a member of the classroom associated with the post.
Attributes:
queryset (QuerySet): The queryset of Comment objects.
serializer_class (Serializer): The serializer class for Comment objects.
permission_classes (list): The list of permission classes that the user must pass to access this view.
Methods:
get_serializer_context: Adds additional context to the serializer.
perform_create: Performs the creation of the Comment object and checks permissions.
parameters:
- in: path
name: classroom_id
schema:
type: string
format: uuid
required: true
- in: path
name: post_id
schema:
type: string
format: uuid
required: true
tags:
- classrooms
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Comment'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Comment'
multipart/form-data:
schema:
$ref: '#/components/schemas/Comment'
required: true
security:
- jwtAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Comment'
description: ''
/api/classrooms/{classroom_id}/posts/create/:
post:
operationId: classrooms_posts_create_create
description: |-
API view to create a new CoursePost.
This view handles the creation of a CoursePost object, ensuring that the
user is authenticated and is the owner of the associated classroom.
Attributes:
queryset (QuerySet): A queryset containing all CoursePost objects.
serializer_class (Serializer): The serializer class to use for
validating and deserializing input, and
for serializing output.
permission_classes (list): A list of permission classes that the user
must pass to access this view.
parameters:
- in: path
name: classroom_id
schema:
type: string
format: uuid
required: true
tags:
- classrooms
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CoursePost'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CoursePost'
multipart/form-data:
schema:
$ref: '#/components/schemas/CoursePost'
required: true
security:
- jwtAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CoursePost'
description: ''
/api/classrooms/{id}/:
get:
operationId: classrooms_retrieve
description: |-
Handle GET requests to retrieve the details of a specific classroom.
Args:
request: The HTTP request object.
pk (uuid): Primary key of the classroom to retrieve.
*args: Additional positional arguments.
**kwargs: Additional keyword arguments.
Returns:
Response: Response object containing serialized classroom data.
Raises:
Http404: If the classroom with the provided `pk` does not exist.
parameters:
- in: path
name: id
schema:
type: string
format: uuid
required: true
tags:
- classrooms
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Classroom'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
put:
operationId: classrooms_update
description: |-
Handle PUT requests to update a specific classroom.
Args:
request: The HTTP request object.
pk (uuid): Primary key of the classroom to update.
*args: Additional positional arguments.
**kwargs: Additional keyword arguments.
Returns:
Response: Response object containing serialized updated classroom data.
Raises:
Http404: If the classroom with the provided `pk` does not exist.
parameters:
- in: path
name: id
schema:
type: string
format: uuid
required: true
tags:
- classrooms
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Classroom'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Classroom'
multipart/form-data:
schema:
$ref: '#/components/schemas/Classroom'
required: true
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Classroom'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
delete:
operationId: classrooms_destroy
description: |-
Handle DELETE requests to delete a specific classroom.
Args:
request: The HTTP request object.
pk (uuid): Primary key of the classroom to delete.
*args: Additional positional arguments.
**kwargs: Additional keyword arguments.
Returns:
Response: Response object with status HTTP_204_NO_CONTENT.
Raises:
Http404: If the classroom with the provided `pk` does not exist.
parameters:
- in: path
name: id
schema:
type: string
format: uuid
required: true
tags:
- classrooms
security:
- jwtAuth: []
responses:
'204':
description: No response body
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/api/classrooms/create/:
post:
operationId: classrooms_create_create
description: |-
API view to create a new classroom.
This view is accessible only to authenticated users who have a `TeacherProfile`.
The view allows the authenticated teacher to create a new classroom.
Permissions:
- `IsAuthenticated`: Ensures that the user is logged in.
- `IsTeacher`: Ensures that the user has a `TeacherProfile`.
Serializer:
- Uses the `ClassroomSerializer` to serialize the classroom data.
Methods:
- `perform_create`: Associates the new classroom with the authenticated teacher.
tags:
- classrooms
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Classroom'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Classroom'
multipart/form-data:
schema:
$ref: '#/components/schemas/Classroom'
required: true
security:
- jwtAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Classroom'
description: ''
/api/login/:
post:
operationId: login_create
tags:
- login
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoginUser'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LoginUser'
multipart/form-data:
schema:
$ref: '#/components/schemas/LoginUser'
required: true
security:
- jwtAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoginUser'
description: Successful login
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
/api/logout/:
post:
operationId: logout_create
tags:
- logout
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoginUser'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LoginUser'
multipart/form-data:
schema:
$ref: '#/components/schemas/LoginUser'
required: true
security:
- jwtAuth: []
responses:
'205':
description: Reset Content
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
/api/profiles/students/:
get:
operationId: profiles_students_list
parameters:
- in: query
name: date_of_birth
schema:
type: string
format: date
- in: query
name: date_of_birth__month
schema:
type: number
- in: query
name: date_of_birth__month__gt
schema:
type: number
- in: query
name: date_of_birth__month__lt
schema:
type: number
- in: query
name: date_of_birth__year
schema:
type: number
- in: query
name: date_of_birth__year__gt
schema:
type: number
- in: query
name: date_of_birth__year__lt
schema:
type: number
- in: query
name: email
schema:
type: string
- in: query
name: firstname
schema:
type: string
- in: query
name: lastname
schema:
type: string
tags:
- profiles
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StudentProfile'
description: ''
/api/profiles/students/{id}/:
get:
operationId: profiles_students_retrieve
parameters:
- in: path
name: id
schema:
type: string
format: uuid
required: true
tags:
- profiles
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StudentProfile'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
put:
operationId: profiles_students_update
parameters:
- in: path
name: id
schema:
type: string
format: uuid
required: true
tags:
- profiles
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StudentProfile'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/StudentProfile'
multipart/form-data:
schema:
$ref: '#/components/schemas/StudentProfile'
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StudentProfile'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
delete:
operationId: profiles_students_destroy
parameters:
- in: path
name: id
schema:
type: string
format: uuid
required: true
tags:
- profiles
security:
- jwtAuth: []
responses:
'204':
description: No response body
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
/api/profiles/teachers/:
get:
operationId: profiles_teachers_list
parameters:
- in: query
name: date_of_birth
schema:
type: string
format: date
- in: query
name: date_of_birth__month
schema:
type: number
- in: query
name: date_of_birth__month__gt
schema:
type: number
- in: query
name: date_of_birth__month__lt
schema:
type: number
- in: query
name: date_of_birth__year
schema:
type: number
- in: query
name: date_of_birth__year__gt
schema:
type: number
- in: query
name: date_of_birth__year__lt
schema:
type: number
- in: query
name: email
schema:
type: string
- in: query
name: firstname
schema:
type: string
- in: query
name: lastname
schema:
type: string
- in: query
name: years_of_experience
schema:
type: integer
- in: query
name: years_of_experience__gte
schema:
type: integer
- in: query
name: years_of_experience__lte
schema:
type: integer
tags:
- profiles
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TeacherProfile'
description: ''
/api/profiles/teachers/{id}/:
get:
operationId: profiles_teachers_retrieve
parameters:
- in: path
name: id
schema:
type: string
format: uuid
required: true
tags:
- profiles
security:
- jwtAuth: []
responses:
'200':
content: