-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathswagger.yaml
596 lines (578 loc) · 16.4 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
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
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
openapi: 3.0.0
info:
title: Project Management Application API
description: MongoDB ExpressJS NodeJS REST API for the Project Management Application
version: 1.0.0
servers:
- url: http://localhost:3000/api/ # Local webserver location
description: Localhost Development Server
- url: https://project-management-app-api.herokuapp.com/api/ # Live webserver location
description: Live Development Server
components:
securitySchemes:
ApiKeyAuth:
type: http
scheme: bearer
in: header
name: auth-token
schemas:
Project:
type: object
properties:
title:
type: string
description:
type: string
completed:
type: boolean
columns:
type: object
properties:
col_name:
type: string
tasks:
type: object
properties:
task_name:
type: string
task_description:
type: string
task_time:
type: number
task_state:
type: string
task_priority:
type: string
users:
type: array
items:
type: object
owner:
type: array
items:
type: string
format: uuid
userRoles:
type: array
items:
type: object
properties:
role:
type: string
User:
type: object
properties:
username:
type: string
email:
type: string
password:
type: string
tags:
- name: "Access"
description: "Operations regarding Access of the Project Management Application"
externalDocs:
description: "Front-End"
url: "https://sn-project-management-app.herokuapp.com"
- name: "Project"
description: "Operations regarding Projects"
- name: "List"
description: "Operations regarding Lists (Columns)"
- name: "Task"
description: "Operations regarding Tasks"
paths:
/user/register:
post:
tags:
- "Access"
summary: Register a new User
description: Register a new User in the database
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/User"
responses:
201:
description: User created succesfully
content:
application/json:
schema:
type: object
properties:
error:
type: string
/user/login:
post:
tags:
- "Access"
summary: Login with existing User
description: Login a User in order to get JWT token (auth-token)
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
password:
type: string
responses:
200:
description: User logged in succesfully
content:
application/json:
schema:
type: object
properties:
error:
type: string
data:
type: string
/projects:
get:
tags:
- "Project"
summary: Retrieves a list of Projects created and associated to the account
description: Retrieves a list of projects as JSON objects.
security:
- ApiKeyAuth: []
responses:
200:
description: A list of projects JSON objects in an array.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Project"
post:
tags:
- "Project"
summary: Create a new Project
description: Create a new Project
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description:
type: string
owner:
type: array
items:
type: string
completed:
type: boolean
columns:
type: object
properties:
col_name:
type: string
tasks:
type: object
properties:
task_name:
type: string
task_description:
type: string
task_time:
type: number
task_state:
type: string
task_priority:
type: string
responses:
201:
description: Project created succesfully
content:
application/json:
schema:
$ref: "#/components/schemas/Project"
/projects/{id}:
get:
tags:
- "Project"
summary: GET Specific Project
description: Retrieve a specific Project based on its ID.
security:
- ApiKeyAuth: []
parameters:
- in: path
name: id
required: true
description: MongoDB Project ObjectId
schema:
type: string
- in: query
name: userId
required: true
schema:
type: string
description: User that exists in the project or the project owner.
responses:
200:
description: A Project in the format of a JSON object.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Project"
put:
tags:
- "Project"
summary: Updates a specific Project
description: Updates a specific Project based on its ID.
security:
- ApiKeyAuth: []
parameters:
- in: path
name: id
required: true
description: MongoDB Project ObjectId
schema:
type: string
- in: query
name: userId
required: true
description: User that exists in the project or the project owner.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Project"
responses:
201:
description: Project updated succesfully
content:
application/json:
schema:
$ref: "#/components/schemas/Project"
delete:
tags:
- "Project"
summary: Deletes a specific Project
description: Deletes a specific Project based on its ObjectId.
security:
- ApiKeyAuth: []
parameters:
- in: path
name: id
required: true
description: MongoDB Project ObjectId
schema:
type: string
- in: query
name: userId
description: User that exists in the project or the project owner.
required: true
schema:
type: string
responses:
201:
description: Project deleted succesfully
content:
application/json:
schema:
$ref: "#/components/schemas/Project"
/projects/:
delete:
tags:
- "Project"
summary: Delete ALL PROJECTS from DB - DEPRECATED -
description: Delete ALL PROJECTS from DB. Deprecated and deemed unnceccessary to have it.
security:
- ApiKeyAuth: []
responses:
200:
description: A Project in the format of a JSON object.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Project"
security:
deprecated: true
/projects/completed:
get:
tags:
- "Project"
summary: GET PROJECTS from DB that are completed - DEPRECATED -
description: GET PROJECTS from DB are completed. Deprecated and deemed unnceccessary to have it.
security:
- ApiKeyAuth: []
responses:
200:
description: A Project in the format of a JSON object.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Project"
security:
deprecated: true
/projects/addcolumn/{id}:
put:
tags:
- "List"
summary: Add New LIST by Project ID
description: Add New LIST by Project ID
security:
- ApiKeyAuth: []
parameters:
- in: path
name: id
required: true
description: MongoDB Project ObjectId
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
col_name:
type: string
userId:
type: string
responses:
200:
description: A Project in the format of a JSON object.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Project"
/projects/editcolumn/{id}:
put:
tags:
- "List"
summary: EDIT LIST by Column ID
description: EDIT LIST by Column ID
security:
- ApiKeyAuth: []
parameters:
- in: path
name: id
required: true
description: MongoDB Column ObjectId
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
col_name:
type: string
responses:
200:
description: A Project in the format of a JSON object.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Project"
/projects/deletecolumn/{id}:
put:
tags:
- "List"
summary: Delete Specific card LIST in Project
description: Delete Specific card LIST in Project by Column ID.
security:
- ApiKeyAuth: []
parameters:
- in: path
name: id
required: true
description: MongoDB LIST ObjectId
schema:
type: string
- in: query
name: user
required: true
description: User that exists in the project or the project owner.
schema:
type: string
- in: query
name: project
required: true
description: Project ID.
schema:
type: string
responses:
200:
description: A Project in the format of a JSON object.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Project"
/projects/addtask/{id}:
put:
tags:
- "Task"
summary: Add New Task inside List by ID
description: Add New Task into LIST in Project by Column ID.
security:
- ApiKeyAuth: []
parameters:
- in: path
name: id
required: true
description: MongoDB columns ObjectId
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
task_name:
type: string
task_description:
type: string
responses:
200:
description: A Project in the format of a JSON object.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Project"
/projects/updatetask-quick-edit/{id}:
put:
tags:
- "Task"
summary: Update TASK by ID
description: Update Task by TASK ID.
security:
- ApiKeyAuth: []
parameters:
- in: path
name: id
required: true
description: MongoDB Task ObjectId
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
task_name:
type: string
task_description:
type: string
responses:
200:
description: A Project in the format of a JSON object.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Project"
/projects/movetask/{id}/{id2}:
put:
tags:
- "Task"
summary: Move Task to a different Column
description: Move Task to a different Column - Works fine on Front-End, doesn't fully work as intented with swagger only.
security:
- ApiKeyAuth: []
parameters:
- in: path
name: id
required: true
description: MongoDB Task ObjectId
schema:
type: string
- in: path
name: id2
required: true
description: MongoDB Column ObjectId
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
userId:
type: string
projectId:
type: string
tasks:
type: array
items:
type: object
properties:
task_name:
type: string
task_description:
type: string
responses:
200:
description: A Project in the format of a JSON object.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Project"
security:
deprecated: true
/projects/deletetask/{id}:
put:
tags:
- "Task"
summary: Delete Specific TASK inside LIST in Project
description: Delete Specific TASK inside LIST in Project by TASK ID.
security:
- ApiKeyAuth: []
parameters:
- in: path
name: id
required: true
description: MongoDB TASK ObjectId
schema:
type: string
responses:
200:
description: A Project in the format of a JSON object.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Project"