4a60c377b8
Updated the milestones API documentation and added return codes descriptions.
1.8 KiB
1.8 KiB
List project milestones
Returns a list of project milestones.
GET /projects/:id/milestones
Parameters:
id
(required) - The ID of a project
Return values:
200 Ok
on success and the list of project milestones401 Unauthorized
if user is not authenticated404 Not Found
if project ID not found
Get single milestone
Gets a single project milestone.
GET /projects/:id/milestones/:milestone_id
Parameters:
id
(required) - The ID of a projectmilestone_id
(required) - The ID of a project milestone
Return values:
200 Ok
on success and the single milestone401 Unauthorized
if user is not authenticated404 Not Found
if project ID not found
Create new milestone
Creates a new project milestone.
POST /projects/:id/milestones
Parameters:
id
(required) - The ID of a projecttitle
(required) - The title of an milestonedescription
(optional) - The description of the milestonedue_date
(optional) - The due date of the milestone
Return values:
201 Created
on success and the new milestone400 Bad Request
if the required attribute title is not given401 Unauthorized
if user is not authenticated404 Not Found
if project ID not found
Edit milestone
Updates an existing project milestone.
PUT /projects/:id/milestones/:milestone_id
Parameters:
id
(required) - The ID of a projectmilestone_id
(required) - The ID of a project milestonetitle
(optional) - The title of a milestonedescription
(optional) - The description of a milestonedue_date
(optional) - The due date of the milestoneclosed
(optional) - The status of the milestone
Return values:
200 Ok
on success and the updated milestone401 Unauthorized
if user is not authenticated404 Not Found
if project ID or milestone ID not found