Jump to >

Review Reply General Comment Resource

Added in 1.6

Provides information on replies to general comments.

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.

Important

Using this resource requires extra features to be enabled on the server. See “Required Features” below.

Details

Name general_comment
URI /api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/general-comments/{comment_id}/
Required Features
  • reviews.general_comments
Token Policy ID review_reply_general_comment
HTTP Methods
  • DELETE - Deletes a general comment from a draft reply.
  • GET - Returns information on a reply to a general comment.
  • PUT - Updates a reply to a general comment.
Parent Resource Review Reply General Comment List Resource
Child Resources None
Anonymous Access Yes, if anonymous site access is enabled

Fields

extra_dataDictionary

Extra data as part of the comment. This depends on what is being commented on, and may be used in conjunction with an extension.

Added in 2.0

idInteger The numeric ID of the comment.
issue_openedBoolean Whether or not a comment opens an issue.
issue_statusOne of resolved, verifying-resolved, open, dropped, verifying-dropped The status of an issue.
publicBoolean

Whether or not the comment is part of a public review.

Added in 2.0

reply_toReview General Comment Resource The comment being replied to.
textRich Text

The comment text.

Added in 2.0

text_typeOne of plain, markdown, html

The mode for the comment text field.

Added in 2.0

timestampString

The date and time that the comment was made (in YYYY-MM-DD HH:MM:SS format).

Added in 2.0

userUser Resource

The user who made the comment.

Added in 2.0

HTTP DELETE

Deletes a general 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

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
112 - OAuth2 Missing Scope ErrorHTTP 403 - Forbidden Your OAuth2 token lacks the necessary scopes for this request.
113 - OAuth2 Access Denied ErrorHTTP 403 - Forbidden OAuth2 token access for this resource is prohibited.

HTTP GET

Returns information on a reply to a general comment.

Much of the information will be identical to that of the comment being replied to.

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
112 - OAuth2 Missing Scope ErrorHTTP 403 - Forbidden Your OAuth2 token lacks the necessary scopes for this request.
113 - OAuth2 Access Denied ErrorHTTP 403 - Forbidden OAuth2 token access for this resource is prohibited.

HTTP PUT

Updates a reply to a general comment.

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

Extra data can be stored later lookup. See Storing/Accessing Extra Data for more information.

Request Parameters

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.

Added in 2.0.9

textRich Text

The comment text.

Added in 2.0

text_typeOne of plain, markdown

The new content type for the comment text field. The default is to leave the type unchanged.

Added in 2.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
112 - OAuth2 Missing Scope ErrorHTTP 403 - Forbidden Your OAuth2 token lacks the necessary scopes for this request.
113 - OAuth2 Access Denied ErrorHTTP 403 - Forbidden OAuth2 token access for this resource is prohibited.

Examples

application/vnd.reviewboard.org.review-reply-general-comment+json

$ curl http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/general-comments/2/ -H "Accept: application/json"
Vary: Accept, Cookie
ETag: 014c5d9fce68235569d3aa2c2bd7b5d1c8ee1286
Content-Type: application/vnd.reviewboard.org.review-reply-general-comment+json
X-Content-Type-Options: nosniff
{
  "general_comment": {
    "extra_data": {}, 
    "id": 2, 
    "issue_opened": false, 
    "issue_status": "", 
    "links": {
      "delete": {
        "href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/general-comments/2/", 
        "method": "DELETE"
      }, 
      "reply_to": {
        "href": "http://reviews.example.com/api/review-requests/8/reviews/8/general-comments/1/", 
        "method": "GET", 
        "title": "This is a general comment"
      }, 
      "self": {
        "href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/general-comments/2/", 
        "method": "GET"
      }, 
      "update": {
        "href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/general-comments/2/", 
        "method": "PUT"
      }, 
      "user": {
        "href": "http://reviews.example.com/api/users/admin/", 
        "method": "GET", 
        "title": "admin"
      }
    }, 
    "public": true, 
    "text": "This is a reply to a general comment", 
    "text_type": "plain", 
    "timestamp": "2017-10-03T09:02:43Z"
  }, 
  "stat": "ok"
}