-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yml
491 lines (487 loc) · 13.8 KB
/
openapi.yml
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
openapi: 3.0.3
info:
title: EazyShop Products API Definition
description: |
# About Us
**EazyShop** is a open market product selling company. Any website can list our products by using our _APIs_. Shipping & other logistics will be taken care by us. You will get an `Affiliate commision` for selling our products.
# Categories suported
- Mobiles
- Apple
- Samsung
- OnePlus
- Laptops
- Televisions
- Headphones
termsOfService: https://easyshop.com/terms/
contact:
name: API Support
url: https://www.easyshop.com/supprt
email: [email protected]
license:
name: EasyShop License
url: http://www.easyshop.com/license
version: 0.0.1
externalDocs:
description: External Docs
url: https://example.com
servers:
- url: https://dev.eazyshop-server.com/v1
description: Development server
tags:
- name: Categories
description: Categories-related operations
- name: Products
description: Products-related operations
- name: Orders
description: Orders-related operations
security:
- BasicAuth: []
- BearerAuth: []
- ApiKeyAuth: []
- oAuth2AuthCode:
- read
- write
- admin
paths:
/categories:
get:
tags:
- Categories
summary: List all categories
description: Returns the list of categories supported by EasyShop
operationId: getCategories
security:
- BasicAuth: []
parameters:
- name: page
in: query
schema:
type: integer
minimum: 100
maximum: 1000
examples:
mobiles:
summary: Use this example for mobiles
value: 101
laptops:
value: 102
headphones:
value: 103
televisions:
value: 104
responses:
'200':
description: A list of categories
content:
application/json:
schema:
type: array
items:
type: object
properties:
categoryId:
type: integer
name:
type: string
examples:
all-categories-data:
summary: Categories example data
value:
- categoryId: 101
name: Mobiles
- categoryId: 102
name: Laptops
- categoryId: 103
name: Headphones
- categoryId: 104
name: Televisions
single-category-data:
summary: Single category example data
value:
- categoryId: 101
name: Mobiles
/categories/{categoryId}:
get:
tags:
- Categories
summary: List specific categories
description: Returns category by Id
operationId: getCategoryDetails
parameters:
- name: categoryId
in: path
required: true
schema:
type: integer
minimum: 100
maximum: 1000
example: 101
responses:
'200':
description: A list of categories
content:
application:/json:
schema:
type: object
properties:
categoryId:
type: integer
name:
type: string
/products:
get:
tags:
- Products
summary: List all products
description: |
Returns the list of products supported by EasyShop
operationId: getProducts
parameters:
- name: categoryId
in: query
schema:
type: integer
minimum: 100
maximum: 1000
example: 101
responses:
'200':
description: A list of products
content:
application/json:
schema:
type: array
items:
type: object
properties:
productId:
type: integer
name:
type: string
price:
type: number
categoryName:
type: string
releaseDate:
type: string
format: date
readOnly: true
quantity:
type: integer
description: |
***Quantity*** represents `stock` value when this field is being sent by EazyShop.Where as in the scenarios of consumer sending this feild, it represents `number of product items` inside the order. Consumers are expected to handle the scenario of stopping the end user <u>*when the stock value is 0*</u>
examples:
products-data:
summary: Products example data
value:
- productId: 101
name: Apple IPhone 13 Pro
price: 999.99
categoryName: Mobiles
quantity: 96
- productId: 102
name: Samsung S22 Ultra
price: 899.99
categoryName: Mobiles
quantity: 121
- productId: 103
name: OnePlus 10 Pro 5G
price: 750.99
categoryName: Mobiles
quantity: 67
/products/{productId}:
get:
tags:
- Products
summary: List specific products
description: |
Returns product details from
EasyShop
operationId: getProductDetails
parameters:
- name: productId
in: path
required: true
schema:
type: integer
minimum: 100
maximum: 1000
example: 101
responses:
'200':
description: A list of products by id
content:
application:/json:
schema:
type: object
properties:
productId:
type: integer
name:
type: string
price:
type: number
categoryName:
type: string
quantity:
type: integer
/orders:
post:
tags:
- Orders
summary: Create order
description: |
Post order details to EasyShop for processing and shipping
operationId: postOrder
requestBody:
content:
application/json:
schema:
type: object
properties:
products:
type: array
items:
type: object
properties:
productsId:
type: integer
name:
type: string
categoryName:
type: string
releaseDate:
type: string
format: date
quantity:
type: integer
address:
$ref: "#/components/schemas/Address"
responses:
'201':
description: Order created successfully
content:
application/json:
schema:
type: object
properties:
orderId:
type: integer
links:
GetOrderByOrderId:
$ref: '#/components/links/GetOrderByOrderId'
'500':
$ref: "#/components/responses/InternalServerError"
put:
tags:
- Orders
summary: Update order
description: |
Update order details to EasyShop for processing and shipping
operationId: updateOrder
requestBody:
content:
application/json:
schema:
type: object
properties:
orderId:
type: integer
products:
type: array
items:
type: object
properties:
productsId:
type: integer
name:
type: string
categoryName:
type: string
quantity:
type: integer
address:
$ref: "#/components/schemas/Address"
responses:
'201':
description: Order details successfully updated
delete:
tags:
- Orders
summary: Delete order
description: |
Delete order details from EasyShop
parameters:
- $ref: "#/components/parameters/orderIdQueryParam"
responses:
'204':
description: Order details successfully deleted
get:
tags:
- Orders
summary: Get order details
description: |
Delete order details from
EasyShop
parameters:
- $ref: "#/components/parameters/orderIdQueryParam"
responses:
'200':
description: Fetch Order details successfully
content:
application/json:
schema:
type: object
properties:
orderId:
type: integer
products:
type: array
items:
type: object
properties:
productId:
type: integer
name:
type: string
price:
type: number
categoryName:
type: string
quantity:
type: integer
address:
$ref: "#/components/schemas/Address"
city:
$ref: "#/components/schemas/Address"
'500':
$ref: "#/components/responses/InternalServerError"
/orders/{orderId}:
get:
tags:
- Orders
summary: Get order details
description: |
Delete order details from
EasyShop
operationId: getOrderUsingParams
deprecated: true
parameters:
- $ref: "#/components/parameters/orderIdPathParam"
responses:
'200':
description: Fetch Order details successfully
content:
application/json:
schema:
type: object
properties:
orderId:
type: integer
products:
type: array
items:
type: object
properties:
productId:
type: integer
name:
type: string
price:
type: number
categoryName:
type: string
quantity:
type: integer
address:
$ref: "#/components/schemas/Address"
city:
$ref: "#/components/schemas/Address"
'500':
$ref: "#/components/responses/InternalServerError"
components:
parameters:
orderIdQueryParam:
name: orderId
in: query
required: true
schema:
type: integer
orderIdPathParam:
name: orderId
in: path
required: true
schema:
type: integer
schemas:
Address:
type: object
properties:
addressLine:
type: string
city:
type: string
state:
type: string
enum:
- California
- Texas
- Lagos
zipcode:
type: string
isOfficeAddress:
type: boolean
required: [addressLine, city, state]
City:
allOf:
- $ref: "#/components/schemas/Address"
- type: object
properties:
losAngeles:
type: string
enum:
- road 2
- road 3
Mobile:
allOf:
- type: object
properties:
networkType:
type: string
enum:
- 4G
- 5G
required: [networkType]
responses:
InternalServerError:
description: |
An error occured while processing the request. Please contact support
links:
GetOrderByOrderId:
description: >
The `orderId` value returned in the response can be used as input parameter in `GET /orders`.
operationId: getProductDetails
parameters:
orderId: '$response.body#/orderId'
securitySchemes:
BasicAuth:
type: http
scheme: basic
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
oAuth2AuthCode:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://example.com/oauth/authorize
tokenUrl: https://example.com/api/oauth.access
scopes:
read: Read only access
write: Read Write access
admin: Admin access