-
Notifications
You must be signed in to change notification settings - Fork 0
/
Swagger.yaml
334 lines (334 loc) · 7.93 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
swagger: '2.0'
info:
description: API description for Problem Statement - ProHackative event
version: 1.0.0
title: XYZ Corp eCom API
termsOfService: 'http://swagger.io/terms/'
contact:
email: prohacktive@thbs.com
basePath: /team-member/api
tags:
- name: Login
description: login module
- name: Product
description: product module
- name: Cart
description: cart module
- name: Submit
description: submit module
schemes:
- http
paths:
/login:
post:
tags:
- Login
summary: Login API
description: ''
operationId: login
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: username and password should be passed
required: true
schema:
$ref: '#/definitions/Credentials'
responses:
'200':
description: successful login
schema:
$ref: '#/definitions/Token'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Message'
'401':
description: Invalid Credentials
schema:
$ref: '#/definitions/Message'
/product/view:
get:
tags:
- Product
summary: get the product details
description: get the list of product details
operationId: products
produces:
- application/json
parameters:
- name: token
in: header
description: Resource access token
required: true
type: string
responses:
'200':
description: successful operation
schema:
items:
$ref: '#/definitions/ProductDetail'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Message'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Message'
/product/add:
post:
tags:
- Product
summary: Add a new product
description: Add a product into the catalog
operationId: addProduct
produces:
- application/json
parameters:
- in: body
name: body
description: Product Details
required: true
schema:
$ref: '#/definitions/ProductDetail'
responses:
'200':
description: successful operation
schema:
items:
$ref: '#/definitions/ProductDetail'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Message'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Message'
/cart/add:
post:
tags:
- Cart
summary: add the items to cart
description: add the items to cart
operationId: add
produces:
- application/json
parameters:
- in: body
name: body
description: product id and quantity should be passed
required: true
schema:
$ref: '#/definitions/CartDetails'
- name: token
in: header
description: Resource access token
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/CartId'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Message'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Message'
/cart/view:
get:
tags:
- Cart
summary: View the cart details for a user
description: View the cart details for a user
operationId: view
produces:
- application/json
parameters:
- name: token
in: header
description: Resource access token
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/CartDetails'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Message'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Message'
/cart/modify:
put:
tags:
- Cart
summary: modify the cart
description: modify the cart items
operationId: modify
produces:
- application/json
parameters:
- in: body
name: body
description: product id and quantity should be passed
required: true
schema:
$ref: '#/definitions/CartDetails'
- name: token
in: header
description: Resource access token
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/CartDetails'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Message'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Message'
/cart/delete:
delete:
tags:
- Cart
summary: delete the items
description: delete items from the cart
operationId: delete
produces:
- application/json
parameters:
- in: body
name: body
description: product id and cart id should be passed
required: true
schema:
$ref: '#/definitions/CartDetails'
- name: token
in: header
description: Resource access token
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/Message'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Message'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Message'
/submit:
post:
tags:
- Submit
summary: submit the cart details
description: submit the cart
operationId: submitCart
produces:
- application/json
parameters:
- in: body
name: body
description: pass cartId
required: true
schema:
$ref: '#/definitions/CartId'
- name: token
in: header
description: Resource access token
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/OrderId'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Message'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Message'
definitions:
Credentials:
type: object
properties:
username:
type: string
password:
type: string
Token:
type: object
properties:
usertoken:
type: string
ProductDetail:
type: object
properties:
name:
type: string
description:
type: string
cost:
type: string
category:
type: string
currency:
type: string
qtyAvailable:
type: integer
format: int64
CartDetail:
type: object
properties:
productId:
type: string
quantity:
type: integer
format: int64
cartId:
type: string
CartDetails:
type: array
items:
$ref: '#/definitions/CartDetail'
CartId:
type: object
properties:
cartId:
type: string
OrderId:
type: object
properties:
orderId:
type: integer
format: int 64
Message:
type: object
properties:
code:
type: string