-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
880 lines (838 loc) · 19.8 KB
/
openapi.yaml
File metadata and controls
880 lines (838 loc) · 19.8 KB
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
openapi: 3.1.0
info:
title: Cosmetics E-commerce API
description: A comprehensive API for managing a cosmetics e-commerce platform with admin dashboard and public store functionality.
version: 1.0.0
contact:
name: API Support
email: support@cosmetics.com
servers:
- url: http://localhost:8000/api
description: Local development server
security:
- BearerAuth: []
paths:
# Authentication Endpoints
/public/auth/login:
post:
tags:
- Authentication
summary: Admin Login
security: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- email
- password
properties:
email:
type: string
format: email
example: admin@admin.com
password:
type: string
example: mans123456
responses:
"200":
description: Login successful
content:
application/json:
schema:
$ref: "#/components/schemas/LoginResponse"
/public/auth/logout:
post:
tags:
- Authentication
summary: Admin Logout
responses:
"200":
description: Logout successful
/public/auth/user:
get:
tags:
- Authentication
summary: Get Current User
responses:
"200":
description: User details retrieved
# Public Product Endpoints
/public/products:
get:
tags:
- Public Products
summary: Get All Products
security: []
parameters:
- name: search
in: query
schema:
type: string
description: Search in name, brand, type, description
- name: brand
in: query
schema:
type: string
description: Filter by brand
- name: type
in: query
schema:
type: string
description: Filter by type
- name: gender
in: query
schema:
type: string
enum: [men, women, unisex]
description: Filter by gender
- name: color
in: query
schema:
type: string
description: Filter by color
- name: size
in: query
schema:
type: string
description: Filter by size
- name: min_price
in: query
schema:
type: number
description: Minimum price
- name: max_price
in: query
schema:
type: number
description: Maximum price
- name: in_stock
in: query
schema:
type: boolean
description: Filter by stock availability
- name: sort_by
in: query
schema:
type: string
enum: [name, brand, type, price, created_at]
description: Sort field
- name: sort_order
in: query
schema:
type: string
enum: [asc, desc]
description: Sort direction
- name: per_page
in: query
schema:
type: integer
maximum: 50
description: Items per page
responses:
"200":
description: Products retrieved successfully
content:
application/json:
schema:
$ref: "#/components/schemas/ProductsResponse"
/public/products/{id}:
get:
tags:
- Public Products
summary: Get Single Product
security: []
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
"200":
description: Product retrieved successfully
content:
application/json:
schema:
$ref: "#/components/schemas/ProductResponse"
"404":
description: Product not found
/public/products/{id}/availability:
post:
tags:
- Public Products
summary: Check Product Availability
security: []
parameters:
- name: id
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- quantity
properties:
quantity:
type: integer
minimum: 1
responses:
"200":
description: Availability checked successfully
/public/products/{id}/stock:
get:
tags:
- Public Products
summary: Get Product Stock
security: []
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
"200":
description: Stock information retrieved
/public/products-search:
get:
tags:
- Public Products
summary: Search Products
security: []
parameters:
- name: q
in: query
required: true
schema:
type: string
minLength: 2
maxLength: 100
- name: limit
in: query
schema:
type: integer
minimum: 1
maximum: 20
default: 10
responses:
"200":
description: Search results retrieved
/public/products-featured:
get:
tags:
- Public Products
summary: Get Featured Products
security: []
parameters:
- name: limit
in: query
schema:
type: integer
maximum: 20
default: 8
responses:
"200":
description: Featured products retrieved
/public/products-filters:
get:
tags:
- Public Products
summary: Get Filter Options
security: []
responses:
"200":
description: Filter options retrieved
# Public Order Endpoints
/public/orders:
post:
tags:
- Public Orders
summary: Create Order
security: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateOrderRequest"
responses:
"201":
description: Order created successfully
"422":
description: Validation error
/public/orders/{id}:
get:
tags:
- Public Orders
summary: Get Order Details
security: []
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
"200":
description: Order retrieved successfully
"404":
description: Order not found
/public/orders-track:
get:
tags:
- Public Orders
summary: Track Orders by Email
security: []
parameters:
- name: email
in: query
required: true
schema:
type: string
format: email
responses:
"200":
description: Orders retrieved successfully
"404":
description: No orders found
/public/orders-validate-cart:
post:
tags:
- Public Orders
summary: Validate Cart
security: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- items
properties:
items:
type: array
items:
$ref: "#/components/schemas/CartItem"
responses:
"200":
description: Cart validation completed
# Public Client Endpoints
/public/clients:
post:
tags:
- Public Clients
summary: Register Client
security: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ClientRequest"
responses:
"201":
description: Client created successfully
/public/clients/by-email:
get:
tags:
- Public Clients
summary: Get Client by Email
security: []
parameters:
- name: email
in: query
required: true
schema:
type: string
format: email
responses:
"200":
description: Client retrieved successfully
"404":
description: Client not found
# Admin Product Endpoints
/admin/products:
get:
tags:
- Admin Products
summary: Get All Products (Admin)
parameters:
- name: stock_status
in: query
schema:
type: string
enum: [in_stock, out_of_stock, low_stock]
- name: status
in: query
schema:
type: string
enum: [active, inactive]
responses:
"200":
description: Products retrieved successfully
post:
tags:
- Admin Products
summary: Create Product
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: "#/components/schemas/ProductRequest"
responses:
"201":
description: Product created successfully
/admin/products/{id}:
get:
tags:
- Admin Products
summary: Get Single Product (Admin)
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
"200":
description: Product retrieved successfully
put:
tags:
- Admin Products
summary: Update Product
parameters:
- name: id
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: "#/components/schemas/ProductRequest"
responses:
"200":
description: Product updated successfully
delete:
tags:
- Admin Products
summary: Delete Product
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
"200":
description: Product deleted successfully
# Admin Inventory Endpoints
/admin/inventory:
get:
tags:
- Admin Inventory
summary: Get All Inventory
parameters:
- name: stock_status
in: query
schema:
type: string
enum: [in_stock, out_of_stock, low_stock]
- name: search
in: query
schema:
type: string
- name: brand
in: query
schema:
type: string
- name: type
in: query
schema:
type: string
- name: min_stock
in: query
schema:
type: integer
- name: max_stock
in: query
schema:
type: integer
- name: sort_by
in: query
schema:
type: string
enum: [stock_quantity, min_stock_level, updated_at, product_name]
- name: sort_order
in: query
schema:
type: string
enum: [asc, desc]
- name: per_page
in: query
schema:
type: integer
maximum: 100
responses:
"200":
description: Inventory retrieved successfully
/admin/inventory/{inventory_id}:
get:
tags:
- Admin Inventory
summary: Get Single Inventory Item
parameters:
- name: inventory_id
in: path
required: true
schema:
type: integer
responses:
"200":
description: Inventory item retrieved successfully
patch:
tags:
- Admin Inventory
summary: Update Inventory Item
parameters:
- name: inventory_id
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
stock_quantity:
type: integer
minimum: 0
min_stock_level:
type: integer
minimum: 0
responses:
"200":
description: Inventory updated successfully
/admin/inventory/products/{product_id}/stock:
patch:
tags:
- Admin Inventory
summary: Update Product Stock
parameters:
- name: product_id
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- stock_quantity
properties:
stock_quantity:
type: integer
minimum: 0
operation:
type: string
enum: [set, add, subtract]
default: set
responses:
"200":
description: Stock updated successfully
/admin/inventory-low-stock:
get:
tags:
- Admin Inventory
summary: Get Low Stock Alerts
responses:
"200":
description: Low stock alerts retrieved
/admin/inventory-out-of-stock:
get:
tags:
- Admin Inventory
summary: Get Out of Stock Items
responses:
"200":
description: Out of stock items retrieved
/admin/inventory-statistics:
get:
tags:
- Admin Inventory
summary: Get Inventory Statistics
responses:
"200":
description: Inventory statistics retrieved
/admin/inventory-bulk-update:
patch:
tags:
- Admin Inventory
summary: Bulk Update Stock
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- updates
properties:
updates:
type: array
items:
type: object
required:
- product_id
- stock_quantity
properties:
product_id:
type: integer
stock_quantity:
type: integer
minimum: 0
operation:
type: string
enum: [set, add, subtract]
default: set
responses:
"200":
description: Bulk update completed
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
LoginResponse:
type: object
properties:
success:
type: boolean
data:
type: object
properties:
user:
$ref: "#/components/schemas/User"
token:
type: string
message:
type: string
User:
type: object
properties:
id:
type: integer
name:
type: string
email:
type: string
role:
type: string
Product:
type: object
properties:
id:
type: integer
name:
type: string
description:
type: string
brand:
type: string
type:
type: string
color:
type: string
size:
type: string
gender:
type: string
enum: [men, women, unisex]
price:
type: string
image_url:
type: string
status:
type: string
enum: [active, inactive]
inventory:
type: object
properties:
stock_quantity:
type: integer
min_stock_level:
type: integer
in_stock:
type: boolean
is_low_stock:
type: boolean
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
ProductsResponse:
type: object
properties:
success:
type: boolean
data:
type: object
properties:
data:
type: array
items:
$ref: "#/components/schemas/Product"
current_page:
type: integer
last_page:
type: integer
per_page:
type: integer
total:
type: integer
from:
type: integer
to:
type: integer
message:
type: string
ProductResponse:
type: object
properties:
success:
type: boolean
data:
$ref: "#/components/schemas/Product"
message:
type: string
ProductRequest:
type: object
required:
- name
- brand
- type
- gender
- price
- status
- stock_quantity
- min_stock_level
properties:
name:
type: string
maxLength: 255
description:
type: string
maxLength: 1000
brand:
type: string
maxLength: 255
type:
type: string
maxLength: 255
color:
type: string
maxLength: 100
size:
type: string
maxLength: 50
gender:
type: string
enum: [men, women, unisex]
price:
type: number
minimum: 0
status:
type: string
enum: [active, inactive]
stock_quantity:
type: integer
minimum: 0
min_stock_level:
type: integer
minimum: 0
image:
type: string
format: binary
ClientRequest:
type: object
required:
- name
- email
properties:
name:
type: string
maxLength: 255
email:
type: string
format: email
maxLength: 255
phone:
type: string
maxLength: 20
address:
type: string
maxLength: 500
city:
type: string
maxLength: 100
CartItem:
type: object
required:
- product_id
- quantity
properties:
product_id:
type: integer
quantity:
type: integer
minimum: 1
CreateOrderRequest:
type: object
required:
- client
- items
properties:
client:
$ref: "#/components/schemas/ClientRequest"
items:
type: array
items:
$ref: "#/components/schemas/CartItem"
notes:
type: string
maxLength: 1000
tags:
- name: Authentication
description: Authentication endpoints
- name: Public Products
description: Public product endpoints (no authentication required)
- name: Public Orders
description: Public order endpoints (no authentication required)
- name: Public Clients
description: Public client endpoints (no authentication required)
- name: Admin Products
description: Admin product management endpoints
- name: Admin Inventory
description: Admin inventory management endpoints