Add a new comment to a pull request review

POST

/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

owner

required

string

Owner of the repo

repo

required

string

Name of the repo

index

required

integer format: int64

Index of the pull request

id

required

integer format: int64

Id of the review

Request Body

CreatePullReviewComment represent a review comment for creation api

object

body

string

extra_lines_count

Number of additional lines after the commented line (0 = single line comment)

integer format: int64

new_position

If comment to new file line or 0

integer format: int64

old_position

If comment to old file line or 0

integer format: int64

path

The tree path

string

Example ^generated

{
  "body": "example",
  "extra_lines_count": 1,
  "new_position": 1,
  "old_position": 1,
  "path": "example"
}

CreatePullReviewComment represent a review comment for creation api

object

body

string

extra_lines_count

Number of additional lines after the commented line (0 = single line comment)

integer format: int64

new_position

If comment to new file line or 0

integer format: int64

old_position

If comment to old file line or 0

integer format: int64

path

The tree path

string

Responses

200

PullComment

Media type application/json

PullReviewComment represents a comment on a pull request review

object

body

string

commit_id

string

created_at

string format: date-time

diff_hunk

string

extra_lines_count

Number of additional lines after the commented line (0 = single line comment)

integer format: int64

html_url

string

id

integer format: int64

original_commit_id

string

original_position

integer format: uint64

path

string

position

integer format: uint64

pull_request_review_id

integer format: int64

pull_request_url

string

resolver

User represents a user

object

active

Is user active

boolean

avatar_url

URL to the user’s avatar

string

created

string format: date-time

description

The user’s description

string

email

string format: email

followers_count

User counts

integer format: int64

following_count

integer format: int64

full_name

The user’s full name

string

html_url

URL to the user’s profile page

string

id

The user’s id

integer format: int64

is_admin

Is the user an administrator

boolean

language

User locale

string

last_login

string format: date-time

location

The user’s location

string

login

The user’s username

string

login_name

The user’s authentication sign-in name.

string

default: empty

prohibit_login

Is user login prohibited

boolean

pronouns

The user’s pronouns

string

restricted

Is user restricted

boolean

source_id

The ID of the user’s Authentication Source

integer format: int64

starred_repos_count

integer format: int64

visibility

User visibility level option: public, limited, private

string

website

The user’s website

string

updated_at

string format: date-time

user

User represents a user

object

active

Is user active

boolean

avatar_url

URL to the user’s avatar

string

created

string format: date-time

description

The user’s description

string

email

string format: email

followers_count

User counts

integer format: int64

following_count

integer format: int64

full_name

The user’s full name

string

html_url

URL to the user’s profile page

string

id

The user’s id

integer format: int64

is_admin

Is the user an administrator

boolean

language

User locale

string

last_login

string format: date-time

location

The user’s location

string

login

The user’s username

string

login_name

The user’s authentication sign-in name.

string

default: empty

prohibit_login

Is user login prohibited

boolean

pronouns

The user’s pronouns

string

restricted

Is user restricted

boolean

source_id

The ID of the user’s Authentication Source

integer format: int64

starred_repos_count

integer format: int64

visibility

User visibility level option: public, limited, private

string

website

The user’s website

string

Example

{
  "resolver": {
    "login_name": "empty"
  },
  "user": {
    "login_name": "empty"
  }
}

404

APINotFound is a not found error response

Media type application/json

object

errors

Array<string>

message

string

url

string

Example ^generated

{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}

422

APIValidationError is error format response related to input validation

Media type application/json

object

message

string

url

string

Example ^generated

{
  "message": "example",
  "url": "example"
}