create review requests for a pull request

POST

/repos/{owner}/{repo}/pulls/{index}/requested_reviewers

curl --request POST \
  --url https://gitea.example.com/api/v1/repos/example/example/pulls/1/requested_reviewers \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "reviewers": [ "example" ], "team_reviewers": [ "example" ] }'

Authorizations

• BasicAuth
• Token
• AccessToken
• 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

Request Body

PullReviewRequestOptions are options to add or remove pull review requests

object

reviewers

Array<string>

team_reviewers

Array<string>

Example^generated

{
  "reviewers": [
    "example"
  ],
  "team_reviewers": [
    "example"
  ]
}

PullReviewRequestOptions are options to add or remove pull review requests

object

reviewers

Array<string>

team_reviewers

Array<string>

Responses

201

PullReviewList

Media typeapplication/json

Array<object>

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

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 gitea 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

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.code": "read",
        "repo.ext_issues": "none",
        "repo.ext_wiki": "none",
        "repo.issues": "write",
        "repo.projects": "none",
        "repo.pulls": "owner",
        "repo.releases": "none",
        "repo.wiki": "admin"
      }
    },
    "user": {
      "login_name": "empty"
    }
  }
]

404

APINotFound is a not found empty response

Media typeapplication/json

422

APIValidationError is error format response related to input validation

Media typeapplication/json

Headers

message

string

url

string