-
Notifications
You must be signed in to change notification settings - Fork 1
/
Swagger_V3.0.0_API.yaml
454 lines (454 loc) · 10.6 KB
/
Swagger_V3.0.0_API.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
openapi: 3.0.0
info:
title: Express JS + Sequelize API Demo
description: >-
Node Js project template in typescript using Express framework, JSON Web
token authentication and Sequelize ORM
contact:
email: [email protected]
version: '1.0'
servers:
- url: 'http://localhost:3000/api/v1'
paths:
/system/init:
post:
tags:
- Express-backbone
summary: initiliaze system database
description: 'Seeds the database with initial permissions, roles and user accounts'
operationId: initiliazesystemdatabase
parameters:
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/session/login/:
post:
tags:
- Express-backbone
summary: login
description: Authenticate a user account. Returns an access token valid for 1hr
operationId: login
parameters:
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/loginRequest'
example:
username: james
password: password
required: true
x-send-file-in-body: false
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/permissions:
get:
tags:
- Express-backbone
summary: fetch permissions
description: Fetch all available permissions from the system database
operationId: fetchpermissions
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/permissions/1:
get:
tags:
- Express-backbone
summary: fetch permission
description: Fetch individual permission using the ID
operationId: fetchpermission
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/roles:
get:
tags:
- Express-backbone
summary: fetch roles
description: Fetch all existing roles for the users
operationId: fetchroles
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
post:
tags:
- Express-backbone
summary: create role
description: Create a new user role
operationId: createrole
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/createroleRequest'
example:
permissions:
- 1
- 2
name: demo
description: a role here
required: true
x-send-file-in-body: false
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/roles/1:
get:
tags:
- Express-backbone
summary: fetch role
description: Fetch role using ID
operationId: fetchrole
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/roles/3:
patch:
tags:
- Express-backbone
summary: update role
description: Update role details
operationId: updaterole
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/updateroleRequest'
example:
permissions:
- 3
name: demo
description: this is to be renamed
required: true
x-send-file-in-body: false
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
delete:
tags:
- Express-backbone
summary: delete role
description: Delete user role by ID
operationId: deleterole
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/users:
get:
tags:
- Express-backbone
summary: fetch users
description: Fetch all user account details
operationId: fetchusers
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
post:
tags:
- Express-backbone
summary: create user
description: create a new user account record and their authentication info
operationId: createuser
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/createuserRequest'
example:
first_name: James
last_name: Jowie
role: 1
username: [email protected]
email: [email protected]
password: [email protected]
required: true
x-send-file-in-body: false
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/users/1:
get:
tags:
- Express-backbone
summary: fetch user
description: Fetch specific user account details by ID
operationId: fetchuser
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/users/2:
patch:
tags:
- Express-backbone
summary: update user
description: Update user account info by ID (authentication info not updated)
operationId: updateuser
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/updateuserRequest'
example:
firstname: Kabaka
lastname: M
role: 2
email: [email protected]
required: true
x-send-file-in-body: false
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
delete:
tags:
- Express-backbone
summary: delete user
description: Delete user account by ID ~ replaces user specific data with dummy data
operationId: deleteuser
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
components:
schemas:
loginRequest:
title: loginRequest
required:
- username
- password
type: object
properties:
username:
type: string
password:
type: string
example:
username: james
password: password
createroleRequest:
title: createroleRequest
required:
- permissions
- name
- description
type: object
properties:
permissions:
type: array
items:
type: integer
format: int32
description: ''
name:
type: string
description:
type: string
example:
permissions:
- 1
- 2
name: demo
description: a role here
updateroleRequest:
title: updateroleRequest
required:
- permissions
- name
- description
type: object
properties:
permissions:
type: array
items:
type: integer
format: int32
description: ''
name:
type: string
description:
type: string
example:
permissions:
- 3
name: demo
description: this is to be renamed
createuserRequest:
title: createuserRequest
required:
- first_name
- last_name
- role
- username
- email
- password
type: object
properties:
first_name:
type: string
last_name:
type: string
role:
type: integer
format: int32
username:
type: string
email:
type: string
password:
type: string
example:
first_name: James
last_name: Jowie
role: 1
username: [email protected]
email: [email protected]
password: [email protected]
updateuserRequest:
title: updateuserRequest
required:
- firstname
- lastname
- role
- email
type: object
properties:
firstname:
type: string
lastname:
type: string
role:
type: integer
format: int32
email:
type: string
example:
firstname: Kabaka
lastname: M
role: 2
email: [email protected]
securitySchemes:
httpBearer:
type: http
scheme: bearer
security:
- httpBearer: []
tags:
- name: Express-backbone
description: ''