Skip to content
forgit api docs

Create a review to an pull request

POST
/repos/{owner}/{repo}/pulls/{index}/reviews

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ 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

Request Body

Section titled “ Request Body ”

CreatePullReviewOptions are options to create a pull review

object
body
string
comments
Array<object>

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
commit_id
string
event

ReviewStateType review state type

string
Example generated 
{
  "body": "example",
  "comments": [
    {
      "body": "example",
      "extra_lines_count": 1,
      "new_position": 1,
      "old_position": 1,
      "path": "example"
    }
  ],
  "commit_id": "example",
  "event": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

PullReview

Media type application/json

PullReview represents a pull request review

object
body
string
comments_count
integer format: int64
commit_id
string
dismissed
boolean
html_url
string
id
integer format: int64
official
boolean
pull_request_url
string
stale
boolean
state

ReviewStateType review state type

string
submitted_at
string format: date-time
team

Team represents a team in an organization

object
can_create_org_repo
boolean
description
string
id
integer format: int64
includes_all_repositories
boolean
name
string
organization

Organization represents an organization

object
avatar_url
string
created
string format: date-time
description
string
email
string
full_name
string
id
integer format: int64
location
string
name
string
repo_admin_change_team_access
boolean
username

Deprecated

string
visibility
string
website
string
permission
string
Allowed values: none read write admin owner
units
Array<string>
units_map
object
key
additional properties
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 
{
  "team": {
    "permission": "none",
    "units": [
      "repo.code",
      "repo.issues",
      "repo.ext_issues",
      "repo.wiki",
      "repo.pulls",
      "repo.releases",
      "repo.projects",
      "repo.ext_wiki"
    ],
    "units_map": {
      "repo.actions": "none",
      "repo.code": "read",
      "repo.ext_issues": "none",
      "repo.ext_wiki": "none",
      "repo.issues": "write",
      "repo.packages": "none",
      "repo.projects": "none",
      "repo.pulls": "owner",
      "repo.releases": "none",
      "repo.wiki": "admin"
    }
  },
  "user": {
    "login_name": "empty"
  }
}

404

Section titled “ 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

Section titled “ 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"
}