-
Notifications
You must be signed in to change notification settings - Fork 0
/
a7_openapi .yaml
849 lines (750 loc) · 22.2 KB
/
a7_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
openapi: 3.0.0
info:
version: "1.0"
title: "LBAW EVUP API"
description: "Web Resources Specification (A7) for EVUP"
servers:
- url: lbaw2252.lbaw.fe.up.pt
description: Production server
externalDocs:
description: Find more info here.
url: https://git.fe.up.pt/lbaw/lbaw2223/lbaw2252/-/wikis/home
tags:
- name: "M01: Authentication"
- name: "M02: Profile and User Information"
- name: "M03: Events"
- name: "M04: User Administration"
paths:
# M01: Authentication
/login:
get:
operationId: R101
summary: "R101: Login Form"
description: "Provide form for authentication. Access: PUB"
tags:
- "M01: Authentication"
responses:
"200":
description: "Ok. Show Login form"
post:
operationId: R102
summary: "R102: Login action"
description: "Processes the login form submission. Access: PUB"
tags:
- "M01: Authentication"
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
email:
type: string
format: email
password:
type: string
format: password
required:
- email
- password
responses:
"302":
description: "Redirect after processing the login credentials."
headers:
Location:
schema:
type: string
examples:
302Success:
description: "Successful login. Redirect to homepage."
value: "/"
302Failure:
description: "Failed login. Redirect to login form."
value: "/login"
/logout:
get:
operationId: R103
summary: "R103: Logout action"
description: "Logout the current authenticated user. Access: USR"
tags:
- "M01: Authentication"
responses:
"302":
description: "Redirect after processing logout."
headers:
Location:
schema:
type: string
examples:
302Success:
description: "Successful logout. Redirect to homepage."
value: "/"
/signup:
get:
operationId: R104
summary: "R104: Sign-up Form"
description: "Provide form for new users. Access: PUB"
tags:
- "M01: Authentication"
responses:
"200":
description: "Ok. Show sign-up form"
post:
operationId: R105
summary: "R105: Sign-up action"
description: "Processes the new user sign-up form submission. Access: PUB"
tags:
- "M01: Authentication"
requestBody:
required: true
content:
# since we want to upload binary files (avatar)
multipart/form-data:
schema:
type: object
properties:
name:
type: string
email:
type: string
userPhoto:
type: string
format: binary
required:
- name
- email
- password
responses:
"302":
description: "Redirect after processing the new user sign-up form."
headers:
Location:
schema:
type: string
examples:
302Success:
description: "Successful registration. Redirect to user profile."
value: "/users/{id}"
302Failure:
description: "Failed registration. Redirect to sign-up form."
value: "/signup"
# M02: Profile and User Information
/user/{id}:
get:
operationId: R201
summary: "R201: View your own profile"
description: "Show the individual user profile. Access: OWN"
tags:
- "M02: Profile and User Information"
parameters:
- in: path
name: id
schema:
type: integer
required: true
responses:
"200":
description: "Ok. Show user profile (UI20)"
"404":
description: "User not found"
/user/{id}/public:
get:
operationId: R202
summary: "R202: View public user profile"
description: "Show the individual public user profile. Access: PUB"
tags:
- "M02: Profile and User Information"
parameters:
- in: path
name: id
schema:
type: integer
required: true
responses:
"200":
description: "Ok. Show user profile (UI20)"
"404":
description: "User not found"
/user/{id}/edit:
get:
operationId: R203
summary: "R203: User profile edition form"
description: "Provide form for user profile edition. Access: OWN"
tags:
- "M02: Profile and User Information"
parameters:
- in: path
name: id
schema:
type: integer
required: true
responses:
"200":
description: "Ok. Show user profile edition form"
"401":
description: "Unauthorized. Must be authenticated"
"403":
description: "Forbidden. Must be owner of the profile"
"404":
description: "User not found"
post:
operationId: R204
summary: "R204 : Edit profile action"
description: "Processes the profile edition form. Access: OWN"
tags:
- "M02: Profile and User Information"
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
username:
type: string
email:
type: string
name:
type: string
required:
- username
- email
- name
responses:
"302":
description: "Redirect after processing the profile edit form."
headers:
Location:
schema:
type: string
examples:
302Success:
description: "Successful profile edition. Redirect to profile Page."
value: "/user/{id}"
302Failure:
description: "Failed profile edition. Redirect to profile form."
value: "/user/{id}"
/user/accept/{id}:
put:
operationId: R205
summary: "R205: Accepts an invite"
description: "Accepts an invite to an event that the user received. Access: OWN"
tags:
- "M02: Profile and User Information"
parameters:
- in: path
name: id
schema:
type: integer
required: true
responses:
"200":
description: "Ok. Show user events organized"
"401":
description: "Unauthorized. Must be authenticated"
"403":
description: "Forbidden. Must be owner of the profile"
"404":
description: "Invite not found"
/user/deny/{id}:
put:
operationId: R206
summary: "R206: Does not accept an invite"
description: "Does not accept an invite to an event that the user received. Access: OWN"
tags:
- "M02: Profile and User Information"
parameters:
- in: path
name: id
schema:
type: integer
required: true
responses:
"200":
description: "Ok. Show user events organized"
"401":
description: "Unauthorized. Must be authenticated"
"403":
description: "Forbidden. Must be owner of the profile"
"404":
description: "Invite not found"
# M03 : Events
/event/{id}:
get:
operationId: R301
summary: "R301: View event page"
description: "Show the individual event page. Access: USR"
tags:
- "M03: Events"
parameters:
- in: path
name: id
schema:
type: integer
required: true
responses:
"200":
description: "Ok. Show event page"
"404":
description: "Event not found"
post:
operationId: R302
summary: "R302: Edit event page action"
description: "Processes the event edit page form submission. Access: OWN"
tags:
- "M03: Events"
parameters:
- in: path
name: id
schema:
type: integer
required: true
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
eventName:
type: string
address:
type: string
description:
type: string
eventPhoto:
type: string
format: binary
startDate:
type: string
format: date
endDate:
type: string
format: date
responses:
"302":
description: "Redirect after processing the event updated information."
headers:
Location:
schema:
type: string
examples:
302Success:
description: "Successful event edition. Redirect to event page."
value: "/event/{id}"
302Failure:
description: "Failed event edition. Redirect to edit event form."
value: "/event/{id}/edit"
/event/{id}/edit:
get:
operationId: R303
summary: "R303 : Event edition form"
description: "Provide a form for event edition. Access: OWN"
tags:
- "M03: Events"
parameters:
- in: path
name: id
schema:
type: integer
required: true
responses:
"200":
description: "OK. Show event edition form"
"401":
description: "Unauthorized. Must be authenticated."
"403":
description: "Unauthorized. Must be the owner of the event"
"404":
description: "Event not found"
/event/{id}/searchUsers:
post:
operationId: R304
description: "Show Search Page given a search type and value. Access: PUB"
tags:
- "M03: Events"
parameters:
- in: path
name: id
schema:
type: integer
required: true
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
eventid:
type: integer
search:
type: string
responses:
"200":
description: "OK."
/event/{id}/inviteUsers:
post:
operationId: R305
description: "Invite users to an event. Access: PUB"
tags:
- "M03: Events"
parameters:
- in: path
name: id
schema:
type: integer
required: true
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
eventid:
type: integer
search:
type: string
responses:
"200":
description: "OK"
/event/{id}/attendees:
get:
operationId: R306
description: "Get attendees of an event. Access: ATT"
tags:
- "M03: Events"
parameters:
- in: path
name: id
schema:
type: integer
required: true
responses:
"200":
description: "OK."
/event/{id}/adduser:
get:
operationId: R307
description: "Get list of users not attending event. Access: ATT"
tags:
- "M03: Events"
parameters:
- in: path
name: id
schema:
type: integer
required: true
responses:
"200":
description: "OK."
/event/{eventid}/adduser/{userid}:
post:
operationId: R308
description: "Adds users to an event. Access: ORG"
tags:
- "M03: Events"
parameters:
- in: path
name: eventid
schema:
type: integer
required: true
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
eventid:
type: integer
userid:
type: integer
responses:
"200":
description: "OK."
/event/{eventid}/removeuser/{userid}:
post:
operationId: R309
description: "Removes users of an event. Access: ORG"
tags:
- "M03: Events"
parameters:
- in: path
name: eventid
schema:
type: integer
required: true
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
eventid:
type: integer
userid:
type: integer
responses:
"200":
description: "OK."
/myEvents:
get:
operationId: R310
description: "Get events user is attending/has attending. Access: USR"
tags:
- "M03: Events"
responses:
"200":
description: "OK."
/myEvents/organizing:
get:
operationId: R311
description: "Get events user is organizing. Access: ORG"
tags:
- "M03: Events"
responses:
"200":
description: "OK."
/myEvents/createEvent:
get:
operationId: R312
description: "Get forms to create event. Access: ORG"
tags:
- "M03: Events"
responses:
"200":
description: "OK."
post:
operationId: R313
description: "Leave event user is attending/has attendend. Access: ORG"
tags:
- "M03: Events"
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
eventname:
type: string
eventadress:
type: string
public:
type: boolean
description:
type: string
startdate:
type: string
enddate:
type: string
parameters:
- in: path
name: id
schema:
type: integer
required: true
responses:
"200":
description: "OK."
"401":
description: "Unauthorized. Must be authenticated"
"403":
description: "Forbidden. Must be owner of the event"
"404":
description: "Event not found"
/myEvents/{id}:
post:
operationId: R314
summary: "R305: "
description: "Leave event user is attending/has attendend. Access: ORG"
tags:
- "M03: Events"
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
eventid:
type: integer
parameters:
- in: path
name: id
schema:
type: integer
required: true
responses:
"200":
description: "OK."
"401":
description: "Unauthorized. Must be authenticated"
"403":
description: "Forbidden. Must be attendee of the event"
"404":
description: "Event not found"
# M04: User Administration
/admin:
get:
operationId: R401
summary: "R401: Administration Panel"
description: "Administration Page. Access: ADM"
tags:
- "M04: User Administration"
responses:
"200":
description: "Ok. Access to administration page"
"400":
description: "Bad request."
"401":
description: "Unauthorized. Not logged in"
"403":
description: "Forbidden. No permissions"
"404":
description: "Not found"
/admin/reports/{report_id}/close:
put:
operationId: R402
summary: "R402: Close a report"
description: "Processes a report and closes it"
tags:
- "M04: User Administration"
parameters:
- in: path
name: report_id
schema:
type: integer
required: true
responses:
"200":
description: "Ok. Report closed successfully."
/admin/organizerRequests/{organizerRequests_id}/deny:
put:
operationId: R403
summary: "R403: Denies an organizer requests"
description: "Processes an organizer requests and denies it"
tags:
- "M04: User Administration"
parameters:
- in: path
name: organizerRequests_id
schema:
type: integer
required: true
responses:
"200":
description: "Ok. Organizer Request denied successfully."
/admin/organizerRequests/{organizerRequests_id}/accept:
put:
operationId: R404
summary: "R404: Accepts an organizer requests"
description: "Processes an organizer requests and accepts it"
tags:
- "M04: User Administration"
parameters:
- in: path
name: organizerRequests_id
schema:
type: integer
required: true
responses:
"200":
description: "Ok. Organizer Request accepted successfully."
/admin/users:
get:
operationId: R405
summary: "R405: View users"
description: "Page with information about all users. Access: ADM"
tags:
- "M02: Profile and User Information"
- "M04: User Administration"
responses:
"200":
description: "Ok. Show users "
"400":
description: "Bad request."
"401":
description: "Unauthorized. Not logged in"
"403":
description: "Forbidden. No permissions"
"404":
description: "Not found"
/admin/users/search:
get:
operationId: R406
summary: "R406 : User search"
description: "Provides a page component with a list of users. Access: ADM"
tags:
- "M02: Profile and User Information"
- "M04: User Administration"
parameters:
- in: query
name: value
description: "string used for full-text search"
schema:
type: string
required: true
responses:
"200":
description: "OK. Show a list of users that fit the query."
/admin/users/add:
get:
operationId: R407
summary: "R407: Admin Add User Form"
description: "Administration Page to add a new user to the platform. Access: ADM"
tags:
- "M04: User Administration"
responses:
"200":
description: "Ok. Access to administration page"
"400":
description: "Bad request."
"401":
description: "Unauthorized. Not logged in"
"403":
description: "Forbidden. No permissions"
"404":
description: "Not found"
post:
operationId: R408
summary: "R408: Admin Add User Action"
description: "Adds a new user to the platform. Access: ADM"
tags:
- "M04: User Administration"
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
username:
type: string
email:
type: string
password:
type: string
required:
- name
- username
- email
- password
responses:
"200":
description: "Ok. Access to administration page"
"400":
description: "Bad request."
"401":
description: "Unauthorized. Not logged in"
"403":
description: "Forbidden. No permissions"
"404":
description: "Not found"