opendev/gerrit
Code Issues Proposed changes

Merge "Clarify the List Comments REST endpoint"

Browse Source
This commit is contained in:
David Pursehouse 2014-06-03 00:55:37 +00:00 committed by Gerrit Code Review
commit f847f88ef1
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/rest-api-changes.txt
View File

@ -2160,7 +2160,9 @@ Lists the published comments of a revision.
As result a map is returned that maps the file path to a list of As result a map is returned that maps the file path to a list of
link:#comment-info[CommentInfo] entries. The entries in the map are link:#comment-info[CommentInfo] entries. The entries in the map are
sorted by file path. sorted by file path and only include file (or inline) comments. Use
the link:#get-change-detail[Get Change Detail] endpoint to retrieve
the general change message (or comment).
.Request .Request
---- ----
@ -2864,7 +2866,7 @@ attached to a change.
|Field Name ||Description |Field Name ||Description
|`id` ||The ID of the message. |`id` ||The ID of the message.
|`author` |optional| |`author` |optional|
Author of the message as an Author of the message as an
link:rest-api-accounts.html#account-info[AccountInfo] entity. + link:rest-api-accounts.html#account-info[AccountInfo] entity. +
Unset if written by the Gerrit system. Unset if written by the Gerrit system.
|`date` || |`date` ||