Milestones

A milestone is a checkpoint within a project, numbered M1, M2 and so on. A ticket in the project can belong to one of its milestones. A project returns its milestones, so there is no separate list.

The Milestone object

A checkpoint within a project, labeled M1, M2 and so on.

Attributes

idstringRequired

Unique ID of the milestone.

numbernumberRequired

The milestone's number within its project: 2 is M2.

namestringRequired

The milestone's name.

summarynullable stringRequired

A short summary, or null.

The Milestone object

{  "id": "Ms2SrC9vLm4D",  "number": 2,  "name": "Search",  "summary": "Readers find any page from the docs header."}

Create a milestone

POST/v1/workspaces/{slug}/projects/{project}/milestones

Adds a milestone numbered one past the project's highest, such as M3 after M2. Viewers cannot add milestones, and an archived project takes none.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

projectstringRequired

The project's slug, such as docs-launch.

Body parameters

namestringRequired

The milestone's name, up to 100 characters.

summarynullable string

A short summary, up to 280 characters.

Returns

Returns the Milestone object. Status 201.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

POST/v1/workspaces/{slug}/projects/{project}/milestones

1curl -X POST https://api.qa.clankership.net/v1/workspaces/acme/projects/{project}/milestones \2  -H "Authorization: Bearer $CLANKER_API_KEY" \3  -H "Content-Type: application/json" \4  -d '{5    "name": "Search",6    "summary": "Readers find any page from the docs header."7  }'

Response201

{  "id": "Ms2SrC9vLm4D",  "number": 2,  "name": "Search",  "summary": "Readers find any page from the docs header."}

Update a milestone

PATCH/v1/workspaces/{slug}/projects/{project}/milestones/{milestone}

Changes only the fields sent. Viewers cannot change milestones, and an archived project's milestones take no changes.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

projectstringRequired

The project's slug, such as docs-launch.

milestonestringRequired

The milestone's label or number within the project, such as M2 or 2.

Body parameters

namestring

The milestone's name, up to 100 characters.

summarynullable string

A short summary, up to 280 characters. null clears it.

Returns

Returns the Milestone object. Status 200.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

PATCH/v1/workspaces/{slug}/projects/{project}/milestones/{milestone}

1curl -X PATCH https://api.qa.clankership.net/v1/workspaces/acme/projects/{project}/milestones/{milestone} \2  -H "Authorization: Bearer $CLANKER_API_KEY" \3  -H "Content-Type: application/json" \4  -d '{5    "name": "Search and filters"6  }'

Response200

{  "id": "Ms2SrC9vLm4D",  "number": 2,  "name": "Search",  "summary": "Readers find any page from the docs header."}

Delete a milestone

DELETE/v1/workspaces/{slug}/projects/{project}/milestones/{milestone}

Deletes the milestone and takes it off its tickets, which stay in the project. Viewers cannot delete milestones, and an archived project keeps its milestones.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

projectstringRequired

The project's slug, such as docs-launch.

milestonestringRequired

The milestone's label or number within the project, such as M2 or 2.

Returns

Returns no content. Status 204.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

DELETE/v1/workspaces/{slug}/projects/{project}/milestones/{milestone}

1curl -X DELETE https://api.qa.clankership.net/v1/workspaces/acme/projects/{project}/milestones/{milestone} \2  -H "Authorization: Bearer $CLANKER_API_KEY"

NextTickets