diff options
Diffstat (limited to 'doc/api/issues.md')
| -rw-r--r-- | doc/api/issues.md | 224 |
1 files changed, 0 insertions, 224 deletions
diff --git a/doc/api/issues.md b/doc/api/issues.md deleted file mode 100644 index a7dd8b74c35..00000000000 --- a/doc/api/issues.md +++ /dev/null @@ -1,224 +0,0 @@ -# Issues - -## List issues - -Get all issues created by authenticated user. This function takes pagination parameters -`page` and `per_page` to restrict the list of issues. - -``` -GET /issues -GET /issues?state=opened -GET /issues?state=closed -GET /issues?labels=foo -GET /issues?labels=foo,bar -GET /issues?labels=foo,bar&state=opened -``` - -Parameters: - -- `state` (optional) - Return `all` issues or just those that are `opened` or `closed` -- `labels` (optional) - Comma-separated list of label names -- `order_by` (optional) - Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at` -- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc` - -```json -[ - { - "id": 43, - "iid": 3, - "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", - "state": "active", - "created_at": "2012-05-23T08:00:58Z" - }, - "state": "closed", - "updated_at": "2012-07-02T17:53:12Z", - "created_at": "2012-07-02T17:53:12Z" - }, - { - "id": 42, - "iid": 4, - "project_id": 8, - "title": "Add user settings", - "description": "", - "labels": [ - "feature" - ], - "milestone": { - "id": 1, - "title": "v1.0", - "description": "", - "due_date": "2012-07-20", - "state": "reopened", - "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", - "state": "active", - "created_at": "2012-05-23T08:01:01Z" - }, - "author": { - "id": 1, - "username": "john_smith", - "email": "john@example.com", - "name": "John Smith", - "state": "active", - "created_at": "2012-05-23T08:00:58Z" - }, - "state": "opened", - "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 -GET /projects/:id/issues?state=opened -GET /projects/:id/issues?state=closed -GET /projects/:id/issues?labels=foo -GET /projects/:id/issues?labels=foo,bar -GET /projects/:id/issues?labels=foo,bar&state=opened -GET /projects/:id/issues?milestone=1.0.0 -GET /projects/:id/issues?milestone=1.0.0&state=opened -``` - -Parameters: - -- `id` (required) - The ID of a project -- `state` (optional) - Return `all` issues or just those that are `opened` or `closed` -- `labels` (optional) - Comma-separated list of label names -- `milestone` (optional) - Milestone title -- `order_by` (optional) - Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at` -- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc` - -## Single issue - -Gets a single project issue. - -``` -GET /projects/:id/issues/:issue_id -``` - -Parameters: - -- `id` (required) - The ID of a project -- `issue_id` (required) - The ID of a project issue - -```json -{ - "id": 42, - "iid": 3, - "project_id": 8, - "title": "Add user settings", - "description": "", - "labels": [ - "feature" - ], - "milestone": { - "id": 1, - "title": "v1.0", - "description": "", - "due_date": "2012-07-20", - "state": "closed", - "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", - "state": "active", - "created_at": "2012-05-23T08:01:01Z" - }, - "author": { - "id": 1, - "username": "john_smith", - "email": "john@example.com", - "name": "John Smith", - "state": "active", - "created_at": "2012-05-23T08:00:58Z" - }, - "state": "opened", - "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 project -- `title` (required) - The title of an issue -- `description` (optional) - The description of an issue -- `assignee_id` (optional) - The ID of a user to assign issue -- `milestone_id` (optional) - The ID of a milestone to assign issue -- `labels` (optional) - Comma-separated label names for an issue - -If the operation is successful, 200 and the newly created issue is returned. -If an error occurs, an error number and a message explaining the reason is returned. - -## 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 project -- `issue_id` (required) - The ID of a project's issue -- `title` (optional) - The title of an issue -- `description` (optional) - The description of an issue -- `assignee_id` (optional) - The ID of a user to assign issue -- `milestone_id` (optional) - The ID of a milestone to assign issue -- `labels` (optional) - Comma-separated label names for an issue -- `state_event` (optional) - The state event of an issue ('close' to close issue and 'reopen' to reopen it) - -If the operation is successful, 200 and the updated issue is returned. -If an error occurs, an error number and a message explaining the reason is returned. - -## 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 `state_event` set to `close`. - -``` -DELETE /projects/:id/issues/:issue_id -``` - -Parameters: - -- `id` (required) - The project ID -- `issue_id` (required) - The ID of the issue - -## Comments on issues - -Comments are done via the notes resource. |