-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi.yaml
1547 lines (1472 loc) · 46.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: Online shop API
version: 1.0.0
description: >-
A RESTful API that serves as the application tier for a full-stack
e-commerce application. This API allows customers to create accounts,
browse products, filter products in various ways (e.g. by category,
supplier, stock, price, and so on), leave reviews and recommendations
on products, add and remove items to cart, add and remove items from
wishlist, create new orders, browse previous orders, view and update
account details, add/delete/update billing and shipping addresses,
and more.
#*****************************************************************#
#*****************************************************************#
paths:
#*****************************************************************#
/api/login:
summary: Allows customer to login using existing account.
post:
summary: Login using a username and a password.
operationId: login
requestBody:
description: request body requirements for login requests
required: true
content:
application/json:
schema:
allOf:
- required:
- username
- password
- $ref: '#/components/schemas/Login'
example:
username: "john8779"
password: "passwordabc123"
responses:
'200':
description: Default error sample response
content:
application/json:
schema:
$ref: '#/components/responses/LoginResponse'
example:
customer:
name: Andreane Buckridge
username: Andreane36
email: Andreane.Buckridge24@gmail.com
'401':
$ref: '#/components/responses/Unauthenticated'
tags:
- Login
#*****************************************************************#
/api/signup:
summary: Allows customer to create new account.
post:
summary: Sign up for a new account.
operationId: signup
requestBody:
description: request body requirements for signup requests
required: true
content:
application/json:
schema:
allOf:
- required:
- username
- password
- name
- email
- $ref: '#/components/schemas/Signup'
example:
name: "Mike Rumble"
username: "mkr98"
password: "password123"
email: "mike@aol.com"
responses:
'201':
description: successful creation of a new account
content:
application/json:
schema:
$ref: '#/components/responses/CustomerResponse'
'400':
description: bad request caused by request bodies with missing or invalid data.
content:
application/json:
schema:
$ref: '#/components/responses/SignupError'
tags:
- Signup
#*****************************************************************#
/api/logout:
summary: Logs customer out of their account.
post:
summary: Logout of current session.
description: No request body required.
operationId: logout
responses:
'200':
description: successful logout
content:
application/json:
schema:
type: object
properties:
msg:
type: string
example:
msg: "Andrddeane36 is now logged out."
'401':
$ref: '#/components/responses/Unauthenticated'
tags:
- Logout
#*****************************************************************#
/api/products:
summary: Returns a listing of all products.
description: >-
Returns a paginated list of products which can be sorted, filtered and
ordered via query parameters.
get:
summary: Gets all products.
description: >-
Gets a list of 25 products per page and allows pagination through query
parameters.
parameters:
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/limitParam'
- $ref: '#/components/parameters/categoryParam'
- $ref: '#/components/parameters/supplierParam'
- $ref: '#/components/parameters/sortByParam'
- $ref: '#/components/parameters/orderParam'
- $ref: '#/components/parameters/hideOutOfStockParam'
- $ref: '#/components/parameters/minPriceParam'
- $ref: '#/components/parameters/maxPriceParam'
operationId: get_products
responses:
'200':
description: paginated list of products
content:
application/json:
schema:
$ref: '#/components/responses/ProductsResponse'
'400':
description: bad request caused by invalid query parameters containing invalid data types or column names.
content:
application/json:
schema:
$ref: '#/components/responses/InvalidQuery'
tags:
- Products
#*****************************************************************#
/api/products/bestsellers:
summary: Returns list of bestselling products.
description: Allow customer to view the most frequently ordered products.
get:
summary: Get list of bestselling products.
description: >-
Get list of products that have been ordered the most. Excludes products
that have 0 orders.
parameters:
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/limitParam'
operationId: get_bestsellers
responses:
'200':
description: list of bestsellers
content:
application/json:
schema:
$ref: '#/components/responses/BestsellersResponse'
tags:
- Products
#*****************************************************************#
/api/products/{productId}:
summary: Returns a specific product object.
description: Returns a specific product object.
parameters:
- $ref: '#/components/parameters/productIdParam'
get:
summary: Get single product by id.
description: >-
Includes all of the product's data, including average rating, total
ratings, total orders
operationId: get_product_by_id
responses:
'200':
description: get single product
content:
application/json:
schema:
$ref: '#/components/responses/SingleProductResponse'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Products
#*****************************************************************#
/api/products/{productId}/reviews:
summary: Returns list of all reviews for a single product.
description: Returns a paginated list of reviews for a specific product.
get:
summary: Get all reviews for a specific product.
operationId: get_reviews_by_product
parameters:
- $ref: '#/components/parameters/productIdParam'
responses:
'200':
description: paginated list of products
content:
application/json:
schema:
$ref: '#/components/responses/ReviewsResponse'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Reviews
#*****************************************************************#
/api/customers/{customerId}:
summary: Returns a specific customer object.
description: Allows a customer to view, update or delete their own account.
parameters:
- $ref: '#/components/parameters/customerIdParam'
get:
summary: Get all of a customer's data.
description: Get all of a customer's data, including billing and shipping address.
operationId: get_customer_by_id
responses:
'200':
description: customer's account data
content:
application/json:
schema:
$ref: '#/components/responses/CustomerResponseWithAddress'
'403':
$ref: '#/components/responses/Unauthorised'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Customer
put:
summary: Update customer details.
description: Allows customer to update own account details.
requestBody:
$ref: '#/components/requestBodies/UpdateCustomerAccountRequest'
operationId: update_customer
responses:
'200':
description: returns updated customer account details
content:
application/json:
schema:
$ref: '#/components/responses/CustomerResponse'
example:
id: 1,
name: "Alex Nes"
username: "alexnes"
password: "**********"
email: "alex-nes@nexus.pk"
joinDate: "2023-08-01T16:20:52.150Z"
phone: null
billingAddressId: 1
shippingAddressId: 1
avatar: null
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Customer
delete:
summary: Delete a customer
description: >-
Deletes all data for a specific customer - their account, all of their orders and wishlist.
operationId: delete_customer
responses:
'200':
description: successful account deletion
content:
application/json:
schema:
type: object
properties:
msg:
type: string
deletedUser:
type: object
properties:
id:
type: integer
name:
type: string
username:
type: string
email:
type: string
example:
msg: "User Andrddeane36 has been deleted."
deletedUser:
id: 6
name: "Andre Ane"
username: "Andranna8"
email: "andrea8@yayaya.com"
'404':
$ref: '#/components/responses/NotFound'
tags:
- Customer
#*****************************************************************#
/api/customers/{customerId}/cart:
summary: Returns list of all cart items for a specific customer.
description: Allows customer to view, modify or clear their own cart.
parameters:
- $ref: '#/components/parameters/customerIdParam'
- $ref: '#/components/parameters/formatParam'
get:
summary: Get customer's cart items.
description: >-
View all of a customer's cart items, in a full format or as a simplified
array.
operationId: get_cart_items
responses:
'200':
description: get customer's cart items
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Cart'
- $ref: '#/components/schemas/CartAltFormat'
example:
cart:
id: 1
name: Alex Nes
username: alexnes
cartItems:
- quantity: 2
product:
id: 56
name: skateboard
description: XL adult skateboard with a single wheel
price: '416.72'
stock: 12
categoryName: Sports
supplierName: John's Sporting Goods
thumbnail: https://loremflickr.com/640/480/Garden?lock=1158606886010880
- quantity: 1
product:
id: 56
name: bicarbonate of soda
description: part of the baking collection
price: '2.24'
stock: 13
categoryName: Food
supplierName: Uncle Baltar's Treats
thumbnail: https://avatars.com/commerce/food/7225
'404':
$ref: '#/components/responses/NotFound'
tags:
- Cart
put:
summary: Update cart.
description: >-
Allows customer to remove or add cart items and to modify their
quantities.
operationId: udpate_cart
responses:
'200':
description: returns updated cart
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Cart'
- $ref: '#/components/schemas/CartAltFormat'
'403':
$ref: '#/components/responses/Unauthorised'
'400':
$ref: '#/components/responses/BadRequest'
tags:
- Cart
#*****************************************************************#
/api/customers/{customerId}/wishlist:
summary: Returns a customer's wishlist.
description: Allows customer to view and modify own wishlist.
parameters:
- name: customerId
in: path
description: The id of the customer.
required: true
schema:
type: string
get:
summary: Get customer's wishlist items.
description: Get all items that the customer has added to their wishlist.
operationId: get_wishlist_items
responses:
'200':
description: a customer's wishlist items
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Wishlist'
- $ref: '#/components/schemas/WishlistAltFormat'
example:
wishlist:
id: 1
name: Alex Nes
username: alexnes
wishlistItems:
- product:
id: 12
name: sunglasses
description: polarized brown lenses
price: '136.82'
stock: 184
categoryName: Accessories
supplierName: Kris & Sons
thumbnail: https://loremflickr.com/640/480/Garden?lock=1158606886010880
- product:
id: 56
name: brown leather shoes
description: fake leather brown shoes with tassels
price: '36.24'
stock: 13
categoryName: Shoes
supplierName: Jefferson Ltd
thumbnail: https://avatars.com/commerce/shoes/23443
'403':
$ref: '#/components/responses/Unauthorised'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Wishlist
put:
summary: Update wishlist.
description: Allows customer to add or remove items from their wishlist.
operationId: update_wishlist
responses:
'200':
description: returns updated wishlist
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Cart'
- $ref: '#/components/schemas/CartAltFormat'
'400':
$ref: '#/components/responses/BadRequest'
tags:
- Wishlist
#*****************************************************************#
/api/customers/{customerId}/orders:
summary: Returns a customer's orders or creates a new order.
description: Allows customer to view previous orders or to create a new order.
parameters:
- $ref: '#/components/parameters/customerIdParam'
get:
summary: Get customer's orders.
description: >-
Get all orders for a specific customer, including dates, addresses and
products ordered.
operationId: get_orders
responses:
'200':
description: returns list of customer's orders
content:
application/json:
schema:
$ref: '#/components/responses/OrdersResponse'
'404':
$ref: '#/components/responses/NotFound'
'400':
$ref: '#/components/responses/BadRequest'
tags:
- Orders
post:
summary: Create new order.
description: >-
Creates a new order for that customer, either using all of their cart
items or a single item provided in the request body.
requestBody:
$ref: '#/components/requestBodies/OrdersRequest'
operationId: create_order
responses:
'201':
description: successful creation of a new order
content:
application/json:
schema:
$ref: '#/components/schemas/SingleOrder'
example:
id: 23
customerId: 1
billingAddressId: 1
shippingAddressId: 1,
status: completed
createdAt: "2023-08-01T23:54:44.756Z"
billingAddress:
id": 1
addressLine1": "321 Hyatt Green"
addressLine2: "Apt. 843"
city": "Grant Hill"
county": "Worcestershire"
postcode: "MZ3 1XS"
shippingAddress:
id": 1
addressLine1": "321 Hyatt Green"
addressLine2: "Apt. 843"
city": "Grant Hill"
county": "Worcestershire"
postcode: "MZ3 1XS"
orderItems:
- quantity: 3
product:
id: 12
name: charging cable
description: premium cable made from cheap materials
price: '36.20'
stock: 15
categoryName: Electronics
supplierName: Kryden Industries
thumbnail: https://loremflickr.com/647266532-12765
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Orders
#*****************************************************************#
/api/customers/{customerId}/favorites:
summary: Returns products that have been recommended by the customer.
parameters:
- name: customerId
in: path
description: The id of the customer.
required: true
schema:
type: string
get:
summary: Get customer's recommended items.
description: Get all items that have been recommended in reviews by a customer.
operationId: get_favorites
responses:
'200':
description: Returns list of products that have been marked as 'recommended' by the customer.
content:
application/json:
schema:
$ref: '#/components/responses/FavoritesResponse'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Customer
#*****************************************************************#
/api/customers/{customerId}/orders/{orderId}:
summary: Returns single order
description: >-
Allows customer to view details about a single order, including date,
addresses and products.
parameters:
- $ref: '#/components/parameters/customerIdParam'
- $ref: '#/components/parameters/orderIdParam'
- $ref: '#/components/parameters/productIdQueryParam'
get:
summary: Get single order.
description: Get all data about a specific order.
operationId: get_order_by_id
responses:
'200':
description: get all the information about a specific order
content:
application/json:
schema:
$ref: '#/components/schemas/SingleOrder'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Orders
#*****************************************************************#
/api/customers/{customerId}/reviews:
summary: Returns all reviews posted by a customer.
parameters:
- $ref: '#/components/parameters/customerIdParam'
get:
summary: Get all reviews.
description: Get a paginated list of reviews.
operationId: get_reviews_by_customer
responses:
'200':
description: returns list of a single customer's reviews
content:
application/json:
schema:
$ref: '#/components/responses/ReviewsResponse'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Reviews
#*****************************************************************#
/api/customers/{customerId}/addresses:
summary: Create or edit address.
description: Allows customer to create a new address or modify an existing one.
parameters:
- $ref: '#/components/parameters/customerIdParam'
post:
summary: Create or modify address.
description: Allows customer to create or modify billing or shipping address.
requestBody:
$ref: '#/components/requestBodies/UpdateCustomerAddressRequest'
operationId: create_address
responses:
'201':
description: Allows customer to create or edit an address on their account.
content:
application/json:
schema:
$ref: '#/components/responses/CustomerResponseWithAddress'
'400':
$ref: '#/components/responses/BadRequest'
tags:
- Address
#*****************************************************************#
/api/customers/{customerId}/addresses/{addressId}:
summary: Allows customer to delete an address.
description: Deletes billing or shipping address by id.
parameters:
- $ref: '#/components/parameters/customerIdParam'
- $ref: '#/components/parameters/addressIdParam'
delete:
summary: Delete address.
description: Allows customer to delete their billing or shipping address.
operationId: delete_address
responses:
'200':
description: address successfully deleted from customer's account, leaving behind a null value
content:
application/json:
schema:
$ref: '#/components/responses/CustomerResponseWithAddress'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Address
#*****************************************************************#
/api/categories:
summary: Returns list of all product categories.
get:
summary: Get all categories.
operationId: get_categories
responses:
'200':
description: Returns list of all categories.
content:
application/json:
schema:
type: object
properties:
categories:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
description:
type: string
thumbnail:
type: string
products:
description: the total number of unique products that fall under this category
type: string
tags:
- Categories
#*****************************************************************#
/api/suppliers:
summary: Returns list of all suppliers.
get:
summary: Get all suppliers.
operationId: get_suppliers
responses:
'200':
description: Returns list of all suppliers.
content:
application/json:
schema:
type: object
properties:
suppliers:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
location:
type: string
establishYear:
type: integer
thumbnail:
type: string
products:
description: the total number of unique products that are sold by this supplier
type: string
tags:
- Suppliers
#*****************************************************************#
/api/reviews:
summary: Returns list of all reviews.
description: Allows pagination.
get:
summary: Get all reviews.
operationId: get_reviews
responses:
'200':
description: Returns the first 25 reviews, sorted by most recent first.
content:
application/json:
schema:
$ref: '#/components/responses/ReviewsResponse'
tags:
- Reviews
#*****************************************************************#
/api/reviews/{reviewId}:
summary: Returns single review.
parameters:
- $ref: '#/components/parameters/reviewIdParam'
get:
summary: Get single review.
description: Returns a single review object, matching the provided id.
operationId: get_review_by_id
responses:
'200':
description: returns all relevant data for a single review.
content:
application/json:
schema:
$ref: '#/components/schemas/Review'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Reviews
post:
summary: Post a new review.
description: Allows customer to post a new review for an item they have previously purchased and not yet reviews.
requestBody:
description: fields required for updating a review
content:
application/json:
schema:
allOf:
- required:
- customerId
- productId
- title
- body
- rating
- $ref: '#/components/schemas/Review'
operationId: update_review
responses:
'200':
description: Returns the newly created review.
content:
application/json:
schema:
type: object
properties:
newReview:
$ref: '#/components/schemas/Review'
'400':
$ref: '#/components/responses/BadRequest'
tags:
- Reviews
put:
summary: Modify an existing review.
description: Allows customer to modify a variable/unknown number of attributes for a single review.
requestBody:
description: optional fields can be specified to modify the review's attributes
required: false
content:
application/json:
schema:
type: object
properties:
customerId:
type: integer
productId:
type: integer
title:
type: string
body:
type: string
recommend:
type: boolean
nullable: true
rating:
type: integer
responses:
'200':
description: Returns the updated review
content:
application/json:
schema:
type: object
properties:
updatedReview:
$ref: '#/components/schemas/Review'
'404':
$ref: '#/components/responses/NotFound'
'400':
$ref: '#/components/responses/BadRequest'
tags:
- Reviews
delete:
summary: Delete a review.
description: Delete a specific review from the customer's reviews.
operationId: delete_review
responses:
'200':
description: returns the deleted review.
content:
application/json:
schema:
$ref: '#/components/schemas/Review'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Reviews
#*****************************************************************#
#*****************************************************************#
components:
schemas:
#*****************************************************************#
Address:
type: object
properties:
addressLine1:
type: string
addressLine2:
type: string
nullable: true
city:
type: string
county:
type: string
nullable: true
postcode:
type: string
Login:
type: object
properties:
username:
type: string
password:
type: string
Signup:
type: object
properties:
username:
type: string
password:
type: string
name:
type: string
email:
type: string
phone:
type: string
avatar:
type: string
SingleOrderBase:
type: object
properties:
id:
type: integer
customerId:
type: integer
billingAddressId:
type: integer
shippingAddressId:
type: integer
status:
type: string
createdAt:
type: string
shippingAddress:
$ref: '#/components/schemas/Address'
billingAddress:
$ref: '#/components/schemas/Address'
orderItems:
type: array
items:
$ref: '#/components/schemas/Product'
SingleOrder:
type: object
allOf:
- $ref: SingleOrderBase
- type: object
properties:
billingAddress:
$ref: '#/components/schemas/Address'
Orders:
type: object
properties:
id:
type: integer
name:
type: string
username:
type: string
orders:
type: array
items:
$ref: '#/components/schemas/SingleOrderBase'
Product:
type: object
properties:
id:
type: integer
name:
type: string
description:
type: string
price:
type: string
stock:
type: integer
categoryName:
type: string
supplierName:
type: string
thumbnail:
type: string
Customer:
type: object
properties:
id:
type: number
name:
type: string
username:
type: string
password:
type: string
enum: ["**********"]
email:
type: string
joinDate:
type: string
phone:
type: string
nullable: true
billingAddressId:
type: integer
nullable: true
shippingAddressId:
type: integer
nullable: true
avatar:
type: string
nullable: true
CustomerWithAddresses:
allOf:
- $ref: '#/components/schemas/Customer'
- type: object