-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
322 lines (318 loc) · 10 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
swagger: '2.0'
info:
version: 'v1'
title: Rest API for the Population Management System
description: |
### This is the API documentation for the [Population Management System](https://github.com/azeezolaniran2016/population-management-system) developed as part of a pilot phase LMS progression process.
basePath: /api/v1
host: localhost:3000
paths:
/locations:
post:
summary: Create a location
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: Location
description: Locations to be created
required: true
schema:
$ref: '#/definitions/Location'
responses:
201:
description: Successfully created Location
schema:
type: object
properties:
id:
type: integer
example: 1
description: ID of the created Location
400:
description: Bad request. One or more required fields are missing.
schema:
type: object
properties:
msg:
type: array
description: List of each error that occured
items:
type: object
properties:
msg:
type: string
example: Location name is required.
description: Textual description of the error
406:
description: Invalid request
schema:
type: object
properties:
msg:
type: string
example: Failed to process request. Invalid request.
description: Error message
409:
description: Conflict. Location already exists
schema:
type: object
properties:
msg:
type: array
items:
type: object
properties:
msg:
type: string
example: Location with name already exists
description: Textual description of error that occured
500:
description: Internal server error occurred
schema:
type: object
properties:
msg:
type: string
example: An internal server error occurred
get:
summary: Fetch all locations
consumes:
- application/json
responses:
200:
description: List of all locations that have been saved
schema:
type: array
items:
type: object
properties:
id:
type: integer
example: 1
femalePopulation:
type: integer
example: 100
description: Total female population in the location
malePopulation:
type: integer
example: 100
description: Total male population in the location
name:
type: string
example: Ikeja
description: Name of the Location
createdAt:
type: string
example: '2018-03-24T14:19:00.600Z'
description: Time stamp of when the location was creeated
updatedAt:
type: string
example: '2018-03-24T14:19:00.600Z'
description: Time stamp of when the location was last updated
subLocations:
type: array
description: List containing IDs of all sub-locations in this Location
items:
type: object
properties:
id:
type: integer
example: 2
description: ID of a sub-location in this fetched location
/locations/{id}:
get:
summary: Fetch a specific location
consumes:
- application/json
parameters:
- in: path
name: id
minimum: 1
required: true
type: integer
responses:
200:
description: Details of Location fetched
schema:
type: object
properties:
id:
type: integer
example: 1
femalePopulation:
type: integer
example: 100
description: Total female population in the location
malePopulation:
type: integer
example: 100
description: Total male population in the location
name:
type: string
example: Ikeja
description: Name of the Location
createdAt:
type: string
example: '2018-03-24T14:19:00.600Z'
description: Time stamp of when the location was creeated
updatedAt:
type: string
example: '2018-03-24T14:19:00.600Z'
description: Time stamp of when the location was last updated
subLocations:
type: array
description: List containing IDs of all sub-locations in this Location
items:
type: object
properties:
id:
type: integer
example: 2
description: ID of a sub-location in this fetched location
put:
summary: Update specific location
consumes:
- application/json
parameters:
- in: path
name: id
minimum: 1
required: true
description: ID of the Location to be updated
type: integer
- in: body
name: Location
description: Update data
required: true
schema:
$ref: '#/definitions/Location'
responses:
200:
description: Successfully updated location
schema:
type: object
properties:
id:
type: integer
example: 1
description: ID of the updated location
400:
description: Bad request. One or more required fields are missing
schema:
type: object
properties:
msg:
type: array
items:
type: object
properties:
msg:
type: string
example: Location name is required
description: Textual description of error that occured
404:
description: Specified Location does not exist
schema:
type: object
properties:
msg:
type: string
example: Failed to update location. Not found.
description: Error message
406:
description: Invalid request
schema:
type: object
properties:
msg:
type: string
example: Failed to process request. Invalid request.
description: Error message
409:
description: Conflict. Location already exists
schema:
type: object
properties:
msg:
type: array
items:
type: object
properties:
msg:
type: string
example: Location with name already exists
description: Textual description of error that occured
500:
description: Internal server error occurred
schema:
type: object
properties:
msg:
type: string
example: An internal server error occurred
description: Textual description of error that occured
delete:
summary: Delete a specific Location and set it's sub-locations parentIDs to null
parameters:
- in: path
name: id
minimum: 1
required: true
type: integer
description: ID of the location to be deleted
responses:
200:
description: Successfully deleted location
schema:
type: object
properties:
id:
type: object
properties:
msg:
type: string
example: Location deleted
description: Textual description of request status
404:
description: Specified location does not exist
schema:
type: object
properties:
msg:
type: string
example: Failed to delete location. Not found.
description: Textual description of error that occured
500:
description: Internal server error occurred
schema:
type: object
properties:
msg:
type: string
example: An internal server error occurred
description: Textual description of error that occured
definitions:
Location:
type: object
properties:
malePopulation:
type: integer
description: Population of males
example: 100
minimum: 0
femalePopulation:
type: string
description: Population of females
example: 100
minimum: 0
name:
type: string
example: Ikeja
description: Name of the location
parentID:
type: integer
example: 1
description: ID of this location parent if it has one