New in version 1.6.
Review Reply File Attachment Comment List Resource¶
Name | file_attachment_comments |
URI | /api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/file-attachment-comments/ |
Description | Provides information on replies to file comments made on a review reply. If the reply is a draft, then comments can be added, deleted, or changed on this list. However, if the reply is already published, then no changed can be made. |
HTTP Methods | |
Parent Resource | Review Reply Resource |
Child Resources | |
Anonymous Access | Yes, if anonymous site access is enabled |
Links¶
Name | Method | Resource |
---|---|---|
create | POST | Review Reply File Attachment Comment List Resource |
self | GET | Review Reply File Attachment Comment List Resource |
HTTP GET¶
Returns the list of replies to file comments made on a review reply.
Request Parameters¶
Field | Type | Description |
---|---|---|
counts-only (optional) | Boolean | If specified, a single count field is returned with the number of results, instead of the results themselves. |
max-results (optional) | Integer | The maximum number of results to return in this list. By default, this is 25. |
start (optional) | Integer | The 0-based index of the first result in the list. The start index is usually the previous start index plus the number of previous results. By default, this is 0. |
HTTP POST¶
Creates a reply to a file comment on a review.
This will create a reply to a file comment on a review. The new comment will contain the same dimensions of the comment being replied to, but may contain new text.
Request Parameters¶
Field | Type | Description |
---|---|---|
reply_to_id (required) | Integer | The ID of the comment being replied to. |
text (required) | String | The comment text. |
Examples¶
application/vnd.reviewboard.org.review-reply-file-attachment-comments+json¶
{
"file_attachment_comments": [
{
"id": 2,
"issue_opened": false,
"issue_status": "",
"links": {
"delete": {
"href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/2/",
"method": "DELETE"
},
"file_attachment": {
"href": "http://reviews.example.com/api/review-requests/8/file-attachments/1/",
"method": "GET",
"title": "Example Attachment"
},
"reply_to": {
"href": "http://reviews.example.com/api/review-requests/8/reviews/8/file-attachment-comments/1/",
"method": "GET",
"title": "A fantastic comment on a fantastic file!"
},
"self": {
"href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/2/",
"method": "GET"
},
"update": {
"href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/2/",
"method": "PUT"
},
"user": {
"href": "http://reviews.example.com/api/users/admin/",
"method": "GET",
"title": "admin"
}
},
"public": true,
"text": "A reply to a fantastic comment.",
"timestamp": "2011-08-26 02:52:57"
}
],
"links": {
"create": {
"href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/",
"method": "POST"
},
"self": {
"href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/",
"method": "GET"
}
},
"stat": "ok",
"total_results": 1
}
application/vnd.reviewboard.org.review-reply-file-attachment-comments+xml¶
<?xml version="1.0" encoding="utf-8"?>
<rsp>
<total_results>1</total_results>
<stat>ok</stat>
<links>
<self>
<href>http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/</href>
<method>GET</method>
</self>
<create>
<href>http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/</href>
<method>POST</method>
</create>
</links>
<file_attachment_comments>
<array>
<item>
<issue_opened>0</issue_opened>
<links>
<self>
<href>http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/2/</href>
<method>GET</method>
</self>
<update>
<href>http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/2/</href>
<method>PUT</method>
</update>
<user>
<href>http://reviews.example.com/api/users/admin/</href>
<method>GET</method>
<title>admin</title>
</user>
<reply_to>
<href>http://reviews.example.com/api/review-requests/8/reviews/8/file-attachment-comments/1/</href>
<method>GET</method>
<title>A fantastic comment on a fantastic file!</title>
</reply_to>
<file_attachment>
<href>http://reviews.example.com/api/review-requests/8/file-attachments/1/</href>
<method>GET</method>
<title>Example Attachment</title>
</file_attachment>
<delete>
<href>http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/2/</href>
<method>DELETE</method>
</delete>
</links>
<timestamp>2011-08-26 02:52:57</timestamp>
<id>2</id>
<text>A reply to a fantastic comment.</text>
<public>1</public>
<issue_status></issue_status>
</item>
</array>
</file_attachment_comments>
</rsp>