Skip to content
Try Gitea Cloud ☁️ for 30 days → Accelerate your Development & Deploys!
GiteaGitea Documentation
This is the documentation of the next version, still under development. See the latest release.

Dismiss a review for a pull request

POST
/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals
curl --request POST \
  --url https://gitea.com/api/v1/repos/example/example/pulls/1/reviews/1/dismissals \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "message": "example", "priors": true }'

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

id
required
integer format: int64

Id of the review

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

DismissPullReviewOptions are options to dismiss a pull request review

object
message
string
priors
boolean
Examplegenerated
{
  "message": "example",
  "priors": true
}

Responses

Section titled “Responses”

200

Section titled “200”

PullReview

Media typeapplication/json

PullReview represents a pull request review

object
body
string
comments_count
integer format: int64
commit_id
string
dismissed
boolean
html_url

HTMLURL is the web URL for viewing the review

string format: uri
id
integer format: int64
official
boolean
pull_request_url

HTMLPullURL is the web URL for the pull request

string format: uri
stale
boolean
state
string
Allowed values: APPROVED PENDING COMMENT REQUEST_CHANGES REQUEST_REVIEW
submitted_at
string format: date-time
team

Team represents a team in an organization

object
can_create_org_repo

Whether the team can create repositories in the organization

boolean
description

The description of the team

string
id

The unique identifier of the team

integer format: int64
includes_all_repositories

Whether the team has access to all repositories in the organization

boolean
name

The name of the team

string
organization

Organization represents an organization

object
avatar_url

The URL of the organization’s avatar

string format: uri
description

The description of the organization

string
email

The email address of the organization

string
full_name

The full display name of the organization

string
id

The unique identifier of the organization

integer format: int64
location

The location of the organization

string
name

The name of the organization

string
repo_admin_change_team_access

Whether repository administrators can change team access

boolean
username

Username of the organization deprecated

string
visibility

The visibility level of the organization (public, limited, private)

string
Allowed values: public limited private
website

The website URL of the organization

string
permission
string
Allowed values: none read write admin owner
units

Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions.

Array<string>
units_map
object
key
additional properties
string
visibility

Team visibility within the organization. “private” teams are only listable by members and org owners; “limited” teams are listable by any organization member; “public” teams are listable by any signed-in user.

string
Allowed values: public limited private
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 format: uri
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 format: uri
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

Login of the user, same as username

string
login_name

Identifier of the user, provided by the external authenticator (if configured)

string
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
Allowed values: public limited private
website

The user’s website

string
Example
{
  "state": "APPROVED",
  "team": {
    "organization": {
      "visibility": "public"
    },
    "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"
    },
    "visibility": "public"
  },
  "user": {
    "visibility": "public"
  }
}

403

Section titled “403”

APIForbiddenError is a forbidden error response

Headers

Section titled “Headers”
message
string
url
string

404

Section titled “404”

APINotFound is a not found empty response

422

Section titled “422”

APIValidationError is error format response related to input validation

Headers

Section titled “Headers”
message
string
url
string