39114d259c
All the info to return codes from the API functions are available in the `README.md` file as suggested.
4.1 KiB
4.1 KiB
List issues
Get all issues created by authenticed user. This function takes pagination parameters
page and per_page to restrict the list of issues.
GET /issues
[
{
"id": 43,
"project_id": 8,
"title": "4xx/5xx pages",
"description": "",
"labels": [ ],
"milestone": null,
"assignee": null,
"author": {
"id": 1,
"username": "john_smith",
"email": "john@example.com",
"name": "John Smith",
"blocked": false,
"created_at": "2012-05-23T08:00:58Z"
},
"closed": true,
"updated_at": "2012-07-02T17:53:12Z",
"created_at": "2012-07-02T17:53:12Z"
},
{
"id": 42,
"project_id": 8,
"title": "Add user settings",
"description": "",
"labels": [
"feature"
],
"milestone": {
"id": 1,
"title": "v1.0",
"description": "",
"due_date": "2012-07-20",
"closed": false,
"updated_at": "2012-07-04T13:42:48Z",
"created_at": "2012-07-04T13:42:48Z"
},
"assignee": {
"id": 2,
"username": "jack_smith",
"email": "jack@example.com",
"name": "Jack Smith",
"blocked": false,
"created_at": "2012-05-23T08:01:01Z"
},
"author": {
"id": 1,
"username": "john_smith",
"email": "john@example.com",
"name": "John Smith",
"blocked": false,
"created_at": "2012-05-23T08:00:58Z"
},
"closed": false,
"updated_at": "2012-07-12T13:43:19Z",
"created_at": "2012-06-28T12:58:06Z"
}
]
List project issues
Get a list of project issues. This function accepts pagination parameters page and per_page
to return the list of project issues.
GET /projects/:id/issues
Parameters:
id(required) - The ID of a project
Single issue
Gets a single project issue.
GET /projects/:id/issues/:issue_id
Parameters:
id(required) - The ID of a projectissue_id(required) - The ID of a project issue
{
"id": 42,
"project_id": 8,
"title": "Add user settings",
"description": "",
"labels": [
"feature"
],
"milestone": {
"id": 1,
"title": "v1.0",
"description": "",
"due_date": "2012-07-20",
"closed": false,
"updated_at": "2012-07-04T13:42:48Z",
"created_at": "2012-07-04T13:42:48Z"
},
"assignee": {
"id": 2,
"username": "jack_smith",
"email": "jack@example.com",
"name": "Jack Smith",
"blocked": false,
"created_at": "2012-05-23T08:01:01Z"
},
"author": {
"id": 1,
"username": "john_smith",
"email": "john@example.com",
"name": "John Smith",
"blocked": false,
"created_at": "2012-05-23T08:00:58Z"
},
"closed": false,
"updated_at": "2012-07-12T13:43:19Z",
"created_at": "2012-06-28T12:58:06Z"
}
New issue
Creates a new project issue.
POST /projects/:id/issues
Parameters:
id(required) - The ID of a projecttitle(required) - The title of an issuedescription(optional) - The description of an issueassignee_id(optional) - The ID of a user to assign issuemilestone_id(optional) - The ID of a milestone to assign issuelabels(optional) - Comma-separated label names for an issue
Edit issue
Updates an existing project issue. This function is also used to mark an issue as closed.
PUT /projects/:id/issues/:issue_id
Parameters:
id(required) - The ID of a projectissue_id(required) - The ID of a project's issuetitle(optional) - The title of an issuedescription(optional) - The description of an issueassignee_id(optional) - The ID of a user to assign issuemilestone_id(optional) - The ID of a milestone to assign issuelabels(optional) - Comma-separated label names for an issueclosed(optional) - The state of an issue (0 = false, 1 = true)
Delete existing issue (Deprecated)
The function is deprecated and returns a 405 Method Not Allowed
error if called. An issue gets now closed and is done by calling PUT /projects/:id/issues/:issue_id with
parameter closed set to 1.
DELETE /projects/:id/issues/:issue_id
Parameters:
id(required) - The project IDissue_id(required) - The ID of the issue