summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorZeger-Jan van de Weg <zegerjan@gitlab.com>2016-03-21 14:12:52 +0100
committerZeger-Jan van de Weg <zegerjan@gitlab.com>2016-03-21 16:59:35 +0100
commit3b088fc5b53f03605484ebef1945b8839abe19de (patch)
tree1c058f36cf3610449d4636998b59128b5112131c /doc
parent98fd60f50b6658d21503f548649c8db291050ab7 (diff)
downloadgitlab-ce-3b088fc5b53f03605484ebef1945b8839abe19de.tar.gz
Minor improvements on IssuableActions
Diffstat (limited to 'doc')
-rw-r--r--doc/api/issues.md34
-rw-r--r--doc/api/merge_requests.md56
2 files changed, 11 insertions, 79 deletions
diff --git a/doc/api/issues.md b/doc/api/issues.md
index e2050db06d9..013ad9ffaa2 100644
--- a/doc/api/issues.md
+++ b/doc/api/issues.md
@@ -326,9 +326,11 @@ Example response:
}
```
-## Delete existing issue
+## Delete an issue
-Only for admins and project owners. Soft deletes the issue in question. Returns the issue which was deleted.
+Only for admins and project owners. Soft deletes the issue in question.
+If the operation is successful, a status code of `200` is returned. Any the case you cannot
+destroy this issue, or it is not present, code `404` is given.
```
DELETE /projects/:id/issues/:issue_id
@@ -343,34 +345,6 @@ DELETE /projects/:id/issues/:issue_id
curl -X DELETE -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/4/issues/85
```
-Example response:
-
-```json
-{
- "created_at" : "2016-01-07T12:46:01.410Z",
- "author" : {
- "name" : "Alexandra Bashirian",
- "avatar_url" : null,
- "username" : "eileen.lowe",
- "id" : 18,
- "state" : "active",
- "web_url" : "https://gitlab.example.com/u/eileen.lowe"
- },
- "state" : "closed",
- "title" : "Issues with auth",
- "project_id" : 4,
- "description" : null,
- "updated_at" : "2016-01-07T12:55:16.213Z",
- "iid" : 15,
- "labels" : [
- "bug"
- ],
- "id" : 85,
- "assignee" : null,
- "milestone" : null
-}
-```
-
## Comments on issues
Comments are done via the [notes](notes.md) resource.
diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md
index 499e56c6395..88c3d251404 100644
--- a/doc/api/merge_requests.md
+++ b/doc/api/merge_requests.md
@@ -380,9 +380,12 @@ Parameters:
If the operation is successful, 200 and the updated merge request is returned.
If an error occurs, an error number and a message explaining the reason is returned.
-## Delete a MR
+## Delete a merge request
+
+Only for admins and project owners. Soft deletes the merge request in question.
+If the operation is successful, a status code of `200` is returned. Any the case you cannot
+destroy this merge request, or it is not present, code `404` is given.
-Soft deletes a merge request. For admins and owners only.
```
DELETE /projects/:id/merge_requests/:merge_request_id
@@ -393,53 +396,8 @@ DELETE /projects/:id/merge_requests/:merge_request_id
| `id` | integer | yes | The ID of a project |
| `merge_request_id` | integer | yes | The ID of a project's merge request |
-Example response:
-
-```json
-{
- "id": 1,
- "target_branch": "master",
- "source_branch": "test1",
- "project_id": 3,
- "title": "test1",
- "state": "merged",
- "upvotes": 0,
- "downvotes": 0,
- "author": {
- "id": 1,
- "username": "admin",
- "email": "admin@example.com",
- "name": "Administrator",
- "state": "active",
- "created_at": "2012-04-29T08:46:00Z"
- },
- "assignee": {
- "id": 1,
- "username": "admin",
- "email": "admin@example.com",
- "name": "Administrator",
- "state": "active",
- "created_at": "2012-04-29T08:46:00Z"
- },
- "source_project_id": 4,
- "target_project_id": 4,
- "labels": [ ],
- "description":"fixed login page css paddings",
- "work_in_progress": false,
- "milestone": {
- "id": 5,
- "iid": 1,
- "project_id": 4,
- "title": "v2.0",
- "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
- "state": "closed",
- "created_at": "2015-02-02T19:49:26.013Z",
- "updated_at": "2015-02-02T19:49:26.013Z",
- "due_date": null
- },
- "merge_when_build_succeeds": true,
- "merge_status": "can_be_merged"
-}
+```bash
+curl -X DELETE -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/4/merge_request/85
```
## Accept MR