From 23845a1e6f3be4c7b059eb64edcd524265721fe8 Mon Sep 17 00:00:00 2001 From: Khai Do Date: Mon, 2 Jun 2014 11:28:16 -0700 Subject: [PATCH] Clarify the List Comments REST endpoint The List Comments endpoint is a little confusing because users expect this to get file as well as message comments. This endpoint only retrieves the former, not the latter. Message comments can be retrieved with the Get Change Detail endpoint. This change just updates the docs to be more clear. Issue: 2693 Change-Id: Id4fcbcaa0e755cc650cbaaf07b57dbae7e4a370f --- Documentation/rest-api-changes.txt | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Documentation/rest-api-changes.txt b/Documentation/rest-api-changes.txt index 24c1012948..91eece8481 100644 --- a/Documentation/rest-api-changes.txt +++ b/Documentation/rest-api-changes.txt @@ -2141,7 +2141,9 @@ Lists the published comments of a revision. 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 -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 ---- @@ -2845,7 +2847,7 @@ attached to a change. |Field Name ||Description |`id` ||The ID of the message. |`author` |optional| -Author of the message as an +Author of the message as an link:rest-api-accounts.html#account-info[AccountInfo] entity. + Unset if written by the Gerrit system. |`date` ||