Review Board 2.0 Documentation

Need help? Talk to us today about a support contract!

Jump to >

This documentation covers Review Board 2.0. You can see the latest Review Board documentation or all other versions.

Review File Attachment Comment List Resource

Provides information on file comments made on a review.

If the review is a draft, then comments can be added, deleted, or changed on this list. However, if the review is already published, then no changes can be made.

Details

Name file_attachment_comments
URI /api/review-requests/{review_request_id}/reviews/{review_id}/file-attachment-comments/
HTTP Methods
  • GET - Returns the list of file comments made on a review.
  • POST - Creates a file comment on a review.
Parent Resource Review Resource
Child Resources
Anonymous Access Yes, if anonymous site access is enabled

HTTP GET

Returns the list of file comments made on a review.

Request Parameters

counts-onlyBoolean If specified, a single count field is returned with the number of results, instead of the results themselves.
max-resultsInteger The maximum number of results to return in this list. By default, this is 25. There is a hard limit of 200; if you need more than 200 results, you will need to make more than one request, using the “next” pagination link.
startInteger 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.

Errors

100 - Does Not ExistHTTP 404 - Not Found Object does not exist
101 - Permission DeniedHTTP 403 - Forbidden You don’t have permission for this
103 - Not Logged InHTTP 401 - Unauthorized You are not logged in
105 - Invalid Form DataHTTP 400 - Bad Request One or more fields had errors

HTTP POST

Creates a file comment on a review.

This will create a new comment on a file as part of a review. The comment contains text only.

Request Parameters

file_attachment_idInteger Required

The ID of the file attachment being commented on.
textRich Text Required

The comment text.
diff_against_file_attachment_idInteger The ID of the file attachment that file_attachment_id is diffed against. The comment applies to the diff between these two attachments.
force_text_typeOne of plain, markdown, html The text type, if any, to force for returned text fields. The contents will be converted to the requested type in the payload, but will not be saved as that type.
issue_openedBoolean Whether the comment opens an issue.
text_typeOne of plain, markdown The content type for the comment text field. The default is plain.

Errors

100 - Does Not ExistHTTP 404 - Not Found Object does not exist
101 - Permission DeniedHTTP 403 - Forbidden You don’t have permission for this
103 - Not Logged InHTTP 401 - Unauthorized You are not logged in
105 - Invalid Form DataHTTP 400 - Bad Request One or more fields had errors

Examples

application/vnd.reviewboard.org.file-attachment-comments+json

$ curl http://reviews.example.com/api/review-requests/8/reviews/8/file-attachment-comments/ -H "Accept: application/json"

Vary: Accept, Cookie
Item-Content-Type: application/vnd.reviewboard.org.file-attachment-comment+json
Content-Type: application/vnd.reviewboard.org.file-attachment-comments+json
X-Content-Type-Options: nosniff

{
  "file_attachment_comments": [
    {
      "diff_against_file_attachment": null, 
      "extra_data": {}, 
      "id": 1, 
      "issue_opened": false, 
      "issue_status": "", 
      "link_text": "screenshot1.png", 
      "links": {
        "delete": {
          "href": "http://reviews.example.com/api/review-requests/8/reviews/8/file-attachment-comments/1/", 
          "method": "DELETE"
        }, 
        "file_attachment": {
          "href": "http://reviews.example.com/api/review-requests/8/file-attachments/1/", 
          "method": "GET", 
          "title": "Example Attachment"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/review-requests/8/reviews/8/file-attachment-comments/1/", 
          "method": "GET"
        }, 
        "update": {
          "href": "http://reviews.example.com/api/review-requests/8/reviews/8/file-attachment-comments/1/", 
          "method": "PUT"
        }, 
        "user": {
          "href": "http://reviews.example.com/api/users/admin/", 
          "method": "GET", 
          "title": "admin"
        }
      }, 
      "public": true, 
      "review_url": "/r/8/#fcomment1", 
      "text": "A fantastic comment on a fantastic file!", 
      "text_type": "plain", 
      "thumbnail_html": null, 
      "timestamp": "2011-08-26T02:49:32Z"
    }
  ], 
  "links": {
    "create": {
      "href": "http://reviews.example.com/api/review-requests/8/reviews/8/file-attachment-comments/", 
      "method": "POST"
    }, 
    "self": {
      "href": "http://reviews.example.com/api/review-requests/8/reviews/8/file-attachment-comments/", 
      "method": "GET"
    }
  }, 
  "stat": "ok", 
  "total_results": 1
}