Skip to content

reactions

Accessed as client.repos.issues.reactions; the async client mirrors it.

ReposIssuesReactions

The repos.issues.reactions namespace.

create

create(owner: str, repo: str, index: int, *, content: str | None = None) -> Reaction

Add a reaction to an issue.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
index int

index of the issue

required
content str | None
None

Returns:

Type Description
Reaction

Reaction.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: issuePostIssueReaction

delete

delete(owner: str, repo: str, index: int, *, content: str | None = None) -> None

Remove a reaction from an issue.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
index int

index of the issue

required
content 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.

Operation ID: issueDeleteIssueReaction

list

list(owner: str, repo: str, index: int, *, page: int | None = None, limit: int | None = None) -> Paginated[Reaction]

Get a list reactions of an issue.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
index int

index of the issue

required
page int | None

1-based page to start iteration at.

None
limit int | None

Page size; the instance caps it server-side.

None

Returns:

Type Description
Paginated[Reaction]

ReactionList.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: issueGetIssueReactions

AsyncReposIssuesReactions

The repos.issues.reactions namespace.

create

create(owner: str, repo: str, index: int, *, content: str | None = None) -> Reaction

Add a reaction to an issue.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
index int

index of the issue

required
content str | None
None

Returns:

Type Description
Reaction

Reaction.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: issuePostIssueReaction

delete

delete(owner: str, repo: str, index: int, *, content: str | None = None) -> None

Remove a reaction from an issue.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
index int

index of the issue

required
content 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.

Operation ID: issueDeleteIssueReaction

list

list(
    owner: str, repo: str, index: int, *, page: int | None = None, limit: int | None = None
) -> AsyncPaginated[Reaction]

Get a list reactions of an issue.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
index int

index of the issue

required
page int | None

1-based page to start iteration at.

None
limit int | None

Page size; the instance caps it server-side.

None

Returns:

Type Description
AsyncPaginated[Reaction]

ReactionList.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: issueGetIssueReactions