Merge pull request #1135 from NARKOZ/api

Issues API

2 files changed, 182 insertions, 0 deletions

diff --git a/doc/api/README.md b/doc/api/README.md
index dcf75afda1f..e01119661f0 100644
--- a/doc/api/README.md
+++ b/doc/api/README.md
@@ -27,3 +27,4 @@ The API uses JSON to serialize data. You don't need to specify `.json` at the en
 
 + [Users](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/users.md)
 + [Projects](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/projects.md)
++ [Issues](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/issues.md)
diff --git a/doc/api/issues.md b/doc/api/issues.md
new file mode 100644
index 00000000000..bad2d474020
--- /dev/null
+++ b/doc/api/issues.md
@@ -0,0 +1,181 @@
+## List issues
+
+Get all issues created by authenticed user.
+
+```
+GET /issues
+```
+
+```json
+[
+  {
+    "id": 43,
+    "title": "4xx/5xx pages",
+    "description": "",
+    "labels": [ ],
+    "milestone": null,
+    "assignee": null,
+    "author": {
+      "id": 1,
+      "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,
+    "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,
+      "email": "jack@example.com",
+      "name": "Jack Smith",
+      "blocked": false,
+      "created_at": "2012-05-23T08:01:01Z"
+    },
+    "author": {
+      "id": 1,
+      "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.
+
+```
+GET /projects/:id/issues
+```
+
+Parameters:
+
++ `id` (required) - The code name of a project
+
+## Single issue
+
+Get a project issue.
+
+```
+GET /projects/:id/issues/:issue_id
+```
+
+Parameters:
+
++ `id` (required) - The code name of a project
++ `issue_id` (required) - The ID of a project issue
+
+```json
+{
+  "id": 42,
+  "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,
+    "email": "jack@example.com",
+    "name": "Jack Smith",
+    "blocked": false,
+    "created_at": "2012-05-23T08:01:01Z"
+  },
+  "author": {
+    "id": 1,
+    "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
+
+Create a new project issue.
+
+```
+POST /projects/:id/issues
+```
+
+Parameters:
+
++ `id` (required) - The code name 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
+
+Will return created issue with status `201 Created` on success, or `404 Not found` on fail.
+
+## Edit issue
+
+Update an existing project issue.
+
+```
+PUT /projects/:id/issues/:issue_id
+```
+
+Parameters:
+
++ `id` (required) - The code name 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
++ `closed` (optional) - The state of an issue (0 = false, 1 = true)
+
+Will return updated issue with status `200 OK` on success, or `404 Not found` on fail.
+
+## Delete issue
+
+Delete existing project issue.
+
+```
+DELETE /projects/:id/issues/:issue_id
+```
+
+Parameters:
+
++ `id` (required) - The code name of a project
++ `issue_id` (required) - The ID of a project's issue
+
+Status code `200` will be returned on success.