Skip to content

requested_reviewers

Accessed as client.repos.pulls.requested_reviewers; the async client mirrors it.

ReposPullsRequestedReviewers

The repos.pulls.requested_reviewers namespace.

create

create(
    owner: str, repo: str, index: int, *, reviewers: list[str] | None = None, team_reviewers: list[str] | None = None
) -> list[PullReview]

Create review requests for a pull request.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
index int

index of the pull request

required
reviewers list[str] | None
None
team_reviewers list[str] | None
None

Returns:

Type Description
list[PullReview]

PullReviewListWithoutPagination - Review requests without pagination headers.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.
UnprocessableEntityError
  1. APIValidationError is error format response related to input validation.

Operation ID: repoCreatePullReviewRequests

delete

delete(
    owner: str, repo: str, index: int, *, reviewers: list[str] | None = None, team_reviewers: list[str] | None = None
) -> None

Cancel review requests for a pull request.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
index int

index of the pull request

required
reviewers list[str] | None
None
team_reviewers list[str] | None
None

Returns:

Type Description
None

No content.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.
UnprocessableEntityError
  1. APIValidationError is error format response related to input validation.

Operation ID: repoDeletePullReviewRequests

AsyncReposPullsRequestedReviewers

The repos.pulls.requested_reviewers namespace.

create

create(
    owner: str, repo: str, index: int, *, reviewers: list[str] | None = None, team_reviewers: list[str] | None = None
) -> list[PullReview]

Create review requests for a pull request.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
index int

index of the pull request

required
reviewers list[str] | None
None
team_reviewers list[str] | None
None

Returns:

Type Description
list[PullReview]

PullReviewListWithoutPagination - Review requests without pagination headers.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.
UnprocessableEntityError
  1. APIValidationError is error format response related to input validation.

Operation ID: repoCreatePullReviewRequests

delete

delete(
    owner: str, repo: str, index: int, *, reviewers: list[str] | None = None, team_reviewers: list[str] | None = None
) -> None

Cancel review requests for a pull request.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
index int

index of the pull request

required
reviewers list[str] | None
None
team_reviewers list[str] | None
None

Returns:

Type Description
None

No content.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.
UnprocessableEntityError
  1. APIValidationError is error format response related to input validation.

Operation ID: repoDeletePullReviewRequests