Jump to >

Review General Comment Resource

Added in 1.6

Provides information on general 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.

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}/general-comments/{comment_id}/
Required Features
  • reviews.general_comments
Token Policy ID review_general_comment
HTTP Methods
  • DELETE - Deletes the comment.
  • GET - Returns information on the comment.
  • PUT - Updates a general comment.
Parent Resource Review 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

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 the comment.

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

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

Instead of a payload response on success, 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 the comment.

This contains the comment text and the date/time the comment was made.

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 general comment.

This can update the text or region of an existing comment. It can only be done for comments that are part of a draft review.

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

issue_openedBoolean

Whether or not the comment opens an issue.

Added in 2.0

issue_statusOne of resolved, verifying-resolved, open, dropped, verifying-dropped

The status of an open issue.

Added in 2.0

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.general-comment+json

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