forked from andrea-lorenzetti/book-and-drive
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathoas3.yaml
1092 lines (1068 loc) · 35.3 KB
/
oas3.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
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.0
info:
version: '1.0'
title: "Book and Drive"
description: API for managing prenotations of drivings for a driving school.
license:
name: MIT
servers:
- url: http://localhost:8000/api/v1
description: Localhost
paths:
/autenticazione_studenti:
post:
description: >-
Authenticate a student that request to use the functionalities accessible for the students
summary: Authenticate a student
requestBody:
content:
application/json:
schema:
type: object
required:
- username_studente
- password
properties:
username_studente:
type: string
description: 'The username of the student'
password:
type: string
description: 'The passsword that the student used to sign in the application'
responses:
'401':
description: 'The student username was not found or the password was wrong'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'Studente non trovato o password errata'
'200':
description: 'successfull authenitcation and token created and send to the user'
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: 'token that contains the username, the role of the user, and the time of expritation. All encoded with a secret key '
/autenticazione_segreteria:
post:
description: >-
Authenticate a secretariat that request to use the functionalities accessible for the students
summary: Authenticate a secretariat
requestBody:
content:
application/json:
schema:
type: object
required:
- username_secretariat
- password
properties:
username_secretariat:
type: string
description: 'The username of the secretariat'
password:
type: string
description: 'The passsword that the secretariat'
responses:
'401':
description: 'The secretariat username was not found or the password was wrong'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'username_segreteria non trovato o password errata'
'200':
description: 'successfull authenitcation and token created and send to the user'
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: 'token that contains the username, the role of the user, and the time of expritation. All encoded with a secret key '
/autenticazione_istruttori:
post:
description: >-
Authenticate a student that request to use the functionalities accessible for the students
summary: Authenticate an istructor
requestBody:
content:
application/json:
schema:
type: object
required:
- username_istruttore
- password
properties:
username_istruttore:
type: string
description: 'The username of the istructor'
password:
type: string
description: 'The passsword that the istructor used to sign in the application'
responses:
'401':
description: 'The istructor username was not found or the password was wrong'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'Studente non trovato o password errata'
'200':
description: 'successfull authenitcation and token created and send to the user'
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: 'token that contains the username, the role of the user, and the time of expritation. All encoded with a secret key '
/segreteria/guideStudente:
get:
description: >-
Gets the list of all student prenotations.
summary: View all student prenotations
parameters:
- in: query
name: _id
schema:
type: string
required: true
description: 'The id of the student whose prenotations you want to see'
responses:
'404':
description: 'The student specified does not exist'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'Questo studente non esiste, controlla se lo hai inserito correttamente!'
'400':
description: 'The student id is not passed'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'L id dello studente non è stato specificato'
'204':
description: 'The student doenst have any guide'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'Questo studente al momento non ha guide prenotate o fatte'
'200':
description: "Return all the student prenotations"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Prenotazione'
/registrazione/nuovoIstruttore:
post:
description: >-
Register a new istructor.
summary: Register a new istructor
requestBody:
content:
application/json:
schema:
type: object
required:
- _id
- password
- telefono
properties:
_id:
type: string
description: 'The id of the istructor'
password:
type: string
description: 'The passsword that the istructor used to sign in the application'
telefono:
type: string
description: 'The phone number of the istructor'
responses:
'500':
description: 'Something went wrong'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'Qualcosa non è andato a buon fine'
'406':
description: 'You forgot to fill some fields'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'Ops, hai dimenticato di riempire dei campi!'
'201':
description: 'The student doenst have any guide'
content:
application/json:
schema:
type: object
properties:
mode_user:
type: string
username:
type: string
message:
type: string
description: 'Registrazione andata a buon fine, verrai redirezionato alla pagina di login...'
/registrazione/nuovoStudente:
post:
description: >-
Register a new student.
summary: Register a new student
requestBody:
content:
application/json:
schema:
type: object
required:
- _id
- password
- nome
- cognome
- dataNascita
- telefono
- email
properties:
_id:
type: string
description: 'The foglio rosa ID of the student'
password:
type: string
description: 'The passsword that the student used to sign in the application'
nome:
type: string
description: 'First name of the student'
cognome:
type: string
description: 'Last name of the student'
dataNascita:
type: string
description: 'The date of birth of the student'
telefono:
type: string
description: 'The phone number of the student'
email:
type: string
description: 'The email of the student'
responses:
'500':
description: 'Something went wrong'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'Qualcosa non è andato a buon fine'
'409':
description: 'This student already exist'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'Questo studente esiste già nel database'
'406':
description: 'You forgot to fill some fields'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'Ops, hai dimenticato di riempire dei campi!'
'201':
description: 'The student doenst have any guide'
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: 'Registrazione andata a buon fine, verrai redirezionato alla pagina di login...'
/prenotazioni/mieGuide:
get:
description: >-
Gets the list of student's prenotations.
summary: View student's prenotations
parameters:
- in: query
name: token
schema:
type: string
required: true
description: 'This token is available after the login and is used to contain the role and the username of the user'
responses:
'400':
description: 'The student is not specified or something went wrong during the query'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'Studente non trovato'
'200':
description: 'Student found, return all his prenotations'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Prenotazione'
'404':
description: 'error student not found'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'describes what kind of error is happend'
'500':
description: 'error in database'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'describes what kind of error is happend on the db side'
'403':
description: 'error in token checker'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'the token was invalid or not defined'
/prenotazioni/modificaPresenza:
post:
description: >-
Change the presence of a student to a drive
summary: Change presence of a student
parameters:
- in: query
name: token
schema:
type: string
required: true
description: 'This token is available after the login and is used to contain the role and the username of the user'
- in: query
name: id_guida
schema:
type: string
required: true
description: 'the id of the drive wich the student has attended or not'
responses:
'404':
description: 'Server error no drive or istructos found or database error'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'database error'
'403':
description: 'error in token checker'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'the token was invalid or not defined'
'401':
description: 'lack of authorization'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: ' error because the istructor can only change the students presence in the drive in which he is istructor'
'200':
description: 'successfull update'
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 'describe if the modification was successfull(true) or failed(false)'
data:
type: object
description: 'the data returned by the update function of mongoose'
/istruttori/prenotazioniIstruttore:
post:
description: >-
Retrieve all the drive with an istructor
summary: Change presence of a student
parameters:
- in: query
name: token
schema:
type: string
required: true
description: 'This token is available after the login and is used to contain the role and the username of the user'
responses:
'404':
description: 'username in the token not exists in db'
content:
application/json:
schema:
type: object
properties:
error:
type: string
'403':
description: 'error in token checker'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'the token was invalid or not defined'
'200':
description: 'successfull data retrieve'
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 'describe if the modification was successfull(true) or failed(false)'
data:
type: array
description: 'the prenotations in which the istructor is the teacher'
'202':
description: 'successfull but there are no data'
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 'describe if the modification was successfull(true) or failed(false)'
message:
type: string
description: 'message that says there are no prenotation for the istructor_username in the token'
/segreteria/guideStudenti:
get:
description: >-
Gets the list of all students' prenotations.
summary: View all students' prenotations
responses:
'200':
description: "Return all the students' prenotations"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Prenotazione'
/studenti/me:
get:
description: >-
Shows the student personal data.
summary: "Student personal data visualization."
parameters:
- in: query
name: token
schema:
type: string
required: true
description: This token is available after the login and is used to contain the role and the username of the user
responses:
'200':
description: 'User found, data correctly retrieved.'
content:
application/json:
schema:
type: array
items:
type: object
properties:
_id:
type: string
description: 'Foglio rosa ID (username of student account)'
nome:
type: string
description: 'First name of student'
cognome:
type: string
description: 'Last name of student'
dataNascita:
type: string
format: date-time
description: 'Date of birth of student'
telefono:
type: string
description: 'Phone number of the student'
email:
type: string
description: 'Email address of the student'
'400':
description: 'Server error'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'Cannot load user data'
'403':
description: 'error in token checker'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'the token was invalid or not defined'
/segreteria/resocontoStudenti:
get:
description: >-
Shows the personal data of all students.
summary: "Student personal data visualization."
responses:
'200':
description: 'The data of all the students have been retrieved.'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Studente'
/segreteria/resocontoStudente:
get:
description: >-
Shows the personal data of a single student.
summary: "Single student personal data visualization."
parameters:
- in: query
name: _id
schema:
type: string
required: true
description: 'The id of the student to see'
responses:
'200':
description: 'The data of the student have been retrieved.'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Studente'
'400':
description: 'error in retrieving data'
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: 'Failed in retrieving data'
/istruttori/verificaDisponibilita:
get:
description: >-
Get the available istructors for a time slot of a certain date.
summary: Retrieve available istructors
parameters:
- in: query
name: token
schema:
type: string
required: true
description: This token is available after the login and is used to contain the role and the username of the user
- in: query
name: slot
schema:
type: string
format: date-time
required: true
description: 'The slot format must be ISO 8601: YYYY-MM-DDThh:mm:ss.sssZ'
responses:
'200':
description: 'There are available istructors and their usernames are in the body'
content:
application/json:
schema:
type: array
items:
type: object
properties:
_id:
type: string
description: 'username_istruttore '
telefono:
type: string
description: 'phone number of the istructors'
'203':
description: 'No available istructors for that time slot'
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: 'No istructors available'
'400':
description: 'time slot error'
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: 'the format of the date and time was not as required'
'404':
description: 'Server error'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'describes the error that took place in the server'
'403':
description: 'error in token checker'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'the token was invalid or not defined'
/prenotazioni/prenotaGuida:
post:
description: >-
Book a drive with an istructor for a certain time slot.
summary: 'Make new reservation'
parameters:
- in: query
name: token
schema:
type: string
required: true
description: This token is available after the login and is used to contain the role and the username of the user
requestBody:
content:
application/json:
schema:
type: object
required:
- username_istruttore
- slot
properties:
username_istruttore:
type: string
description: 'The username of the istructor'
slot:
type: string
format: date-time
description: 'The time slot of the reservation'
responses:
'208':
description: 'The prenotation the student intend to make already exists'
content:
application/json:
schema:
type: object
properties:
URI:
type: string
description: 'URI: link to the prenotation that already exsists: /api/v1/prenotazioni/id'
message:
type: string
description: 'message to display for the user in wich the server reports that the prenotation already exists'
'201':
description: 'success in booking the drive'
content:
application/json:
schema:
type: object
properties:
sleg:
type: string
description: 'URI: link to the new prenotation: /api/v1/prenotazioni/id'
message:
type: string
description: 'message to display for the user: booking successfully'
prenotazione:
$ref:'#/components/schemas/Prenotazione'
'404':
description: 'Server error'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'describes the error that took place in the server'
'400':
description: 'time slot error or username stu/istr not found'
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: 'the format of the date and time was not as required or the student/istructor username does not exists'
'403':
description: 'error in token checker'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'the token was invalid or not defined'
/prenotazioni/annullaGuida:
delete:
description: >-
Cancel a prenotation by its ID.
summary: 'Remove a reservation'
parameters:
- in: query
name: token
schema:
type: string
required: true
description: This token is available after the login and is used to contain the role and the username of the user
- in: query
name: _id
schema:
type: string
required: true
description: 'contains the id of the drive that the user want to remove'
responses:
'200':
description: 'reservation removed successfully'
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: 'successfull message for the user'
'401':
description: 'Server error'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'describes the error that took place in the server'
'403':
description: 'error in token checker'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'the token was invalid or not defined'
/istruttori/visualizzaImpegni:
get:
description: >-
Shows istructor prenotation.
summary: "Istructor prenotation visualization."
parameters:
- in: query
name: token
schema:
type: string
required: true
description: This token is available after the login and is used to contain the role and the username of the user
responses:
'200':
description: 'Prenotation found, data correctly retrieved or the data was correctly retrieved and but there are no appointments.'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Prenotazione'
'400':
description: 'Server error'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'Cannot load user prenotation'
'403':
description: 'error in token checker'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'the token was invalid or not defined'
/segreteria/modificaStudente:
put:
description: >-
Modify student data
summary: Modify data of a student
requestBody:
content:
application/json:
schema:
type: object
items:
- foglio_rosa
- nome
- cognome
- data_nascita
- telefono
- email
properties:
foglio_rosa:
type: string
description: 'Foglio rosa ID (username of student account)'
nome:
type: string
description: 'First name of student'
cognome:
type: string
description: 'Last name of student'
dataNascita:
type: string
format: date-time
description: 'Date of birth of student'
telefono:
type: string
description: 'Phone number of the student'
email:
type: string
description: 'Email address of the student'
responses:
'200':
description: 'Student correctly modified'
content:
application/json:
schema:
type: object
items:
- message
properties:
message:
type: string
description: 'Operation successfully completed message'
'400':
description: 'Unexpected error'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'Error message'
/help:
get:
description: >-
Gets the description of the funcitonalities that the user can use.
summary: Get description of functionalities
parameters:
- in: query
name: token
schema:
type: string
required: true
description: 'This token is available after the login and is used to contain the role and the username of the user'
responses:
'400':
description: 'the role of the user was not find or is inconsistent with the types of user available in the system'
content:
application/json:
schema:
type: object
properties:
error:
type: string
'200':
description: 'The user has a valid role in the token'
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: 'contains the message that will be desplayed to the user based on its role. It describes what the use can do'
'403':
description: 'error in token checker'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 'the token was invalid or not defined'