multikanban
A simple kanban for multiple personal projects.
Request & Response Examples
API Resources
STATS
Stores and updates information about stats of the app.
| Endpoint | Description | Requires Auth |
|---|---|---|
| GET /stats | Get app stats; total number of users, kanban boards, tasks and completed tasks for the app | no |
| GET /users/:id/stats | Get stats for user :id; number of kanban boards, tasks and completed tasks | yes |
| GET /kanbans/:kanban_id/stats | Get stats for kanban :kanban_id; number of tasks and completed tasks | yes |
USERS
Stores and updates information about users of the app.
| Endpoint | Description | Requires Auth |
|---|---|---|
| POST /users | Create a user | no |
| GET /users | Get all users | no |
| GET /users/:id | Get user :id data | yes |
| PUT /users/:id | Update user's data | yes |
| DELETE /users/:id | Delete user | yes |
KANBANS
Stores and updates information about users' kanban boards.
| Endpoint | Description | Requires Auth |
|---|---|---|
| POST /users/:id/kanbans | Create a kanban for user :id | yes |
| GET /users/:id/kanbans | Get all kanbans from user :id | yes |
| GET /users/:id/kanbans/:kanban_id | Get kanban :kanban_id from user :id | yes |
| PUT /users/:id/kanbans/:kanban_id | Update kanban :kanban_id from user :id | yes |
| DELETE /users/:id/kanbans/:kanban_id | Delete kanban :kanban_id from user :id | yes |
TASKS
Stores and updates information about users' kanban board's tasks.
| Endpoint | Description | Requires Auth |
|---|---|---|
| POST /users/:id/kanbans/:kanban_id/tasks | Create a task in kanban :kanban_id of user :id | yes |
| GET /users/:id/kanbans/:kanban_id/tasks | Get all tasks from kanban :kanban_id from user :id | yes |
| GET /users/:id/kanbans/:kanban_id/tasks/:state | Get all tasks from kanban :kanban_id from user :id in state :state | yes |
| GET /users/:id/completedtasks | Get all completed tasks from user :id | yes |
| PUT /users/:id/kanbans/:kanban_id/tasks/:task_id | Update task :task_id from kanban :kanban_id from user :id | yes |
| DELETE /users/:id/kanbans/:kanban_id/tasks/:task_id | Delete task :task_id from kanban :kanban_id from user :id | yes |
TOKENS
Stores information about users' tokens.
| Endpoint | Description | Requires Auth |
|---|---|---|
| POST /tokens | Create a token of loggedIn user via Basic Auth | yes (Basic Auth) |
Endpoints
STATS
GET /stats
Get app stats; total number of users, kanban boards, tasks and completed tasks for the app
Response:
{
"numberUsers" : "12",
"numberKanbans" : "67",
"numberTasks" : "489",
"numberCompletedTasks": "274"
}
GET /users/:id/stats
Get stats for user :id; number of kanban boards, tasks and completed tasks
Requires authorization via token
Response:
{
"numberKanbans" : "6",
"numberTasks" : "86",
"numberCompletedTasks": "57"
}
GET /kanbans/:kanban_id/stats
Get stats for kanban :kanban_id; number of tasks and completed tasks
Completed tasks are the sum of the "done" and "archive" columns of the kanban board
Requires authorization via token
Response:
{
"numberTasks" : "24",
"numberCompletedTasks": "11"
}
USERS
POST /users
Create a new user.
Request:
{
"username" : "mezod",
"password" : "my_password",
"email" : "[email protected]"
}
Response:
{
"id": "1",
"nickname": "mezod",
"email": "[email protected]",
"registered": "31/08/2014",
}
GET /users
Get all users.
Response:
{
"id": "1",
"nickname": "mezod",
"email": "[email protected]",
"registered": "31/08/2014",
},
{
"id": "2",
"nickname": "cowboycoder",
"email": "[email protected]",
"registered": "31/08/2014",
},
{
"id": "3",
"nickname": "gravitysrainbow",
"email": "[email protected]",
"registered": "31/08/2014",
}
GET /users/:id
Get user :id data.
Requires authorization via token
Response:
{
"id": "1",
"nickname": "mezod",
"email": "[email protected]",
"registered": "31/08/2014",
}
PUT /users/:id
Update user :id data.
Requires authorization via token
Request:
{
"password" : "password",
"email" : "[email protected]"
}
Response:
{
"id": "1",
"nickname": "mezod",
"email": "[email protected]",
"registered": "31/08/2014",
}
DELETE /users/:id
Delete user :id.
Requires authorization via token
Response:
No Content
KANBANS
POST /users/:id/kanbans
Create a kanban for user :id
Requires authorization via token
Request:
{
"title": "Summer trip"
}
Response:
{
"user_id": "1",
"title": "Summer trip",
"position": "0"
}
GET /users/:id/kanbans
Get all kanbans from user :id
Requires authorization via token
Response:
{
"id": "1",
"user_id": "1",
"title": "Summer trip",
"slug": "summer-trip",
"dateCreated": "01/09/2014",
"lastEdited": "01/09/2014",
"position": "0",
},
{
"id": "2",
"user_id": "1",
"title": "Personal blog",
"slug": "personal-blog",
"dateCreated": "31/08/2014",
"lastEdited": "01/09/2014",
"position": "1",
},
{
"id": "3",
"user_id": "1",
"title": "Thesis",
"slug": "thesis",
"dateCreated": "31/09/2014",
"lastEdited": "01/09/2014",
"position": "2",
}
GET /users/:id/kanbans/:kanban_id
Get kanban :kanban_id from user :id
Requires authorization via token
Response:
{
"id": "3",
"user_id": "1",
"title": "Thesis",
"slug": "thesis",
"dateCreated": "31/09/2014",
"lastEdited": "01/09/2014",
"position": "2",
}
PUT /users/:id/kanbans/:kanban_id
Update kanban :kanban_id from user :id
Requires authorization via token
Request:
{
"title": "Master's Thesis",
"position": "2"
}
Response:
{
"id": "6",
"user_id": "2",
"title": "Master's Thesis",
"slug": "master-s-thesis",
"dateCreated": "2014-08-31",
"lastEdited": "2015-01-01",
"position": "2"
}
DELETE /users/:id/kanbans/:kanban_id
Delete kanban :kanban_id from user :id
Requires authorization via token
TASKS
POST /users/:id/kanbans/:kanban_id/tasks
Create a task in kanban :kanban_id of user :id
Requires authorization via token
Request:
{
"text": "Write the abstract"
}
Response:
{
"id": "12",
"user_id": "1",
"kanban_id": "3",
"text": "Write the abstract",
"dateCreated": "2015-01-07",
"dateCompleted": null,
"position": 0,
"state": "backlog"
}
GET /users/:id/kanbans/:kanban_id/tasks
Get all tasks from kanban :kanban_id from user :id
Requires authorization via token
Response:
{
"id": "1",
"user_id": "1",
"kanban_id": "3",
"text": "write the abstract",
"dateCreated": "31/08/2014",
"dateCompleted": null,
"position": "0",
"state": "backlog"
},
{
"id": "2",
"user_id": "1",
"kanban_id": "3",
"text": "meet supervisor",
"dateCreated": "31/08/2014",
"dateCompleted": null,
"position": "1",
"state": "backlog"
},
{
"id": "3",
"user_id": "1",
"kanban_id": "3",
"text": "find a topic",
"dateCreated": "31/08/2014",
"dateCompleted": "01/09/2014"
"position": "0",
"state": "done"
},
{
"id": "4",
"user_id": "1",
"kanban_id": "3",
"text": "install latex",
"dateCreated": "31/08/2014",
"dateCompleted": null,
"position": "0",
"state": "to do"
},
{
"id": "5",
"user_id": "1",
"kanban_id": "3",
"text": "book lab",
"dateCreated": "31/08/2014",
"dateCompleted": null,
"position": "0",
"state": "doing"
},
{
"id": "6",
"user_id": "1",
"kanban_id": "3",
"text": "book lab",
"dateCreated": "17/08/2014",
"dateCompleted": "24/08/2014"
"position": "0",
"state": "archive"
}
GET /users/:id/kanbans/:kanban_id/tasks/:state
Get all tasks from kanban :kanban_id from user :id in state :state
Requires authorization via token
Response:
{
"id": "1",
"user_id": "1",
"kanban_id": "3",
"text": "write the abstract",
"dateCreated": "31/08/2014",
"dateCompleted": null,
"position": "0",
"state": "backlog"
},
{
"id": "2",
"user_id": "1",
"kanban_id": "3",
"text": "meet supervisor",
"dateCreated": "31/08/2014",
"dateCompleted": null,
"position": "1",
"state": "backlog"
},
GET /users/:id/completedtasks
Get all completed tasks from user :id
Requires authorization via token
Response:
{
"id": "3",
"user_id": "1",
"kanban_id": "3",
"text": "find a topic",
"dateCreated": "31/08/2014",
"dateCompleted": "01/09/2014"
"position": "0",
"state": "done"
},
{
"id": "6",
"user_id": "1",
"kanban_id": "3",
"text": "book lab",
"dateCreated": "17/08/2014",
"dateCompleted": "24/08/2014"
"position": "0",
"state": "archive"
}
PUT /users/:id/kanbans/:kanban_id/tasks/:task_id
Update task :task_id from kanban :kanban_id from user :id
Requires authorization via token
Request:
{
"text": "write the abstract",
"position": "1",
"state": "to do"
}
Response:
{
"id": "13",
"user_id": "2",
"kanban_id": "7",
"text": "write the abstract",
"dateCreated": "2015-01-06",
"dateCompleted": "2015-01-06",
"position": "1",
"state": "to do"
}
DELETE /users/:id/kanbans/:kanban_id/tasks/:task_id
Delete task :task_id from kanban :kanban_id from user :id
Requires authorization via token
TOKENS
POST /tokens
Requires authorization via Basic Auth
Request:
{
"notes" : "token for the meezod"
}
Response:
TO DO
ERRORS
400 validation_error
There was a validation error.
400 invalid_body_format
Invalid JSON format sent.
401 authentication_error
Invalid or missing authentication
404 not_found
Resource not found.
409 already_exists
Resource already exists.
409 email_already_exists
Email already exists.
UML Class Diagram (SQL)
Milestones
- POST, GET, PUT, DELETE, PATCH
- Controllers
- Services
- Interfaces
- Providers
- Listeners
- Behat
- Exception handling
- DBAL Annotations
DISCARDED
MongoDB Document Structure Example
{
numberUsers: "1",
numberKanbans: "2",
numberTasks: "123",
numberCompletedTasks: "43",
users: [
{
id: "1",
nickname: "mezod",
email: "[email protected]",
password: "my_password",
registered: "31/08/2014",
numberKanbans: "2",
numberTasks: "123",
numberCompletedTasks: "43",
kanbans: [
{
id: "1",
title: "Summer trip",
dateCreated: "31/08/2014",
lastEdited: "01/09/2014",
position: "1",
numberTasks: "32",
numberCompletedTasks: "12",
tasks: [
{
text: "book flight",
dateCreated: "31/08/2014",
dateCompleted: "31/08/2014",
position: "1",
column: "done"
}
]
},
{
id: "2",
title: "personal blog",
dateCreated: "31/08/2014",
lastEdited: "31/08/2014",
position: "2",
numberTasks: "56",
numberCompletedTasks: "43",
tasks: [
{
text: "write weekly post",
dateCreated: "31/08/2014",
dateCompleted: "",
position: "1",
column: "to do"
}
]
}
]
},
]
}