-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
1577 lines (1570 loc) · 38.4 KB
/
swagger.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: FishApp API
contact:
name: Josue Lubaki
url: https://josue-lubaki.ca
email: josuelubaki@gmail.com
version: '1.0.0'
servers:
- url: https://fish-sales-application.herokuapp.com/api/v1
variables: {}
paths:
/users:
get:
tags:
- Users
summary: getAll
description: Methode qui permet de récupérer tous les utilisateurs
operationId: getAll
parameters: []
responses:
'200':
description: ''
headers: {}
deprecated: false
post:
tags:
- Users
summary: create
description: Méthode qui permet de créer un utilisateur
operationId: create
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/createrequest'
example:
name: Veteran
email: veteran@gmail.com
password: veteran
phone: '+18736641270'
isAdmin: 'false'
avenue: Etat major
apartment: 43A
quartier: Bureaucratique
commune: Assaut
city: Kinshasa
country: COD
question: Quelle est mon titre à l'armée
reponse: Major
required: true
responses:
'200':
description: ''
headers: {}
deprecated: false
/users/{id}:
get:
tags:
- Users
summary: getUser
description: Methode qui permet de récupérer un utilisateur selon son ID
operationId: getUser
parameters:
- name: id
in: path
description: identifiant de l'utilisateur
required: true
style: simple
schema:
type: string
example: 616b9807d6065e6448d00b8e
responses:
'200':
description: ''
headers: {}
deprecated: false
put:
tags:
- Users
summary: update
description: Méthode qui permet de mettre à jour les informations de l'utilisateur
operationId: update
parameters:
- name: id
in: path
description: identifiant de l'utilisateur
required: true
style: simple
schema:
type: string
example: 616b9807d6065e6448d00b8e
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/updaterequest'
example:
name: Veteran
email: veteran@gmail.com
phone: '+18736641270'
isAdmin: 'false'
avenue: Etat major
apartment: 43A
quartier: Bureaucratique
commune: Assaut
city: Kinshasa
country: COD
question: Quelle est mon titre à l'armée
reponse: General
required: true
responses:
'200':
description: ''
headers: {}
deprecated: false
delete:
tags:
- Users
summary: delete
operationId: delete
parameters:
- name: id
in: path
description: identifiant de l'utilisateur
required: true
style: simple
schema:
type: string
example: 616af44288add1657873e077
responses:
'200':
description: ''
headers: {}
deprecated: false
/users/exist/{id}:
get:
tags:
- Users
summary: isExist
description: Méthode qui permet de vérifier si l'utilisateur existe ou pas
operationId: isExist
parameters:
- name: id
in: path
description: identifiant de l'utilisateur
required: true
style: simple
schema:
type: string
example: 616b9807d6065e6448d00b8e
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
/users/get/count:
get:
tags:
- Users
summary: count
description: >-
Renvoi le nombre des Utilisateurs,<br>
@return <b>userCount<b>
operationId: count
parameters: []
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
/users/compte/forgot/get/question:
post:
tags:
- Users
summary: getSecureQuestion
description: Methode qui permet de récupérer la question de sécurité d'un utilisateur
operationId: getSecureQuestion
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/getSecureQuestionRequest'
example:
email: veteran@gmail.com
required: true
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
/users/compte/forgot/get/response/{id}:
post:
tags:
- Users
summary: verifySecureResponse
description: Methode qui permet de verifier si la réponse donnée par l'utilisateur correspond à celle de securité
operationId: verifySecureResponse
parameters:
- name: id
in: path
description: identifiant de l'utilisateur
required: true
style: simple
schema:
type: string
example: 616b9807d6065e6448d00b8e
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/verifySecureResponseRequest'
example:
reponse: Major
required: true
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
/users/compte/forgot/reset/{id}:
patch:
tags:
- Users
summary: resetPassword
description: Methode qui permet à l'utilisateur de reset son mot de passe oublié
operationId: resetPassword
parameters:
- name: id
in: path
description: identifiant de l'utilisateur
required: true
style: simple
schema:
type: string
example: 616b9807d6065e6448d00b8e
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/resetPasswordRequest'
example:
password: veteran
required: true
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
/categories:
post:
tags:
- Categories
summary: create
description: Méthode qui permet de créer une catégorie
operationId: Postcreate
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/createrequest1'
example:
name: Bijoux
color: '#d5f'
required: true
responses:
'200':
description: ''
headers: {}
deprecated: false
get:
tags:
- Categories
summary: getAll
description: Méthode qui permet de récupérer toutes les catégories
operationId: GetgetAll
parameters: []
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
/categories/{id}:
get:
tags:
- Categories
summary: getCategory
description: Méthode qui permet de récupérer une catégorie
operationId: getCategory
parameters:
- name: id
in: path
description: identifiant de la categorie
required: true
style: simple
schema:
type: string
example: 616aead24b378c68d8ed641b
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
delete:
tags:
- Categories
summary: delete
description: Méthode qui permet de supprimer une catégorie
operationId: Deletedelete
parameters:
- name: id
in: path
description: identifiant de la categorie
required: true
style: simple
schema:
type: string
example: 616aead24b378c68d8ed641b
responses:
'200':
description: ''
headers: {}
deprecated: false
put:
tags:
- Categories
summary: update
description: Methode qui permet de mettre à jour une categorie
operationId: Putupdate
parameters:
- name: id
in: path
description: identifiant de la categorie
required: true
style: simple
schema:
type: string
example: 616aead24b378c68d8ed641b
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/updaterequest1'
example:
name: Bijoux
color: '#F2D'
required: true
responses:
'200':
description: ''
headers: {}
deprecated: false
/categories/get/count:
get:
tags:
- Categories
summary: count
description: >-
Méthode qui permet d'obtenir le nombre total des catégories,<br>
@return <b>categorieCount</b>
operationId: Getcount
parameters: []
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
/banners:
get:
tags:
- Banners
summary: getAll
operationId: GetgetAll1
parameters: []
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
post:
tags:
- Banners
summary: create
description: Méthode qui permet de créer un Banner
operationId: Postcreate1
parameters: []
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- name
- image
type: object
properties:
name:
type: string
example: banner_Lateral
image:
type: string
required: false
responses:
'200':
description: ''
headers: {}
deprecated: false
/banners/{id}:
get:
tags:
- Banners
summary: getbanner
description: Méthode qui permet de récupérer un Banner
operationId: getbanner
parameters:
- name: id
in: path
description: identifiant du banner
required: true
style: simple
schema:
type: string
example: 61668a5dfa05c6c8781416f1
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
delete:
tags:
- Banners
summary: delete
description: Méthode qui permet de supprimer un Banner
operationId: Deletedelete1
parameters:
- name: id
in: path
description: identifiant du banner
required: true
style: simple
schema:
type: string
example: 616ba551a5772940185bd43a
responses:
'200':
description: ''
headers: {}
deprecated: false
/products:
get:
tags:
- products
summary: getAll
description: Méthode qui permet de récupérer tous les produits
operationId: GetgetAll12
parameters: []
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
post:
tags:
- products
summary: create
description: Méthode qui permet de créer un produit
operationId: Postcreate12
parameters: []
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- name
- description
- richDescription
- image
- price
- category
- countInStock
- isFeatured
type: object
properties:
name:
type: string
example: Crevette
description:
type: string
example: nous possedons de bon crevette frais
richDescription:
type: string
example: Les crevettes sont des fruits de mer très populaires, elles sont délicieuses et faciles à cuire. Disponibles fraîches ou congelées, nous vous proposons des crevettes sauvages de première qualité. Découvrez les crevettes nordiques locales du Québec, les crevettes sauvages du Golfe et du Pacifique, les crevettes entières avec tête, et les crevettes d'aquaculture responsable décortiquées et pelées
image:
type: string
price:
type: integer
format: int32
example: 12
category:
type: string
example: 60e41298c5b238bb74af72bd
countInStock:
type: integer
format: int32
example: 40
isFeatured:
type: boolean
example: true
required: false
responses:
'200':
description: ''
headers: {}
deprecated: false
/products/{id}:
get:
tags:
- products
summary: getProduct
description: Méthode qui permet de recupérer un produit
operationId: getProduct
parameters:
- name: id
in: path
description: identifiant du produit
required: true
style: simple
schema:
type: string
example: 60e420a23c9bf081402dc359
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
put:
tags:
- products
summary: update
description: Méthode qui permet de faire la mise à jour d'un produit
operationId: Putupdate1
parameters:
- name: id
in: path
description: identifiant du produit
required: true
style: simple
schema:
type: string
example: 616baa76b481ad74cc1d0a10
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- name
- description
- richDescription
- image
- price
- category
- countInStock
- isFeatured
type: object
properties:
name:
type: string
example: Crevette
description:
type: string
example: nous possedons de bon crevette frais
richDescription:
type: string
example: Les crevettes sont des fruits de mer très populaires, elles sont délicieuses et faciles à cuire. Disponibles fraîches ou congelées, nous vous proposons des crevettes sauvages de première qualité. Découvrez les crevettes nordiques locales du Québec, les crevettes sauvages du Golfe et du Pacifique, les crevettes entières avec tête, et les crevettes d'aquaculture responsable décortiquées et pelées
image:
type: string
price:
type: integer
format: int32
example: 12
category:
type: string
example: 60e41298c5b238bb74af72bd
countInStock:
type: integer
format: int32
example: 40
isFeatured:
type: boolean
example: true
required: false
responses:
'200':
description: ''
headers: {}
deprecated: false
delete:
tags:
- products
summary: delete
description: Méthode qui permet de supprimer un produit
operationId: Deletedelete12
parameters:
- name: id
in: path
description: identifiant du produit
required: true
style: simple
schema:
type: string
example: 616baa76b481ad74cc1d0a10
responses:
'200':
description: ''
headers: {}
deprecated: false
/products/get/count:
get:
tags:
- products
summary: count
description: >-
Méthode qui permet d'obtenir le nombre total des produits<br>
@return <b>productCount</b>
operationId: Getcount1
parameters: []
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
/products/get/count/{id}:
get:
tags:
- products
summary: countStock
description: Méthode qui permet d'obtenir le nombre total en stock d'un produit
operationId: countStock
parameters:
- name: id
in: path
description: identifiant du produit
required: true
style: simple
schema:
type: string
example: 616baa76b481ad74cc1d0a10
responses:
'200':
description: ''
headers: {}
deprecated: false
/products/get/featured/{number}:
get:
tags:
- products
summary: featured
description: Méthode ui permet de renvoyer une liste de produits mise en avant
operationId: featured
parameters:
- name: number
in: path
description: nombre des produits
required: true
style: simple
schema:
type: string
example: '5'
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
/products/gallery-images/{id}:
put:
tags:
- products
summary: addGalleria
description: Mettre à jour le tableau d'image pour un produit
operationId: addGalleria
parameters:
- name: id
in: path
description: identifiant du produit
required: true
style: simple
schema:
type: string
example: 616baa76b481ad74cc1d0a10
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- images
type: object
properties:
images:
type: string
required: false
responses:
'200':
description: ''
headers: {}
deprecated: false
/orders:
get:
tags:
- Orders
summary: getAll
description: Méthode qui permet de récupérer toutes les commandes
operationId: GetgetAll123
parameters: []
responses:
'200':
description: ''
headers: {}
deprecated: false
post:
tags:
- Orders
summary: make
description: Méthode qui permet à un utilisateur de passer sa commande
operationId: make
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/makerequest'
example:
orderItems:
- product: 60e4239180ba6071bc7f0651
quantity: 2
avenue: Richardson
apartment: 22B
quartier: Papineau
commune: Freezer
city: London
country: GB
phone: '+1876641270'
status: '1'
notes: je la veux le plus tôt possible
user: 60e404e210106056d0a27d36
required: true
responses:
'200':
description: ''
headers: {}
deprecated: false
/orders/{id}:
get:
tags:
- Orders
summary: getOrder
description: Méthode qui permet de récupérer une commande via son ID
operationId: getOrder
parameters:
- name: id
in: path
description: identifiant de la commande
required: true
style: simple
schema:
type: string
example: 616bbb544b671a83a043ae18
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
put:
tags:
- Orders
summary: updateStatus
description: Méthode qui permet de mettre à jour le status d'une commande via son ID
operationId: updateStatus
parameters:
- name: id
in: path
description: identifiant de la commande
required: true
style: simple
schema:
type: string
example: 616bbb544b671a83a043ae18
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/updateStatusRequest'
example:
status: '2'
required: true
responses:
'200':
description: ''
headers: {}
deprecated: false
delete:
tags:
- Orders
summary: delete
description: Méthode qui permet de supprimer une commande via son ID
operationId: Deletedelete123
parameters:
- name: id
in: path
description: identifiant de la commande
required: true
style: simple
schema:
type: string
example: 616bbb544b671a83a043ae18
responses:
'200':
description: ''
headers: {}
deprecated: false
/orders/get/userorder/{id}:
get:
tags:
- Orders
summary: getAllOrdersByUserID
description: Méthode qui permet de récupérer toutes les commandes effectuées par un client via son ID
operationId: getAllOrdersByUserID
parameters:
- name: id
in: path
description: identifiant de l'utilisateur
required: true
style: simple
schema:
type: string
example: 60e404e210106056d0a27d36
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
/orders/get/count:
get:
tags:
- Orders
summary: count
description: >-
Méthode qui permet d'obtenir le nombre total des commandes effectuées.<br>
@return <b>orderCount</b>
operationId: Getcount12
parameters: []
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
/orders/get/totalsales:
get:
tags:
- Orders
summary: TotalSales
description: >-
Méthode qui permet d'obtenir la valeur totale des commandes vendues.<br>
@return <b>totalSales</b>
operationId: TotalSales
parameters: []
responses:
'200':
description: ''
headers: {}
deprecated: false
/orders/notes/{id}:
put:
tags:
- Orders
summary: updateNotes
description: Méthode qui permet de mettre à jour la note d'une commande via son ID
operationId: updateNotes
parameters:
- name: id
in: path
description: identifiant de la commande
required: true
style: simple
schema:
type: string
example: 616bbb544b671a83a043ae18
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/updateNotesRequest'
example:
notes: je la veux le plus rapidement possible
required: true
responses:
'200':
description: ''
headers: {}
deprecated: false
/reservations:
get:
tags:
- Reservations
summary: getAll
description: Méthode qui permet de récupérer toutes les réservations
operationId: GetgetAll1234
parameters: []
responses:
'200':
description: ''
headers: {}
deprecated: false
post:
tags:
- Reservations
summary: make
description: Méthode qui permet de passer une réservation
operationId: Postmake
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/makerequest1'
example:
user: 60e404e210106056d0a27d36
orderItems:
- product: 60e4239180ba6071bc7f0651
quantity: 2
status: '1'
avenue: Richardson
apartment: 22B
quartier: Papineau
commune: Freezer
city: London
country: GB
notes: je la veux le plus tôt possible
required: true
responses:
'200':
description: ''
headers: {}
deprecated: false
/reservations/{id}:
get:
tags:
- Reservations
summary: getReservation
description: Méthode qui permet de récupérer les informations d'une réservation
operationId: getReservation
parameters:
- name: id
in: path
description: identifiant de la reservation
required: true
style: simple
schema:
type: string
example: 60ed535c7e0c9287acd03bcb
responses:
'200':