summaryrefslogtreecommitdiff
path: root/doc/api/issues.md
diff options
context:
space:
mode:
authorRiyad Preukschas <riyad@informatik.uni-bremen.de>2012-12-23 01:03:57 +0100
committerRiyad Preukschas <riyad@informatik.uni-bremen.de>2012-12-23 01:03:57 +0100
commitdb2c15369c365340aeaf4e431e8838714b40396b (patch)
tree26ca045a337132370b67cc8f2ed4010e3087dfa5 /doc/api/issues.md
parentb47173da6a0fea0982d009f91e2c4d042f9b5c37 (diff)
parent68c43d59f09a66cca0da1b9a50c11421d52eac9a (diff)
downloadgitlab-ce-db2c15369c365340aeaf4e431e8838714b40396b.tar.gz
Merge branch 'master' into discussions
Conflicts: app/assets/stylesheets/main.scss app/models/project.rb app/views/notes/_common_form.html.haml app/views/notes/_per_line_form.html.haml lib/gitlab/markdown.rb spec/models/note_spec.rb
Diffstat (limited to 'doc/api/issues.md')
-rw-r--r--doc/api/issues.md27
1 files changed, 9 insertions, 18 deletions
diff --git a/doc/api/issues.md b/doc/api/issues.md
index aaad3305489..0383b676073 100644
--- a/doc/api/issues.md
+++ b/doc/api/issues.md
@@ -18,6 +18,7 @@ GET /issues
"assignee": null,
"author": {
"id": 1,
+ "username": "john_smith",
"email": "john@example.com",
"name": "John Smith",
"blocked": false,
@@ -46,6 +47,7 @@ GET /issues
},
"assignee": {
"id": 2,
+ "username": "jack_smith",
"email": "jack@example.com",
"name": "Jack Smith",
"blocked": false,
@@ -53,6 +55,7 @@ GET /issues
},
"author": {
"id": 1,
+ "username": "john_smith",
"email": "john@example.com",
"name": "John Smith",
"blocked": false,
@@ -75,7 +78,7 @@ GET /projects/:id/issues
Parameters:
-+ `id` (required) - The ID or code name of a project
++ `id` (required) - The ID of a project
## Single issue
@@ -87,7 +90,7 @@ GET /projects/:id/issues/:issue_id
Parameters:
-+ `id` (required) - The ID or code name of a project
++ `id` (required) - The ID of a project
+ `issue_id` (required) - The ID of a project issue
```json
@@ -110,6 +113,7 @@ Parameters:
},
"assignee": {
"id": 2,
+ "username": "jack_smith",
"email": "jack@example.com",
"name": "Jack Smith",
"blocked": false,
@@ -117,6 +121,7 @@ Parameters:
},
"author": {
"id": 1,
+ "username": "john_smith",
"email": "john@example.com",
"name": "John Smith",
"blocked": false,
@@ -138,7 +143,7 @@ POST /projects/:id/issues
Parameters:
-+ `id` (required) - The ID or code name of a project
++ `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
@@ -157,7 +162,7 @@ PUT /projects/:id/issues/:issue_id
Parameters:
-+ `id` (required) - The ID or code name of a project
++ `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
@@ -168,17 +173,3 @@ Parameters:
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 ID or code name of a project
-+ `issue_id` (required) - The ID of a project's issue
-
-Status code `200` will be returned on success.