-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
911 lines (911 loc) · 26.8 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
openapi: "3.0.0"
info:
description: API for the Web-Engineering II project hAPPy
version: "0.5"
title: hAPPy
license:
name: MIT License
url: https://opensource.org/licenses/MIT
contact:
email: mailfrom.happy.team@gmail.com
servers:
- url: https://backend.happy-service.ml
tags:
- name: authentication
description: "All resources related to authentication"
- name: user
description: "All resources related to user"
- name: upload
description: "All resources related to upload"
- name: analysis
description: "All resources related to analysis"
- name: statistic
description: "All resources related to statistics"
paths:
/verifyAccount/{hash}:
get:
tags:
- authentication
operationId: authentication-verifyAccount
description: "Verifies a account."
parameters:
- in: path
name: hash
description: "The validation hash which will identify the verification link for the user."
required: true
schema:
type: string
responses:
200:
description: "User successfully activated."
content:
application/json:
schema:
$ref: "#/components/schemas/WrapperUserToken"
example:
message: "User successfully activated."
data:
user:
id: 1
active: false
name: "test"
email: "test@test.com"
password: ""
salt: ""
analysisCount: 0
passwordReset: false
token: "JWT_TOKEN"
404:
description: "Activation link invalid."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "Activation link invalid."
/api/verifyToken:
get:
tags:
- authentication
operationId: authentication-verifyToken
description: "Checks if a JWT Token is valid."
parameters:
- $ref: "#/components/parameters/JWT"
responses:
200:
description: "User exist."
content:
application/json:
schema:
$ref: "#/components/schemas/WrapperUser"
example:
message: "Checks if a JWT Token is valid."
data:
user:
id: 1
active: false
name: "test"
email: "test@test.com"
password: ""
salt: ""
analysisCount: 0
passwordReset: false
401:
$ref: "#/components/responses/Unauthorized"
404:
description: "User does not exist."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "User does not exist."
/register:
post:
tags:
- authentication
operationId: authentication-registerUser
description: "Creates a user."
requestBody:
description: "Information about the user which will be registered."
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
email:
type: string
format: email
password:
type: string
format: password
example:
name: "test"
email: "test@test.com"
password: "test"
responses:
201:
description: "User created."
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
user:
$ref: "#/components/schemas/User"
example:
data:
user:
name: "test"
email: "test@test.com"
password: ""
salt: ""
id: 1
active: false
analysisCount: 0
passwordReset: false
409:
description: "This E-Mail is already registered."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "This E-Mail is already registered."
422:
description: "E-Mail and password are required."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "E-Mail and password are required."
/login:
post:
tags:
- authentication
operationId: loginUser
description: "Logs a user in."
requestBody:
description: "Information about the user which wants to be logged in."
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
format: email
password:
type: string
format: email
example:
email: "test@test.com"
password: "test"
responses:
200:
description: "User successfully logged in."
content:
application/json:
schema:
$ref: "#/components/schemas/WrapperUserToken"
example:
message: "User successfully logged in."
data:
user:
id: 1
active: false
name: "test"
email: "test@test.com"
password: ""
salt: ""
analysisCount: 0
passwordReset: false
token: "JWT_TOKEN"
400:
description: "E-Mail / Password invalid."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "E-Mail / Password invalid."
422:
description: "E-Mail and password are required."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "E-Mail and password are required."
/resetPassword:
post:
tags:
- authentication
operationId: authentication-resetPassword
description: "Sends an E-Mail to a user with a unique code to reset his password."
requestBody:
description: "Information about the user which will be logged in."
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
format: email
example:
email: "test@test.com"
responses:
200:
description: "Reset E-Mail was sent."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "Reset E-Mail was sent."
403:
description: "Cannot reset password with not validated E-Mail."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "Cannot reset password with not validated E-Mail."
404:
description: "This user does not exist."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "This user does not exist."
422:
description: "E-Mail is required for a password reset."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "E-Mail is required for a password reset."
/api/updatePassword:
put:
tags:
- authentication
operationId: authentication-updatePassword
description: "Updates the password of a user."
parameters:
- $ref: "#/components/parameters/JWT"
requestBody:
description: "Information about the new password of the user."
required: true
content:
application/json:
schema:
type: object
properties:
password:
type: string
format: password
example:
password: "test"
responses:
200:
description: "Updated successfully the password."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "Updated successfully the password."
401:
$ref: "#/components/responses/Unauthorized"
404:
description: "Could not find user in database."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "Could not find user in database."
422:
description: "Password is required for a password update."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "Password is required for a password update."
/api/changeName/{id}:
put:
tags:
- user
operationId: user-changeName
description: "Changes the name of a user account."
parameters:
- $ref: "#/components/parameters/JWT"
- $ref: "#/components/parameters/UserID"
requestBody:
description: "Information about the new user name."
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
example:
name: "new name"
responses:
200:
description: "Name changed successfully."
content:
application/json:
schema:
$ref: "#/components/schemas/WrapperUser"
example:
message: "Name changed successfully."
data:
user:
id: 1
active: false
name: "test"
email: "test@test.com"
password: ""
salt: ""
analysisCount: 0
passwordReset: false
401:
$ref: "#/components/responses/Unauthorized"
404:
description: "Could not find user in database."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "Could not find user in database."
/api/deleteAccount/{id}:
delete:
tags:
- user
operationId: user-deleteAccount
description: "Deletes a user account."
parameters:
- $ref: "#/components/parameters/UserID"
- $ref: "#/components/parameters/JWT"
responses:
200:
description: "User successfully deleted."
content:
application/json:
schema:
$ref: "#/components/schemas/WrapperUser"
example:
message: "User successfully deleted."
data:
user:
id: 1
active: false
name: "test"
email: "test@test.com"
password: "hashed-pwd"
salt: "salt"
analysisCount: 0
passwordReset: false
401:
$ref: "#/components/responses/Unauthorized"
404:
description: "Could not find User in database."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "Could not find User in database."
500:
description: "Could not delete User."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "Could not delete User."
/api/image:
post:
tags:
- upload
operationId: image-upload
description: "Uploading photo and anylysing it"
parameters:
- $ref: "#/components/parameters/JWT"
requestBody:
description: "The photo which should be analysed."
required: true
content:
multipart/form-data:
schema:
type: object
properties:
image:
type: string
format: binary
responses:
201:
description: "Analysis complete."
content:
application/json:
schema:
type: object
properties:
message:
type: string
data:
type: object
properties:
analysisId:
type: number
format: long
example:
message: "Analysis complete"
data:
analysisId: 1
400:
description: "Could not process file."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "Could not process file."
401:
$ref: "#/components/responses/Unauthorized"
404:
description: "User not found."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "User not found."
406:
description: "Analysis failed. No face recognized."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "Analysis failed. No face recognized."
415:
description: "Only images are allowed."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "Only images are allowed."
/api/analysis/{id}:
get:
tags:
- analysis
operationId: analysis-analysis
description: "Returns one specific analysis from the database."
parameters:
- in: path
name: id
description: "The id of the analysis."
required: true
schema:
type: number
format: integer
- $ref: "#/components/parameters/JWT"
responses:
200:
description: "Analysis found."
content:
application/json:
schema:
type: object
properties:
message:
type: string
data:
$ref: "#/components/schemas/Analysis"
example:
message: "Analysis found."
data:
id: 89
time: "2018-10-23"
smile: 0.001
glasses: NoGlasses
gender: male
age: 61
user:
id: 8
active: false
name: Bernd
email: test
password: ""
salt: ""
analysisCount: 46
emotion:
id: 89
anger: 0.585
contempt: 0
disgust: 0.008
fear: 0.091
happiness: 0.001
neutral: 0.004
sadness: 0.195
surprise: 0.116
accessories: []
makeUp:
id: 89
eyeMakeup: false
lipMakeup: false
facialHair:
id: 89
moustache: 0.1
beard: 0.1
sideburns: 0.1
hair:
id: 89
bald: 0.53
invisible: false
hairColor:
- id: 523
color: blond
confidence: 0.99
- id: 524
color: gray
confidence: 0.95
- id: 525
color: brown
confidence: 0.32
- id: 526
color: other
confidence: 0.21
- id: 527
color: black
confidence: 0.1
- id: 528
color: red
confidence: 0.04
400:
description: "Could not find analysis for user."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "Could not find analysis for user."
401:
$ref: "#/components/responses/Unauthorized"
404:
description: "No analysis with the id {id}."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "No analysis with the id {id}."
/api/statistics/{id}:
get:
tags:
- statistic
operationId: statistics-getStatistics
description: "Get statistics for one specific user."
responses:
200:
description: "Request granted. Returning statistics for user {id}."
content:
application/json:
schema:
type: object
properties:
message:
type: string
data:
type: array
items:
$ref: "#/components/schemas/Statistic"
example:
message: "Request granted. Returning statistics for user {id}."
data:
- id: 18
timestamp: "2018-10-19"
emotions:
sadness: 0.001
anger: 0.002
disgust: 0
fear: 0.002
contempt: 0
neutral: 0.006
surprise: 0.03
happiness: 0.958
- id: 20
timestamp: "2018-10-19"
emotions:
sadness: 0
anger: 0
disgust: 0
fear: 0
contempt: 0
neutral: 0
surprise: 0
happiness: 1
401:
$ref: "#/components/responses/Unauthorized"
406:
description: "Could not affirm identity."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "Could not affirm identity."
delete:
tags:
- statistic
operationId: statistics-reset
description: "Resets the statistics for one user."
responses:
200:
description: "Successfully removed statistics."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "Successfully removed statistics."
401:
$ref: "#/components/responses/Unauthorized"
406:
description: "Could not affirm identity."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "Could not affirm identity."
parameters:
- $ref: "#/components/parameters/JWT"
- $ref: "#/components/parameters/UserID"
components:
responses:
Unauthorized:
description: "Route protected. Authentication required."
content:
application/json:
schema:
$ref: "#/components/schemas/Message"
example:
message: "Route protected. Authentication required."
parameters:
UserID:
in: path
name: id
description: "The id of the user."
required: true
schema:
type: number
format: integer
JWT:
in: header
name: Authorization
description: "The JWT Token of the user."
required: true
schema:
type: string
schemas:
User:
properties:
name:
type: string
email:
type: string
format: email
password:
type: string
format: password
salt:
type: string
id:
type: number
format: long
active:
type: boolean
analysisCount:
type: number
format: integer
passwordReset:
type: boolean
Message:
properties:
message:
type: string
WrapperUser:
properties:
message:
type: string
data:
type: object
properties:
user:
$ref: "#/components/schemas/User"
WrapperUserToken:
properties:
message:
type: string
data:
type: object
properties:
user:
$ref: "#/components/schemas/User"
token:
type: string
Analysis:
properties:
id:
type: number
format: long
time:
type: string
format: date
user:
$ref: "#/components/schemas/User"
emotion:
$ref: "#/components/schemas/Emotion"
smile:
type: number
format: double
accessories:
type: array
items:
$ref: "#/components/schemas/Accessory"
makeUp:
$ref: "#/components/schemas/MakeUp"
glasses:
type: string
gender:
type: string
age:
type: integer
facialHair:
$ref: "#/components/schemas/FacialHair"
hair:
$ref: "#/components/schemas/Hair"
Emotion:
properties:
id:
type: number
format: long
anger:
type: number
format: double
contempt:
type: number
format: double
disgust:
type: number
format: double
fear:
type: number
format: double
happiness:
type: number
format: double
neutral:
type: number
format: double
sadness:
type: number
format: double
surprise:
type: number
format: double
Accessory:
properties:
id:
type: number
format: long
type:
type: string
confidence:
type: number
format: double
MakeUp:
properties:
id:
type: number
format: long
eyeMakeup:
type: boolean
lipMakeup:
type: boolean
FacialHair:
properties:
id:
type: number
format: long
moustache:
type: number
format: double
beard:
type: number
format: double
sideburns:
type: number
format: double
Hair:
properties:
id:
type: number
format: long
bald:
type: number
format: double
invisible:
type: boolean
hairColor:
type: array
items:
$ref: "#/components/schemas/HairColor"
HairColor:
properties:
id:
type: number
format: long
color:
type: string
confidence:
type: number
format: double
Statistic:
properties:
id:
type: number
format: long
timestamp:
type: string
format: date
emotions:
type: array
items:
$ref: "#/components/schemas/StatisticEmotion"
StatisticEmotion:
properties:
anger:
type: number
format: double
contempt:
type: number
format: double
disgust:
type: number
format: double
fear:
type: number
format: double
happiness:
type: number
format: double
neutral:
type: number
format: double
sadness:
type: number
format: double
surprise:
type: number
format: double