-
Notifications
You must be signed in to change notification settings - Fork 42
Swagger Markdown
Chinmay Deshmukh edited this page May 1, 2020
·
3 revisions
A brief visual description of backend API. NB. Authorization Header required for using API.
License: Swagger UI License: MIT
Get all Tasks for user
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| User | email (String) | No |
| Code | Description | Schema |
|---|---|---|
| 200 | List of tasks associated with this user | Tasks |
Create new task in system
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| body | No | Task |
| Code | Description |
|---|---|
| 200 | taskId: 'taskId', Successful: 'True' |
| 400 | taskId: 'taskId', Successful: 'False' |
Edit Task in System
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| taskId | taskId (String) | No | ||
| body | No | Task |
| Code | Description |
|---|---|
| 200 | taskId: 'taskId', Successful: 'True' |
| 400 | taskId: 'taskId', Successful: 'False' |
Delete Task in System
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| taskId | taskId (String) | No |
| Code | Description |
|---|---|
| 200 | taskId: 'taskId', Deleted: 'True' |
| 400 | taskId: 'taskId', Deleted: 'False' |
Get user details
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| email (String) | No |
| Code | Description | Schema |
|---|---|---|
| 200 | Here are all the User Details | User |
| 400 | Error: could not find user with specified email. |
Update user details
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| email (String) | No | |||
| body | No | User |
| Code | Description |
|---|---|
| 200 | email: 'email', Successful: 'True' |
| 400 | email: 'email', Successful: 'False' |
Get all users details
| Name | Located in | Description | Required | Schema |
|---|
| Code | Description | Schema |
|---|---|---|
| 200 | Here are all the Users and their Details | Users |
| 400 | msg: failed |
| Name | Type | Description | Required |
|---|---|---|---|
| string | Yes | ||
| name | string | No | |
| picture | string | No | |
| themePreference | string | No | |
| startTime | date | No | |
| endTime | date | No | |
| points | integer | No | |
| unlockedItems | array | No |
| Name | Type | Description | Required |
|---|---|---|---|
| Users | array |
| Name | Type | Description | Required |
|---|---|---|---|
| user | User | Yes | |
| taskId | string | Yes | |
| title | string | Yes | |
| description | string | No | |
| location | string | No | |
| priority | integer | No | |
| duration | integer | Yes | |
| startDate | date | Yes | |
| endDate | date | Yes | |
| reminderDate | date | No | |
| isComplete | boolean | No | |
| dueDate | date | No | |
| travelTime | integer | No | |
| reminderType | integer | No | |
| earliestDate | date | Yes | |
| category | integer | No |
| Name | Type | Description | Required |
|---|---|---|---|
| Tasks | array |