-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathApis.http
More file actions
489 lines (387 loc) · 17.2 KB
/
Apis.http
File metadata and controls
489 lines (387 loc) · 17.2 KB
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
@Flowboard_Project_Management_System_Backend_HostAddress = http://localhost:5158
### ===============================
### Public - Auth - Done
### ===============================
### Auth - Register
# @name register
POST {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/auth/register
Content-Type: application/json
{
"userName": "username",
"firstName": "First name",
"middleName": "A",
"lastName": "Last",
"ContactNumber": "+639123456789",
"birthDate": "2000-01-01T00:00:00Z",
"userIMG": null,
"email": "exampleemail@gmail.com",
"password": "yourSecuredPassw0rd01!"
}
### Auth - Login
# @name login
POST {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/auth/login
Content-Type: application/json
{
"UserNameOrEmail": "username",
"password": "yourSecuredPassw0rd01!"
}
### ===============================
### Users
### ===============================
### Users - Get by ID (Protected)
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/users/{{login.response.body.user.id}}
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### Users - Update (Replace) - UPDATE - Works
PATCH {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/users/{{login.response.body.user.id}}
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"middleName": "Q"
}
### Patch - Update Password (server must hash before save) - Works
PATCH {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/users/{{login.response.body.user.id}}
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"password": "Gumanakaya"
}
### ===============================
### Projects
### ===============================
### Projects - Create (Protected) - Works
# @name createProject
POST {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/projects
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"projectName": "bacla AYOSYIN molang",
"description": "Project AHAAHAHAH HATDOGGG"
}
### Projects - Get My Projects (Protected) - READ - Works
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/projects/{{login.response.body.user.id}}
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### Projects - Get by ID (Protected) - Works
# @name getProject
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/projects/6919d3b0a66df6db05f2567b
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### Projects - Get All Members (Protected) - Works
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/projects/{{createProject.response.body.id}}/members
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### Projects - Update (Protected) - Works
PATCH {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/projects/6919d3b0a66df6db05f2567b
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"projectName": "Updated Project",
"description": "Updated description"
}
### Projects - Add Members (Protected) - Works
POST {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/projects/{{createProject.response.body.id}}/member
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"teamMembers": [
"69199c6dce4510fd09b4a0eb"
]
}
### Projects - Add Multiple Members and Permissions (Protected)
POST {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/projects/{{createProject.response.body.id}}/member
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"teamMembers": [
"691989a863538927dd65315c",
"690d04b90943671dbf22f65e"
],
"permissions": {
"691989a863538927dd65315c": "Editor",
"690d04b90943671dbf22f65e": "Team Member"
}
}
### Projects - Remove Single Member (Protected) - Work
DELETE {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/projects/{{createProject.response.body.id}}/member
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"teamMembers": "69183014ce4510fd09b4a0e0"
}
### Projects - Delete (Protected)
DELETE {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/projects/6919c7caba3bf16fa679bc92
Authorization: Bearer {{login.response.body.token}}
### Projects - Leave Project (Protected) - Self removal
DELETE {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/projects/{{createProject.response.body.id}}/leave
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
### ===============================
### Categories (Per-Project) - Create/Read/Update/Delete
### ===============================
### Categories - Create (Protected) - CREATE - Working
# @name createCategory
POST {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/categories
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"projectId": "{{createProject.response.body.id}}",
"categoryName": "HATDOG"
}
### Categories - Get All From a Project (Protected) - READ - Working
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/categories?projectId={{createProject.response.body.id}}
Authorization: Bearer {{login.response.body.token}}
### Categories - Get By ID (Protected) - READ - Working
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/categories/{{createCategory.response.body.id}}
Authorization: Bearer {{login.response.body.token}}
### Categories - Update (Protected) - UPDATE - Working
PUT {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/categories/{{createCategory.response.body.id}}
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"categoryName": "Updated Category Name"
}
### Categories - Delete (Protected) - DELETE - Working
DELETE {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/categories/{{createCategory.response.body.id}}
Authorization: Bearer {{login.response.body.token}}
### ===============================
### MainTasks (Containers with Title and Description)
### ===============================
### MainTask - Create (Protected)
# @name createMainTask
POST {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/maintasks
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"title": "Sprint 1000 Tasks",
"description": "All tasks for the first sprint",
"subTaskId":"{{createSubTask.response.body.id}}"
}
### MainTask - Get All (Protected)
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/maintasks
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### MainTask - Get by ID (Protected)
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/maintasks/{{createMainTask.response.body.id}}
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### MainTask - Get SubTasks for MainTask (Protected)
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/maintasks/{{createMainTask.response.body.id}}/subtasks
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### MainTask - Delete (Protected)
DELETE {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/maintasks/{{createMainTask.response.body.id}}
Authorization: Bearer {{login.response.body.token}}
### ===============================
### SubTasks - Detailed breakdown of MainTasks (Create/Edit/Update/Delete)
### SubTask is a child entity that provides more detailed explanation for a parent MainTask
### ===============================
### SubTask - Create (Protected) - DetailedTaskCreate Policy
### SubTask belongs to a MainTask via MainTaskId field
# @name createSubTask
POST {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/subtasks
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"title": "design mo yung KENINI pubmat",
"description": "Create comprehensive database schema",
"priority": "Critical",
"mainTaskId": "{{createMainTask.response.body.id}}",
"projectId": "{{createProject.response.body.id}}",
"categoryId": "{{createCategory.response.body.id}}",
"assignedTo": ["{{login.response.body.user.id}}"],
"createdBy": "{{login.response.body.user.id}}",
"startDate": "2025-12-08T00:00:00Z",
"endDate": "2025-12-15T23:59:59Z"
}
### SubTask - Get All SubTasks
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/subtasks
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### SubTask - Get All SubTasks for a Project
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/subtasks?projectId={{createProject.response.body.id}}
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### SubTask - Get by ID (Protected)
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/subtasks/{{createSubTask.response.body.id}}
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### SubTask - Get current user's SubTasks
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/subtasks/me
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### SubTask - Get SubTasks for specific user
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/subtasks/user/{{login.response.body.user.id}}
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### SubTask - Edit (PATCH, Protected) - DetailedTaskEdit Policy
PATCH {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/subtasks/{{createSubTask.response.body.id}}
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"priority": "Important"
}
### SubTask - Update (PUT, Protected) - DetailedTaskUpdate Policy
PUT {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/subtasks/{{createSubTask.response.body.id}}
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"title": "Design Database Schema - Updated",
"description": "Updated database schema",
"priority": "High",
"mainTaskId": "{{createMainTask.response.body.id}}",
"projectId": "{{createProject.response.body.id}}",
"categoryId": "{{createCategory.response.body.id}}",
"assignedTo": ["{{login.response.body.user.id}}"],
"createdBy": "{{login.response.body.user.id}}",
"startDate": "2025-12-08T00:00:00Z",
"endDate": "2025-12-20T23:59:59Z"
}
### SubTask - Delete (Protected) - DetailedTaskDelete Policy
DELETE {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/subtasks/{{createSubTask.response.body.id}}
Authorization: Bearer {{login.response.body.token}}
### SubTask - Add Comment (Protected)
POST {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/subtasks/{{createSubTask.response.body.id}}/comments
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"authorId": "{{login.response.body.user.id}}",
"text": "Good progress on the task"
}
# TODO FOR NEXT
### ===============================
### Notifications - Create/Read/Update/Delete
### ===============================
### Notifications: proposed controller (currently not implemented)
### - Endpoints: POST /api/notifications, GET /api/notifications?isRead=false, GET /api/notifications/{id}, PATCH /api/notifications/{id}, DELETE /api/notifications/{id}
### - Model: `FlowboardModel.Notification` (UserId, Message, IsRead, CreatedAt)
### Notifications - Create (Protected) - CREATE
POST {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/notifications
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"userId": "{{login.response.body.user.id}}",
"message": "A new task was assigned to you",
"isRead": false
}
### Notifications - Get All For Current User (Protected) - READ
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/notifications
Authorization: Bearer {{login.response.body.token}}
### Notifications - Get Unread (Protected) - READ
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/notifications?isRead=false
Authorization: Bearer {{login.response.body.token}}
### Notifications - Get By ID (Protected) - READ
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/notifications/{{notificationId}}
Authorization: Bearer {{login.response.body.token}}
### Notifications - Update (Mark Read/Unread) - UPDATE
PATCH {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/notifications/{{notificationId}}
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"isRead": true
}
### Notifications - Delete (Protected) - DELETE
DELETE {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/notifications/{{notificationId}}
Authorization: Bearer {{login.response.body.token}}
### ===============================
### Permissions - Create/Read/Update/Delete
### ===============================
### Permissions: project-level and optional permission collection
### - `Project.Permissions` exists; optionally add a separate `Permissions` controller for permission management per project (POST/GET/PATCH/DELETE).
### Permissions - Create (Assign a role to user in project) - CREATE
POST {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/permissions
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"userId": "690d04b90943671dbf22f65e",
"projectId": "{{createProject.response.body.id}}",
"role": "Team Member",
"privileges": { "Create": false, "Read": true, "Update": true, "Delete": false }
}
### Permissions - Get by Project / User - READ
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/permissions?projectId={{createProject.response.body.id}}
Authorization: Bearer {{login.response.body.token}}
### Permissions - Get by ID (Protected) - READ
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/permissions/{{permissionId}}
Authorization: Bearer {{login.response.body.token}}
### Permissions - Update (Protected) - UPDATE
PATCH {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/permissions/{{permissionId}}
Content-Type: application/json
Authorization: Bearer {{login.response.body.token}}
{
"role": "Editor",
"privileges": { "Create": true, "Read": true, "Update": true, "Delete": false }
}
### Permissions - Delete (Protected) - DELETE
DELETE {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/permissions/{{permissionId}}
Authorization: Bearer {{login.response.body.token}}
### ===============================
### Analytics - Dashboard Data
### ===============================
### Analytics - Get Summary (Overall system stats)
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/analytics/summary
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### Analytics - Get Project Stats (Project-specific statistics)
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/analytics/projects/6936c1cb666fe707a30b2c08/stats
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### Analytics - Get User Overview (User assignment summary)
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/analytics/users/{{login.response.body.user.id}}/overview
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### Analytics - Get Tasks Timeline (Task creation trends, last 30 days)
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/analytics/tasks/timeline?days=30
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### Analytics - Get Top Performers (Top 5 users by task completion)
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/analytics/top-performers?limit=5
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### Analytics - Get Kanban Stats (Project board statistics)
GET {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/analytics/kanban/{{createProject.response.body.id}}
Authorization: Bearer {{login.response.body.token}}
Accept: application/json
### ===============================
### Role-Based Registration Tests
### ===============================
### Register as User (Default Role)
# @name registerUser
POST {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/auth/register
Content-Type: application/json
{
"userName": "testuser",
"firstName": "Test",
"middleName": "User",
"lastName": "Account",
"ContactNumber": "+639000000001",
"birthDate": "2000-01-01T00:00:00Z",
"userIMG": null,
"email": "testuser@example.com",
"password": "TestPassword123!",
"role": "User"
}
### Register as Client (Read-Only Role)
# @name registerClient
POST {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/auth/register
Content-Type: application/json
{
"userName": "testclient",
"firstName": "Test",
"middleName": "Client",
"lastName": "Account",
"ContactNumber": "+639000000002",
"birthDate": "2000-01-01T00:00:00Z",
"userIMG": null,
"email": "testclient@example.com",
"password": "TestPassword123!",
"role": "Client"
}
### Login as Client
# @name loginClient
POST {{Flowboard_Project_Management_System_Backend_HostAddress}}/api/auth/login
Content-Type: application/json
{
"UserNameOrEmail": "testclient",
"password": "TestPassword123!"
}