-
Notifications
You must be signed in to change notification settings - Fork 1
Description of end points
Description: Authenticates the user
Method: POST
Input parameters: email, password
Output Session key which is used to sign the other requests
Description: New user creation.
Method: POST
Input parameters: firstname, lastname, email, username, password, password_confirmation. Username and email needs to be unique.
Output: Message "User created."
Description: Update of user info except password.
Method: PUT
Input parameters: id, firstname, lastname, email, username. Username and email needs to be unique.
Output: Message "User successfully updated."
Description: Change password.
Method: PUT
Input parameters: id, old_password, password, password_confirmation
Output: Message "Password successfully changed."
Description: User can deactivate account. IS_ACTIVE field will be set on FALSE.
Method: DELETE
Input parameters: id
Output: Message "You are deactivated."
Description: Get all members on specified project.
Method: GET
Input parameters: project_id
Output: JSON representation
{
"document": {
"users": [
{
"id": ?,
"lastname": ?,
"email": ?,
"firstname": ?,
"username": ?,
"is_active": ?
}
]
},
"status": {
"message": ?,
"exception_message": ?,
"stacktrace": ?
}
}Description: Add new member on specified project.
Method: POST
Input parameters: project_id, id (user_id)
Output: Message "Member added."
Description: Search available users (not-members on specified project) by username. Client sends keyword and sever return all users whose username contains keyword.
Method: GET
Input parameters: project_id, keyword
Output: JSON representation
{
"document": {
"users": [
{
"id": ?,
"lastname": ?,
"email": ?,
"firstname": ?,
"username": ?,
"is_active": ?
}
]
},
"status": {
"message": ?,
"exception_message": ?,
"stacktrace": ?
}
}Description: Remove member from specified project.
Method: DELETE
Input parameters: project_id, id
Output: Message "Member deleted."
Description Gets the active sprint of the project with with the id :id, with the tickets and user stories associated with that sprint.
Method: GET
Input parameters: id of project
Output: Board object consisted of active sprint, tickets and user stories attached to it, grouped by ticket status ('to do', 'in progress', 'done'...)
Description: Get all dashboard data for current user. Dashboard contains all notifications (adjusted representation) and assigned projects for user.
Method: GET
Input parameters: NONE
Output: JSON representation
{
"document": {
"dashboard": {
"content": [
{
"project": ?,
"content": ?,
"url": ?
}
],
"projects": [
?
]
}
},
"status": {
"message": ?,
"exception_message": ?,
"stacktrace": ?
}
}Description: List all comment that are connected to specific ticket
Method: GET
Input parameters: ticket_id
Output: JSON representation
{
"document": {
"comments": [
{
"id": ?,
"user_id": ?,
"ticket_id": ?,
"content": ?,
"created_at": ?,
"updated_at": ?
}
]
},
"status": {
"message": ?,
"exception_message": ?,
"stacktrace": ?
}
}Description: Creates comment connected to specific user and ticket
Method: POST
Input parameters: ticket_id,user_id,content
Output: Message "Comment created."
Description: Shows specific comment
Method: GET
Input parameters: ticket_id,id
Output: JSON representation
{
"document": {
"foundedComment": {
"id":?,
"user_id":?,
"ticket_id":?,
"content":?,
"created_at":?,
"updated_at":?
}
},
"status": {
"message": "OK",
"exception_message": null,
"stacktrace": null
}
}Description: Updates comment
Method: PUT/PATCH
Input parameters: ticket_id,id
Output: Message "Comment successfully edited."
Description: Deletes comment
Method: DELETE
Input parameters: ticket_id,id
Output: Message "Comment deleted."
Description: Creates comment connected to specific user and ticket
Method: POST
Input parameters: ticket_id,user_id,content
Output: Message "Comment created."
Description: List all comments that are connected to specific user
Method: GET
Input parameters: user_id
Output: JSON representation
{
"document": {
"comments": [
{
"id": ?,
"user_id": ?,
"ticket_id": ?,
"content": ?,
"created_at": ?,
"updated_at": ?
}
]
},
"status": {
"message": ?,
"exception_message": ?,
"stacktrace": ?
}
}Description: Shows specific comment
Method: GET
Input parameters: user_id,id
Output: JSON representation
{
"document": {
"foundedComment": {
"id":?,
"user_id":?,
"ticket_id":?,
"content":?,
"created_at":?,
"updated_at":?
}
},
"status": {
"message": "OK",
"exception_message": null,
"stacktrace": null
}
}Description: Updates comment
Method: PUT/PATCH
Input parameters: user_id,id
*Output: Message "Comment successfully edited."
Description: Deletes comment
Method: DELETE
Input parameters: ticket_id,id
Output: Message "Comment deleted."
Description: Shows all sprints, user stories connected to one project
Method: GET
Input parameters: project_id
Output: JSON representation
{
"document": {
"user_stories": [
{
"id": ?,
"name": ?,
"description": ?,
"tickets": []
}
],
"sprints": [
{
"id": ?,
"name": ?,
"start_date": ?,
"end_date": ?
}
]
},
"status": {
"message": "OK",
"exception_message": null,
"stacktrace": null
}
}