-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdocumentationSwagger.yaml
2168 lines (2157 loc) · 73.3 KB
/
documentationSwagger.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:
title: TRIPP
description: |-
Tripp adalah sebuah layanan yang digunakan untuk melakukan pemesanan tiket pesawat secara online. Dengan Tripp pengguna dapat memilih penerbangan berdasarkan jadwal dan maskapai, serta melakukan pembayaran secara online.
contact:
email: [email protected]
version: 1.0.0
servers:
- url: http://localhost:8000
description: Test local computer
- url: https://composed-beds-develop.up.railway.app
description: Staging
- url: https://composed-beds-production.up.railway.app
description: Production
tags:
- name: Users
description: Mengolah data user dan proses autentikasi
- name: Flights
description: Informasi mengenai jadwal penerbangan
- name: Transactions
description: Melayani booking tiket pesawat
- name: Payments
description: Menangani proses pembayaran
- name: Tickets
description: Menyediakan informasi tiket
- name: Notifications
description: Mendapatkan Informasi penerbangan
paths:
/auth/register:
post:
tags:
- Users
summary: Mendaftarkan user baru
description: |-
Registrasi user diperlukan agar user dapat melakukan log in. Inputan pada tiap field harus sesuai ketentuan, diantaranya adalah:
- Password minimal mengandung 6 karakter dengan menyertakan minimal 1 huruf kecil [a-z], minimal 1 huruf besar [A-Z] , dan minimal 1 karakter angka [0-9]
- Email yang telah teregister tidak dapat digunakan kembali
- Phone_number memiliki tipe data string
operationId: post-register-user
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: sabrina
email:
type: string
example: [email protected]
phone_number:
type: string
example: 085232128434
password:
type: string
example: fA077f
confirmPassword:
type: string
example: fA077f
responses:
"201":
description: User Registered
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: OTP has been sent, expired in 10 minutes, please check your email!
data:
example: null
"400":
description: Error Bad Request
content:
application/json:
schema:
oneOf:
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Name is required!
data:
example: null
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Email is already used!
data:
example: null
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Phone Number is not valid
data:
example: null
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Email is not valid
data:
example: null
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Password minimum 6 characters, must contain uppercase, lowercase, and number!
data:
example: null
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: password and confirm password doesn't match!!!
data:
example: null
examples:
duplicated-email:
summary: Jika email sudah digunakan
value:
status: false
message: Email is already used!
data: null
required-data-is-not-provided:
summary: Jika data yang dibutuhkan tidak tersedia
value:
status: false
message: Name is required!
data: null
phone-number-is-not-valid:
summary: Jika phone_number tidak valid
value:
status: false
message: Phone Number is not valid
data: null
email-is-not-valid:
summary: Jika email tidak valid
value:
status: false
message: Email is not valid
data: null
password-is-not-valid:
summary: Jika password tidak valid
value:
status: false
message: Password minimum 6 characters, must contain uppercase, lowercase, and number!
data: null
password-confirmPassword-doesn't-match:
summary: Jika password dan conformPassword tidak cocok
value:
status: false
message: password and confirm password doesn't match
data: null
/auth/login:
post:
tags:
- Users
summary: Mendapatkan token autentikasi
description: Token autentikasi diperlukan untuk mengakses beberapa endpoint yang dilindungi seperti transactions dan payment.
operationId: post-login-user
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: [email protected]
password:
type: string
example: fA077f
responses:
"200":
description: Login success
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: Login success!
data:
type: object
properties:
token:
type: string
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Mywicm9sZSI6InVzZXIiLCJpYXQiOjE2ODcxNjg3MDR9.H4k4sMd2XH8AiWMRxdgelXMBb0DlC5nQiTEWAxyUzIU
"401":
description: Email belum terverifikasi
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Account is not activated, please check your email, and verify the otp!
data:
example: null
"400":
description: Error Bad Request
content:
application/json:
schema:
oneOf:
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Field email is required!
data:
example: null
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Email is not valid!
data:
example: null
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Email is not registered!, please register first!
data:
example: null
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Password is incorrect
data:
example: null
examples:
required-data-is-not-provided:
summary: Jika data yang dibutuhkan tidak tersedia
value:
status: false
message: Field email is required!
data: null
email-is-not-valid:
summary: Jika email tidak valid
value:
status: false
message: Email is not falid!
data: null
password-is-incorrect:
summary: Jika password tidak valid
value:
status: false
message: Password is incorrect
data: null
email-is-not-registered:
summary: Jika email tidak terdaftar
value:
status: false
message: Email is not registered!, please register first!
data: null
/auth/verify-otp:
post:
tags:
- Users
summary: Mendapatkan kode verify-otp
description: token menandakan user sudah login
operationId: post-verify-otp-user
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: [email protected]
otp:
type: string
example: prxuEx
responses:
"200":
description: User Verified
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: Success Verified The OTP!
data:
example: null
"400":
description: Error Bad Request
content:
application/json:
schema:
oneOf:
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Email is required!
data:
example: null
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: OTP is required!
data:
example: null
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Email is not registered!
data:
example: null
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: You're Not Request OTP Yet!
data:
example: null
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: OTP is expired!
data:
example: null
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: OTP is Not Valid!
data:
example: null
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Activation account failed!
data:
example: null
examples:
required-data-is-not-provided:
summary: Jika Email tidak ada
value:
status: false
message: Email is required!
data: null
otp-is-required:
summary: Jika OTP diperlukan
value:
status: false
message: OTP is required!
data: null
email-is-not-registered:
summary: Jika email tidak terdaftar
value:
status: false
message: Email is not registered!
data: null
otp-is-request:
summary: Jika meminta kode OTP
value:
status: false
message: You're Not Request OTP Yet!
data: null
user-otp-expiration-time:
summary: Jika OTP sudah kadaluwarsa
value:
status: false
message: OTP is expired!
data: null
otp-failed-verified:
summary: Jika OTP tidak valid
value:
status: false
message: OTP is Not Valid!
data: null
if the account fails to be verified:
summary: jika akun gagal diverifikasi
value:
status: false
message: Activation account failed!
data: null
/auth/resend-otp:
post:
tags:
- Users
summary: Kirim Ulang OTP
description: validasi jika pengguna sudah meminta kirim ulang otp untuk membatasi permintaan
operationId: post-resend otp-user
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: [email protected]
responses:
"201":
description: Login success
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: OTP has been sent, expired in 10 minutes, please check your email!
data:
type: string
example: null
"400":
description: Error Bad Request
content:
application/json:
schema:
oneOf:
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Failed Send the OTP!
data:
example: null
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: You have already requested resend otp, check your email please
data:
example: null
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Email is not registered!
data:
example: null
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Email is not valid
data:
example: null
examples:
failed-send-otp:
summary: Jika pengguna mencoba memverifikasi otp tetapi tidak mengirim permintaan
value:
status: false
message: Failed Send the OTP!
data: null
resend-otp:
summary: Meminta kirim ulang OTP
value:
status: false
message: You have already requested resend otp, check your email please
data: null
email-not-registed:
summary: Jika email tidak terdaftar
value:
status: false
message: Email is not registered!
data: null
email-not-valid:
summary: Jika email tidak divalidasi
value:
status: false
message: Email is not valid!
data: null
/auth/forgot-password:
post:
tags:
- Users
summary: Mengirim tautan reset password ke email pengguna
description: Data permintaan reset password
operationId: post-forgot passsword-user
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: [email protected]
responses:
"200":
description: mengirim tautan reset password ke email pengguna
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: Success send link reset password to your email!
data:
type: string
example: null
"400":
description: Error Bad Request
content:
application/json:
schema:
oneOf:
- type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: email not found!
data:
example: null
examples:
email-not-found:
summary: Jika pengguna mencoba memverifikasi email
value:
status: false
message: email not found!
data: null
/users/{id}:
get:
tags:
- Users
summary: Mendapatkan detail pengguna
description: Detail user
parameters:
- in: path
name: id
required: true
schema:
type: integer
example: 1
description: id of user
responses:
"200":
description: Success Mendapatkan data user
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
message:
type: string
example: success
data:
type: object
properties:
id:
type: integer
example:
name:
type: string
example: fitri andriyani
email:
type: string
example: [email protected]
password:
type: string
example: $2b$10$NcB2dn7Dn1fXURWbTQd.0eFGB8Uu6Ca5W5/qmolvxuxVJgaNPg4Ra
phone_number:
type: string
example: 085232128432
otp:
type: string
example: sipUzs
otp_experation_time:
type: string
example: 2023-06-20T11:53:20.615Z
role:
type: string
example: user
user_type:
type: string
example: basic
is_verified:
type: boolean
example: true
created_at:
type: string
example: 2023-06-20T11:44:39.696Z
updated_at:
type: string
example: 2023-06-20T11:52:20.615Z
security:
- jwt_token: []
put:
tags:
- Users
summary: Mengupdate data pengguna
description: Mengupdate data pengguna
parameters:
- in: path
name: id
required: true
schema:
type: integer
example: 1
description: id of user
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: Fitri Andriyani
responses:
"200":
description: Success Update Data
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
message:
type: string
example: success
data:
type: integer
example: 1
security:
- jwt_token: []
/flights:
post:
tags:
- Flights
summary: Digunakan untuk mencari jadwal penerbangan
description: Digunakan untuk mencari jadwal penerbangan
operationId: post-flight-flights
requestBody:
content:
application/json:
schema:
type: object
properties:
origin_airport:
type: string
example: MLG
destination_airport:
type: string
example: HLP
flight_date:
type: string
example: 2023-06-01
passenger_cnt:
type: number
example: 2
responses:
"200":
description: Login success
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: Ok
err:
type: string
example: null
data:
type: object
properties:
id:
type: string
example: 216
flight_number:
type: string
example: ID-7580
departure_airport:
type: integer
example: Abdul Rachman Saleh
departure_code:
type: string
example: MLG
departure_city:
type: string
example: Malang
departure_country:
type: string
example: Indonesia
arrivall_airport:
type: string
example: Halim Perdanakusuma International Airport
arrivall_code:
type: string
example: HLP
arrivall_city:
type: string
example: Jakarta
arrivall_country:
type: string
example: Indonesia
airplane_model:
type: string
example: Airbus A320
airplane_code:
type: string
example: AIRBUS-A320-32
airline:
type: string
example: Batik Air
airline_code:
type: string
example: ID
class:
type: string
example: ECONOMY
price:
type: integer
example: 1007200
departure_terminal_name:
type: string
example: null
arrival_terminal_name:
type: string
example: null
flight_date:
type: string
example: 2023-06-01
departure_time:
type: string
example: 09:15
arrival_time:
type: string
example: 10:40
departure_timestamp:
type: integer
example: 1685585700
arrival_timestamp:
type: integer
example: 1685590800
flight_duration:
type: integer
example: 85
free_baggage:
type: integer
example: 20
cabin_baggage:
type: integer
example: 7
capacity:
type: integer
example: 192
purchased_ticket:
type: string
example: null
available_ticket:
type: integer
example: 192
"400":
description: Error Bad Request
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Bad Request
data:
example: null
/flights/{id}:
get:
tags:
- Flights
summary: Menampilkan detail data penerbangan
description: Menampilkan detail data dari suatu penerbangan
parameters:
- in: path
name: id
required: true
schema:
type: integer
example: 1
description: id of flight
responses:
"200":
description: Success Mendapatkan data Penerbangan
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
message:
type: string
example: success
data:
type: object
properties:
id:
type: integer
example: 5
flight_number:
type: string
example: ID-6540
class:
type: string
example: ECONOMY
price:
type: integer
example: 2443100
departure_terminal_name:
type: string
example: Terminal 2D
arrival_terminal_name:
type: string
example: Terminal Domestic
flight_date:
type: string
example: 2023-06-01
departure_time:
type: string
example: 02:00
arrival_time:
type: string
example: 06:10
flight_duration:
type: integer
example: 250
free_baggage:
type: integer
example: 20
cabin_baggage:
type: integer
example: 7
capacity:
type: integer
example: 192
departure:
type: object
properties:
name:
type: string
example: Soekarno Hatta International Airport
iata_code:
type: string
example: CGK
city:
type: string
example: Jakarta
country:
type: string
example: Indonesia
arrival:
type: object
properties:
name:
type: string
example: El Tari
iata_code:
type: string
example: KOE
city:
type: string
example: Kupang
country:
type: string
example: Indonesia
airline:
type: object
properties:
name:
type: string
example: Batik Air
short_name:
type: string
example: Batik
iata_code:
type: string
example: ID
icon_url:
type: string
example: https://ik.imagekit.io/tvlk/image/imageResource/2019/12/13/1576208649600-12471f9b7ffa159361f7bbbfb63065ee.png?tr=q-75
airplane:
type: object
properties:
model:
type: string
example: Airbus A320
code:
type: string
example: AIRBUS-A320-32