Document ReviewResult type
This is the return type of the SetReview call, but
it has been undocumented until now.
Bug: issue 6016
Change-Id: I10db1297e4fa628d467a25a3608c9ff091fc602d
diff --git a/Documentation/rest-api-changes.txt b/Documentation/rest-api-changes.txt
index dc97f97..0cbe82a 100644
--- a/Documentation/rest-api-changes.txt
+++ b/Documentation/rest-api-changes.txt
@@ -3422,7 +3422,7 @@
}
----
-As response a link:#review-info[ReviewInfo] entity is returned that
+As response a link:#review-result[ReviewResult] entity is returned that
describes the applied labels.
.Response
@@ -6275,6 +6275,24 @@
representing reviewers that should be added to the change.
|============================
+[[review-result]]
+=== ReviewResult
+The `ReviewResult` entity contains information regarding the updates
+that were made to a review.
+
+[options="header",cols="1,^1,5"]
+|============================
+|Field Name ||Description
+|`labels` |optional|
+Map of labels to values after the review was posted. Null if any reviewer
+additions were rejected.
+|`reviewers` |optional|
+Map of account or group identifier to
+link:rest-api-changes.html#add-reviewer-result[AddReviewerResult]
+representing the outcome of adding as a reviewer.
+Absent if no reviewer additions were requested.
+|============================
+
[[reviewer-info]]
=== ReviewerInfo
The `ReviewerInfo` entity contains information about a reviewer and its
