-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathAPIdocs.yaml
424 lines (405 loc) · 11 KB
/
APIdocs.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
# incomplete
swagger: "2.0"
info:
description: "This is the api Documentation for the DSC Unilag online certificate generator"
version: "1.0.0"
title: "Certificate Generator"
contact:
email: "[email protected]"
license:
name: "ISC"
host: "localhost:3000"
tags:
- name: "User Routes"
description: "All the user routes"
- name: "Dashboard"
description: "Endpoints related to serving dashboard data"
- name: "Manage"
description: "Endpoints used to manage already created certifictes"
- name: "Create Certificate"
description: "Endpoints used to create certificate templates"
schemes:
- "https"
- "http"
paths:
/register:
post:
tags:
- "User Routes"
summary: "Add a new user to the db"
description: "This endpoint is used to create a new User"
operationId: "RegisterUser"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "User object to be registered in DB"
required: true
schema:
type: object
required:
- name
- email
- password
properties:
name:
type: string
email:
type: string
password:
type: string
example:
name: Akinwande Akinboluwarin
email: [email protected]
password: password
responses:
"201":
description: "User added Successfully"
schema:
type: object
properties:
status:
type: boolean
message:
type: string
"400":
description: "Invalid input"
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: invalid or incomplete request body
"401":
description: "Invalid password or unrecognized user"
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: invalid password or unrecognized user
"409":
description: "duplicate user"
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: duplicate user
/login:
post:
tags:
- "User Routes"
summary: "Login a user"
description: "This endpoint is used to create a new User"
operationId: "LoginUser"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "User object to be registered in DB"
required: true
schema:
type: object
required:
- email
- password
properties:
email:
type: string
password:
type: string
example:
email: [email protected]
password: password
responses:
"200":
description: "User logged in Successfully"
schema:
type: object
properties:
status:
type: boolean
message:
type: string
"400":
description: "Incomplete login data"
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: "incomplete login data"
"401":
description: "Incorrect Username or password"
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: incorrect username or password
/getdashboard:
get:
tags:
- "Dashboard"
summary: "Get dashboard data"
description: "This endpoint is used to retrieve the dashboard data of a User"
operationId: "GetDashboard"
produces:
- "application/json"
responses:
"200":
description: "Successfully retrieved dashboard data"
schema:
type: object
properties:
name:
type: string
example: certificate of participation
certificateUrls:
type: array
items:
type: string
example: ["link-to-a-certificate","link-to-another-one"]
certs:
type: array
items:
type: object
"401":
description: "Unauthorized"
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
/manage/{link}/getcollectors:
get:
tags:
- "Manage"
summary: Gets the array of eligible collector objects for a certificate.
parameters:
- in: path
name: link
type: string
required: true
description: specific url identifier string for a particular certificate.
operationId: "getcollectors"
produces:
- "application/json"
responses:
"200":
description: "Successfully retrieved collectors information"
schema:
type: object
properties:
status:
type: boolean
collectors:
type: array
items:
type: object
"401":
description: "Unauthorized access"
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
"404":
description: "Certificate not found"
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
/manage/{link}/edit:
get:
tags:
- "Manage"
summary: Edit an already existing certificate.
parameters:
- in: path
name: link
type: string
required: true
description: specific url identifier string for a particular certificate.
operationId: "edit"
produces:
- "application/json"
responses:
"200":
description: "successfully retrieved certificate data"
schema:
type: object
properties:
status:
type: boolean
boundaries:
type: array
items:
type: object
"401":
description: "Unauthorized access"
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
"404":
description: "Certificate not found"
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
/manage/{link}/update:
post:
tags:
- "Manage"
summary: update certificate boundary.
operationId: "update"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: path
name: link
type: string
required: true
description: specific url identifier string for a particular certificate.
- in: "body"
name: "body"
description: "User object to be registered in DB"
required: true
schema:
type: object
required:
- boundaries
properties:
boundaries:
type: array
items:
type: object
responses:
"200":
description: "successfully updated certificate boundaries"
schema:
type: object
properties:
status:
type: boolean
message:
type: string
"401":
description: "Unauthorized access"
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
"404":
description: "Certificate not found"
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
/createcert:
post:
tags:
- "Create Certificate"
summary: create certificate boundary.
operationId: "CreateCertificate"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "User object to be registered in DB"
required: true
schema:
type: object
required:
- issuer
- name
- boundaries
properties:
issuer:
type: string
description: the email of the issuer
name:
type: string
description: the name of the certificate
boundaries:
type: array
description: the boundary array for the certificate details
items:
type: object
responses:
"200":
description: "successfully created certificate"
schema:
type: object
properties:
status:
type: boolean
message:
type: string
link:
type: string
description: this is the link which woul lead to the generation page for a particular certificate
"401":
description: "Unauthorized access"
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string