summaryrefslogtreecommitdiff
path: root/doc/api/notes.md
diff options
context:
space:
mode:
authorRobert Speicher <robert@gitlab.com>2015-11-22 03:45:15 +0000
committerRobert Speicher <robert@gitlab.com>2015-11-22 03:45:15 +0000
commitb166ee6b1d6113642388bd5dc1b95fb53fc69d7b (patch)
tree26a332bf4fddaa5ba6f02b1268d9689df9b85154 /doc/api/notes.md
parent9155c82fdc075b7a3ef7f45224cbe5382c2ec7f9 (diff)
parent26b12e2c374c8f07abda06a8b19bd116448325f4 (diff)
downloadgitlab-ce-b166ee6b1d6113642388bd5dc1b95fb53fc69d7b.tar.gz
Merge branch 'fix-award-emoji-api' into 'master'
Add upvote/downvote fields to merge request and note API to preserve compatibility As discussed in !1825 we should not break the API compatibility. * This MR adds the fields `upvotes`/`downvotes` to the merge request API again, which always return `0`. * Add the fields `upvote`/`downvote` to the notes API, which always return `false` This behavior is documented in the API docs. See merge request !1867
Diffstat (limited to 'doc/api/notes.md')
-rw-r--r--doc/api/notes.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/doc/api/notes.md b/doc/api/notes.md
index bcba1f62151..e7f299c0994 100644
--- a/doc/api/notes.md
+++ b/doc/api/notes.md
@@ -6,7 +6,8 @@ Notes are comments on snippets, issues or merge requests.
### List project issue notes
-Gets a list of all notes for a single issue.
+Gets a list of all notes for a single issue. With GitLab 8.2 the return fields
+`upvote` and `downvote` are deprecated and always return `false`.
```
GET /projects/:id/issues/:issue_id/notes
@@ -32,7 +33,9 @@ Parameters:
"created_at": "2013-09-30T13:46:01Z"
},
"created_at": "2013-10-02T09:22:45Z",
- "system": true
+ "system": true,
+ "upvote": false,
+ "downvote": false
},
{
"id": 305,
@@ -47,7 +50,9 @@ Parameters:
"created_at": "2013-09-30T13:46:01Z"
},
"created_at": "2013-10-02T09:56:03Z",
- "system": false
+ "system": true,
+ "upvote": false,
+ "downvote": false
}
]
```