-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
1098 lines (1063 loc) · 33.7 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
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: Study-Savvy-Server - OpenAPI 3.0
description: The API document for Study Savvy.
termsOfService: https://study-savvy.com/api
contact:
email: open891013@gmail.com
version: 1.0.0
externalDocs:
description: UI Design By Figma
url: https://www.figma.com/file/u15EBmHQSeixvpN67B71dm/%E7%95%A2%E5%B0%88?type=design&node-id=0%3A1&t=tFdC8pcy6VSyKkBX-1
servers:
- url: https://study-savvy.com
tags:
- name: User
description: Operations about users. Including login, logout, sign up.
- name: NLP_edit
description: NLP operations. Including edit OCR mission and ASR mission.
- name: Access_method
description: The method to use chat-gpt. Including AccessToken and ApiKey.
- name: Mail
description: Operation about mail. Including sent verification mail and verify mail.
- name: Files
description: Operation about file. Including observe files, filter by type, observe the specific file, delete the specific file and gain resource for file.
- name: Predict
description: Operation about Predict with AI. Including OCR mission, ASR mission, OCR_Text mission.
- name: Oauth
description: Operation about oauth. Including Google login.
- name: Information
description: Operation about information. Including gain personal information, edit personal information and edit password.
paths:
/api/User/signup:
post:
tags:
- User
summary: Sign up for the service.
description: To sign up for the service. Then the backend server will save information of user.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/User_SignUp_Request'
responses:
'200':
description: Successful operation.
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have been signup for the service.
/api/User/login/web:
post:
tags:
- User
summary: Login with website.
description: To login to an account with website. The endpoint will confirm user's information and return JwtToken back as authorization. Furthermore, We will set access_token_cookie and csrf_access_token in http only cookie as authorization. In authorization request X-CSRF-TOKEN mean csrf_access_token.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/User_LoginWeb_Request'
responses:
'200':
description: Successful operation.
headers:
Set-Cookie:
description: The access token and CSRF token cookies. AccessToken(JwtToken) is http only cookie and CsrfAccessToken is a normal cookie.
schema:
type: string
example: |
access_token_cookie=ExampleJwtTokenCookie; Path=/; HttpOnly; Secure
csrf_access_token=ExampleCsrfAccessTokenCookie; Path=/; Secure
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered or with incorrect password.
/api/User/login/app:
post:
tags:
- User
summary: Login with app.
description: To login to an account with app. The endpoint will authorize user's information and return JwtToken back as authorization.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/User_LoginApp_Request'
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/User_LoginApp_Response'
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered or with incorrect password.
/api/User/logout:
delete:
tags:
- User
security:
- BearerAuth: []
summary: To logout for the service.
description: Logout account. The backend server will forbid the JwtToken in request in future request.
parameters:
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
responses:
'201':
description: Successful operation. Successful to logout the service.
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered.
'422':
description: JwtToken is invalid. Jwt is expired or is not issued by the service.
/api/Oauth/web/google:
get:
tags:
- Oauth
summary: Login to the website.
description: To login to an account in the db and return the JWT in httponly cookie.
responses:
'200':
description: Successful operation
'400':
description: Invalid status value
/api/Oauth/app/google:
get:
tags:
- Oauth
summary: Login to the app with google.
security:
- BearerAuth: [ ]
description: To login to an account with google and in app.
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
token:
type: string
'400':
description: Invalid status value
/api/Oauth/authorize/google/:
get:
tags:
- Oauth
summary: Login to the website.
description: To login to an account in the db and return the JWT in httponly cookie.
responses:
'200':
description: Successful operation
headers:
Set-Cookie:
schema:
type: string
example: token=abc123; Path=/; HttpOnly
description: The JWT, set as HttpOnly
'400':
description: Invalid status value
/api/Information:
get:
tags:
- Information
security:
- BearerAuth: [ ]
parameters:
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
summary: Get personal information.
description: Get the personal information. The backend server will return the information of user.
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/Information_Information_Response'
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered.
'422':
description: JwtToken is invalid. Jwt is expired or is not issued by the service.
'404':
description: Not found.
put:
tags:
- Information
security:
- BearerAuth: [ ]
summary: Update personal information.
description: Update personal information. The backend server will according to request to modify the personal information.
parameters:
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Information_InformationEdit_Request'
responses:
'200':
description: Successful operation.
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered.
'422':
description: JwtToken is invalid. Jwt is expired or is not issued by the service.
'404':
description: Not found.
/api/Information/password_edit:
put:
tags:
- Information
security:
- BearerAuth: [ ]
summary: Update personal information.
description: Update personal information. The backend server will according to request to modify the personal information.
parameters:
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Information_InformationPasswordEdit_Request'
responses:
'200':
description: Successful operation.
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. CurrentPassword is not match in database.
'422':
description: JwtToken is invalid. Jwt is expired or is not issued by the service.
'404':
description: Not found.
/api/Files:
get:
tags:
- Files
security:
- BearerAuth: []
summary: Get the files.
description: Get the files with page that user have been sent and order by time.
parameters:
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
- name: page
in: query
description: The page number to retrieve. The page number default to 1.
required: false
schema:
type: integer
default: 1
minimum: 1
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/Files_Files_Response'
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered.
'422':
description: JwtToken is invalid. Jwt is expired or is not issued by the service.
/api/Files/ASR:
get:
tags:
- Files
security:
- BearerAuth: []
summary: Get the files with type equal to ASR.
description: Get the files with page that user have been sent and order by time and type equal to ASR.
parameters:
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
- name: page
in: query
description: The page number to retrieve. The page number default to 1.
required: false
schema:
type: integer
default: 1
minimum: 1
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/Files_Files_Response'
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered.
'422':
description: JwtToken is invalid. Jwt is expired or is not issued by the service.
/api/Files/OCR:
get:
tags:
- Files
security:
- BearerAuth: []
summary: Get the files with type equal to OCR.
description: Get the files with page that user have been sent and order by time and type equal to OCR.
parameters:
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
- name: page
in: query
description: The page number to retrieve. The page number default to 1.
required: false
schema:
type: integer
default: 1
minimum: 1
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/Files_Files_Response'
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered.
'422':
description: JwtToken is invalid. Jwt is expired or is not issued by the service.
/api/Files/{file_id}:
get:
tags:
- Files
security:
- BearerAuth: []
summary: Get the specific file's information.
description: Get the file's information filter by id. Gain all detail for the specific file.
parameters:
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
- name: file_id
in: path
required: true
schema:
type: string
format: uuid
description: The file's id.
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Files_FilesSpecific_Response'
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered.
'403':
description: Forbidden. The file is not belong to user.
'404':
description: Not exist.
'422':
description: JwtToken is invalid. Jwt is expired or is not issued by the service.
delete:
tags:
- Files
security:
- BearerAuth: [ ]
summary: Delete the specific file.
description: Delete the specific file by file's id and remove resource from backend server.
parameters:
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
- name: file_id
in: path
required: true
schema:
type: string
format: uuid
description: The file's id.
responses:
'201':
description: Successful operation.
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered.
'403':
description: Forbidden. The file is not belong to user.
'404':
description: Not exist.
'422':
description: JwtToken is invalid. Jwt is expired or is not issued by the service.
/api/Files/resources/audio/{file_id}:
get:
tags:
- Files
security:
- BearerAuth: [ ]
summary: Get audio resource.
description: Get audio resource for the specific file by file's id.
parameters:
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
- name: file_id
in: path
required: true
schema:
type: string
format: uuid
description: The file's id.
responses:
'200':
description: Successful operation.
content:
audio/mpeg:
schema:
type: string
format: binary
'400':
description: Invalid status value
'401':
description: Not authorize.
'403':
description: Forbidden.
'404':
description: Not exist.
'422':
description: JWT is invalid.
/api/Files/resources/graph/{file_id}:
get:
tags:
- Files
security:
- BearerAuth: [ ]
summary: Get graph resource.
description: Get graph resource for the specific file by file's id.
parameters:
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
- name: file_id
in: path
required: true
schema:
type: string
format: uuid
description: The file's id.
responses:
'200':
description: Successful operation.
content:
image/jpeg:
schema:
type: string
format: binary
'203':
description: Successful operation. But the resource is pure text.
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered.
'403':
description: Forbidden. The file is not belong to user.
'404':
description: Not exist.
'422':
description: JwtToken is invalid. Jwt is expired or is not issued by the service.
/api/NLP_edit/ASR/{file_id}:
put:
tags:
- NLP_edit
security:
- BearerAuth: []
summary: Use nlp-method to edit ASR file.
description: Use nlp-method to edit ASR file with new prompt and content make the file's information be edited.
parameters:
- name: file_id
in: path
required: true
schema:
type: string
format: uuid
description: The file's id.
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NlpEdit_NlpEdit_Request'
responses:
'200':
description: Successful operation.
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered.
'403':
description: Forbidden. The file is not belong to user.
'404':
description: Not exist.
'422':
description: JwtToken is invalid. Jwt is expired or is not issued by the service.
/api/NLP_edit/OCR/{file_id}:
put:
tags:
- NLP_edit
security:
- BearerAuth: []
summary: Use nlp-method to edit OCR file.
description: Use nlp-method to edit OCR file with new prompt and content make the file's information be edited.
parameters:
- name: file_id
in: path
required: true
schema:
type: string
format: uuid
description: The file's id.
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NlpEdit_NlpEdit_Request'
responses:
'200':
description: Successful operation.
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered.
'403':
description: Forbidden. The file is not belong to user.
'404':
description: Not exist.
'422':
description: JwtToken is invalid. Jwt is expired or is not issued by the service.
/api/Access_method/access_token:
put:
tags:
- Access_method
security:
- BearerAuth: []
summary: Set access-token in chat-gpt to the service.
description: Set user's access-token to the service, then user can use chat-gpt for other service.
parameters:
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AccessMethod_AccessToken_Request'
responses:
'200':
description: Successful operation.
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered.
'422':
description: JwtToken is invalid. Jwt is expired or is not issued by the service.
/api/Access_method/api_key:
put:
tags:
- Access_method
security:
- BearerAuth: [ ]
summary: Set api-key in chat-gpt to the service.
description: Set user's api-key to the service, then user can use chat-gpt for other service.
parameters:
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AccessMethod_ApiKey_Request'
responses:
'200':
description: Successful operation.
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered.
'422':
description: JwtToken is invalid. Jwt is expired or is not issued by the service.
/api/Mail/verification:
post:
tags:
- Mail
summary: Get the verification code.
description: Get the verification code by mail.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Mail_Verification_Request'
responses:
'200':
description: Successful operation.
'400':
description: Invalid status value. RequestBody is not match request.
/api/Mail/verification/{mail}/{code}:
get:
tags:
- Mail
summary: Verify the mail.
description: Verify the mail by the code.
parameters:
- name: mail
in: path
required: true
schema:
type: string
format: email
description: User's mail.
- name: code
in: path
required: true
schema:
type: string
description: The verification code with the mail.
responses:
'200':
description: Successful operation.
'400':
description: Invalid status value. RequestBody is not match request.
/api/Predict/ASR:
post:
tags:
- Predict
security:
- BearerAuth: [ ]
summary: Asr mission.
description: Upload audio file and do asr mission that is to get content of audio and then summarize the content store in file.
parameters:
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/AiPredict_Asr_Request'
responses:
'200':
description: Successful operation.
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered.
'422':
description: JwtToken is invalid. Jwt is expired or is not issued by the service.
/api/Predict/OCR:
post:
tags:
- Predict
security:
- BearerAuth: [ ]
parameters:
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
summary: Ocr mission.
description: Upload graph file and do ocr mission that is to get content of graph and then summarize the content store in file.
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/AiPredict_Ocr_Request'
responses:
'200':
description: Successful operation.
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered.
'422':
description: JwtToken is invalid. Jwt is expired or is not issued by the service.
/api/Predict/OCR_Text:
post:
tags:
- Predict
security:
- BearerAuth: [ ]
parameters:
- in: header
name: X-CSRF-TOKEN
required: false
schema:
type: string
description: CSRF token
summary: OcrText mission.
description: Use prompt and content do the nlp-task to set the file content.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AiPredict_OcrText_Request'
responses:
'200':
description: Successful operation.
'400':
description: Invalid status value. RequestBody is not match request.
'401':
description: Unauthorized with information. User have not registered.
'422':
description: JwtToken is invalid. Jwt is expired or is not issued by the service.
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
User_LoginApp_Request:
type: object
properties:
mail:
type: string
format: email
description: User's mail as account to login service.
password:
type: string
minLength: 8
maxLength: 30
description: User's password (should not contain spaces and be at least 8 characters long and less than 30 characters long).
pattern: '^(?!.*\s).{8,}$'
example:
mail: "Example@example.com"
password: "ExamplePassword"
User_LoginApp_Response:
type: object
properties:
token:
type: string
description: Return user's JwtToken use to validate user in other request in headers.
example:
token: "ExampleJwtToken:"
User_LoginWeb_Request:
type: object
properties:
mail:
type: string
format: email
description: User's mail as account to login service.
password:
type: string
minLength: 8
maxLength: 30
description: User's password (should not contain spaces and be at least 8 characters long and less than 30 characters long).
pattern: '^(?!.*\s).{8,}$'
example:
mail: "Example@example.com"
password: "ExamplePassword"
User_SignUp_Request:
type: object
properties:
name:
type: string
maxLength: 50
pattern: '^\S{1,50}$'
description: User's name. It's length can't more than 50 and can't have space.
gender:
type: string
enum:
- "male"
- "female"
- "other"
description: User's gender. It can only accept "male", "female" and "other".
default: "other"
mail:
type: string
format: email
description: User will be register by email.
password:
type: string
minLength: 8
maxLength: 30
description: User's password (should not contain spaces and be at least 8 characters long and less than 30 characters long).
pattern: '^(?!.*\s).{8,}$'
example:
name: "ExampleUser"
gender: "other"
mail: "Example@example.com"
password: "ExamplePassword"
Information_Information_Response:
type: object
properties:
name:
type: string
maxLength: 50
pattern: '^\S{1,50}$'
description: User's name. It's length can't more than 50 and can't have space.
mail:
type: string
format: email
description: User's mail as the account in service.
gender:
type: string
enum:
- "male"
- "female"
- "other"
description: User's gender. It would only include "male", "female" and "other".
Information_InformationEdit_Request:
type: object
properties:
name:
type: string
maxLength: 50
pattern: '^\S{1,50}$'
description: User's name. It's length can't more than 50 and can't have space.
gender:
type: string
enum:
- "male"
- "female"
- "other"
description: User's gender. It can only accept "male", "female" and "other".
example:
name: "ExampleUser"
gender: "male"
Information_InformationPasswordEdit_Request:
type: object
properties:
current_password:
type: string
minLength: 8
maxLength: 30
description: User's original password (should not contain spaces and be at least 8 characters long and less than 30 characters long).
pattern: '^(?!.*\s).{8,}$'
edit_password:
type: string
minLength: 8
maxLength: 30
description: User's new password (should not contain spaces and be at least 8 characters long and less than 30 characters long).
pattern: '^(?!.*\s).{8,}$'
example:
current_password: "ExampleCurrentPassword"
edit_password: "ExampleEditPassword"
Files_Files_Response:
type: object
properties:
total_pages:
type: integer
description: The total number of pages.
current_page:
type: integer
description: The current page.
data:
type: array
items:
type: object
properties:
file_time:
type: string
description: The time file build.
file_id:
type: string
format: uuid
description: The file ID.
status:
type: string
enum:
- "SUCCESS"
- "PENDING"
- "FAILURE"
description: The file's current status. It only include "SUCCESS", "PENDING", "FAILURE".
file_type:
type: string
enum:
- "OCR"
- "ASR"
description: The file type. It only include "OCR" and "ASR".
Files_FilesSpecific_Response: