Review Reply Diff Comment Resource¶

Name	`diff_comment`
URI	`/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/diff-comments/{comment_id}/`
Description	Provides information on replies to diff 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	DELETE - Deletes a comment from a draft reply. GET - Returns information on a reply to a comment. PUT - Updates a reply to a diff comment.
Parent Resource	Review Reply Diff Comment List Resource
Child Resources	None
Anonymous Access	Yes, if anonymous site access is enabled

Fields¶

Field	Type	Description
filediff	File Diff Resource	The per-file diff that the comment was made on.
first_line	Integer	The line number that the comment starts at.
id	Integer	The numeric ID of the comment.
interfilediff	File Diff Resource	The second per-file diff in an interdiff that the comment was made on. This will be `null` if the comment wasn’t made on an interdiff.
num_lines	Integer	The number of lines the comment spans.
public	Boolean	Whether or not the comment is part of a public review.
reply_to	Review Diff Comment Resource	The comment being replied to.
text	String	The comment text.
timestamp	String	The date and time that the comment was made (in YYYY-MM-DD HH:MM:SS format).
user	User Resource	The user who made the comment.

Links¶

Name	Method	Resource
delete	DELETE	Review Reply Diff Comment Resource
self	GET	Review Reply Diff Comment Resource
update	PUT	Review Reply Diff Comment Resource

HTTP DELETE¶

Deletes a comment from a draft reply.

This will remove the comment from the reply. This cannot be undone.

Only comments on draft replies can be deleted. Attempting to delete a published comment will return a Permission Denied error.

Instead of a payload response, this will return HTTP 204 No Content.

Errors¶

HTTP GET¶

Returns information on a reply to a comment.

Much of the information will be identical to that of the comment being replied to. For example, the range of lines. This is because the reply to the comment is meant to cover the exact same code that the original comment covers.

Errors¶

HTTP PUT¶

Updates a reply to a diff comment.

This can only update the text in the comment. The comment being replied to cannot change.

Request Parameters¶

Field	Type	Description
text (required)	String	The new comment text.

Errors¶

Examples¶

application/json¶

{
  "diff_comment": {
    "first_line": 12, 
    "id": 9, 
    "interfilediff": null, 
    "links": {
      "delete": {
        "href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/diff-comments/9/", 
        "method": "DELETE"
      }, 
      "filediff": {
        "href": "http://reviews.example.com/api/review-requests/8/diffs/3/files/41/", 
        "method": "GET", 
        "title": "/trunk/reviewboard/settings_local.py.tmpl (1797) -> /trunk/reviewboard/settings_local.py.tmpl ((working copy))"
      }, 
      "reply_to": {
        "href": "http://reviews.example.com/api/review-requests/8/reviews/8/diff-comments/5/", 
        "method": "GET", 
        "title": "This is just a sample comment."
      }, 
      "self": {
        "href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/diff-comments/9/", 
        "method": "GET"
      }, 
      "update": {
        "href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/diff-comments/9/", 
        "method": "PUT"
      }, 
      "user": {
        "href": "http://reviews.example.com/api/users/admin/", 
        "method": "GET", 
        "title": "admin"
      }
    }, 
    "num_lines": 3, 
    "public": true, 
    "text": "I completely agree.", 
    "timestamp": "2010-08-25 03:00:22"
  }, 
  "stat": "ok"
}

application/xml¶

<?xml version="1.0" encoding="utf-8"?>
<rsp>
 <stat>ok</stat>
 <diff_comment>
  <interfilediff>
  </interfilediff>
  <num_lines>3</num_lines>
  <links>
   <self>
    <href>http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/diff-comments/9/</href>
    <method>GET</method>
   </self>
   <update>
    <href>http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/diff-comments/9/</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/diff-comments/5/</href>
    <method>GET</method>
    <title>This is just a sample comment.</title>
   </reply_to>
   <delete>
    <href>http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/diff-comments/9/</href>
    <method>DELETE</method>
   </delete>
   <filediff>
    <href>http://reviews.example.com/api/review-requests/8/diffs/3/files/41/</href>
    <method>GET</method>
    <title>/trunk/reviewboard/settings_local.py.tmpl (1797) -&gt; /trunk/reviewboard/settings_local.py.tmpl ((working copy))</title>
   </filediff>
  </links>
  <timestamp>2010-08-25 03:00:22</timestamp>
  <public>1</public>
  <text>I completely agree.</text>
  <first_line>12</first_line>
  <id>9</id>
 </diff_comment>
</rsp>