-
Notifications
You must be signed in to change notification settings - Fork 1
/
swagger.yaml
426 lines (414 loc) · 11.1 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
swagger: '2.0'
info:
description: API for Weconnect
version: 1.0.0
title: Weconnect
# My Contact Info
contact:
email: [email protected]
basePath: /api/v1
# tags are used for organizing operations
tags:
- name: business
description: Business operations
- name: auth
description: Operations for user details
- name: reviews
description: Operations for reviews
paths:
/businesses:
get:
tags:
- business
summary: list all businesses
description: List all businesses in the application
produces:
- application/json
responses:
200:
description: A paged array of businesses
examples:
application/json:
error: false
business:
- id: 1
name: Andela
details: Brilliance is evenly distributed
category: Ict
location: Lagos
userId: 1
- id: 1
name: seunone Ontop
details: Move it
category: Engineering
location: Lagos
userId: 1
post:
summary: Register a business
tags:
- business
summary: Add business
description: Add business to the application
operationId: add-business
produces:
- application/json
parameters:
- in: formData
name: name
type: string
description: Name of business
required: true
- in: formData
name: details
type: string
description: Details of business
- in: formData
name: location
type: string
description: Location of business
- in: formData
name: category
type: string
description: Category of business
- in: formData
name: token
type: string
description: Token for accessing the endpoint
required: true
responses:
201:
description: Added Business Successfully
examples:
application/json:
error: false
message: Profile created successfully
business:
id: 1
name: Andela
details: Brilliance is evenly distributed
category: Ict
location: Lagos
token: eyJhbGciOiJIUzI1NiIdssdjR5cCI6IkpXVCJ9.eyJpZCI6MSwiaWF0IjoxNTIxMTk0MTE0LCJleHAiOjE1MjI0MDM3MTR9.OeN-Tut9xAg8wYUvC-RPLbTqIcGXH5zZamP_o5wTZrc
400:
description: Invalid input
examples:
application/json:
error: true
message: 'Name is required'
/businesses?location={location}:
get:
tags:
- business
summary: list businesses in location
operationId: location
description: List all busnesses in a given location
produces:
- application/json
parameters:
- name: location
in: path
required: true
description: The location of the business to retrieve
type: string
responses:
200:
description: A paged array of businesses
examples:
application/json:
/businesses?category={category}:
get:
tags:
- business
summary: list all businesses
operationId: category
description: List all businesses in a category
produces:
- application/json
parameters:
- name: category
in: path
required: true
description: The category of the business to retrieve
type: string
responses:
200:
description: A paged array of businesses
examples:
application/json:
/businesses/{id}:
get:
summary: Info for a specific business
tags:
- business
produces:
- application/json
parameters:
- name: id
in: path
required: true
description: The id of the business to retrieve
type: integer
responses:
200:
description: Success, business found
examples:
application/json:
message: 'Success'
error: false
business:
id: 3
name: 'HotelsNg'
details: 'Rent rooms'
location: 'Lagos'
category: 'ICT'
reviews: []
404:
description: business not found
examples:
application/json:
error: 'true'
message: 'Business not found'
put:
summary: update specific business
tags:
- business
produces:
- application/json
parameters:
- in: path
name: id
required: true
description: The id of the business to retrieve
type: integer
- in: formData
name: name
type: string
description: Name of business
required: true
- in: formData
name: details
type: string
description: Details of business
required: true
- in: formData
name: location
type: string
description: Location of business
required: true
- in: formData
name: category
type: string
description: Category of business
required: true
- in: formData
name: token
type: string
description: Token for accessing endpoint
required: true
responses:
200:
description: Expected response to be valid request
examples:
application/json:
message: 'Success'
error: false
business:
id: 3
name: 'HotelsNg'
details: 'Rent rooms'
location: 'Lagos'
category: 'ICT'
token: eyJhbGciOiJIUzI1NiIdssdjR5cCI6IkpXVCJ9.eyJpZCI6MSwiaWF0IjoxNTIxMTk0MTE0LCJleHAiOjE1MjI0MDM3MTR9.OeN-Tut9xAg8wYUvC-RPLbTqIcGXH5zZamP_o5wTZrc
404:
description: business not found
examples:
application/json:
error: 'true'
message: 'Business not found'
delete:
summary: delete specific business
tags:
- business
produces:
- application/json
parameters:
- in: path
name: id
required: true
description: The id of the business to delete
type: integer
- in: formData
name: token
type: string
description: Token for accessing endpoint
required: true
responses:
200:
description: Business deleted
examples:
application/json:
error: false
message: 'Business deleted'
403:
description: Forbidden
examples:
application/json:
error: true
message: 'You do not have the priviledge to delete this business'
404:
description: business not found
examples:
application/json:
error: 'true'
message: 'Business not found'
/businesses/{id}/reviews:
get:
tags:
- reviews
summary: list reviews
description: List reviews of a business
produces:
- application/json
parameters:
- name: id
description: id of the business to get reviews
in: path
type: integer
minimum: 1
required: true
responses:
200:
description: an array of reviews
examples:
application/json:
error: false
review:
userId: 1
businessId: 3
content: Lorem Ipsum
stars: 4
400:
description: Business could not be found
examples:
application/json:
error: true
post:
tags:
- reviews
summary: Add review
description: Add review of a business
produces:
- application/json
parameters:
- name: id
in: path
description: id of the business to add review
type: integer
minimum: 1
required: true
- name: content
in: formData
description: Content of the review
type: string
required: true
- name: stars
in: formData
description: Amount of stars given
type: integer
minimum: 1
maximum: 5
required: true
- in: formData
name: token
type: string
description: Token for accessing endpoint
required: true
responses:
200:
description: Review Added
examples:
application/json:
error: false
review:
content: Amazing service
stars: 5
token: eyJhbGciOiJIUzI1NiIdssdjR5cCI6IkpXVCJ9.eyJpZCI6MSwiaWF0IjoxNTIxMTk0MTE0LCJleHAiOjE1MjI0MDM3MTR9.OeN-Tut9xAg8wYUvC-RPLbTqIcGXH5zZamP_o5wTZrc
400:
description: Business could not be found
examples:
application/json:
error: true
/auth/login:
post:
tags:
- auth
summary: login a user
description: Log in a user to the application
produces:
- application/json
parameters:
- name: email
in: formData
description: email of the user
type: string
required: true
- name: password
in: formData
description: password of the user
type: string
required: true
responses:
200:
description: Success, user is logged in
examples:
application/json:
error: false
message: 'logged in successfully'
400:
description: Invalid Input
examples:
application/json:
error: true
message: Unable to login
/auth/signup:
post:
tags:
- auth
summary: Signup a user
description: Signup user into the application
produces:
- application/json
parameters:
- name: email
in: formData
description: email of the user
type: string
required: true
- name: password
in: formData
description: password of the user
type: string
required: true
- name: firstName
in: formData
description: User First Name
type: string
required: true
- name: lastName
in: formData
description: User Last name
type: string
required: true
responses:
200:
description: Success, user is signed up
examples:
application/json:
error: false
message: 'signup in successfully'
400:
description: Invalid Input
examples:
application/json:
error: true
message: Unable to login