Skip to content

dependencies

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

ReposIssuesDependencies

The repos.issues.dependencies namespace.

create

create(owner: str, repo: str, index: int, *, body_index: int, body_owner: str, body_repo: str) -> Issue

Make the issue in the url depend on the issue in the form.

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
body_index int

Wire field index.

required
body_owner str

Wire field owner.

required
body_repo str

Wire field repo.

required

Returns:

Type Description
Issue

Issue.

Raises:

Type Description
NotFoundError
  1. the issue does not exist.
LockedError
  1. APIRepoArchivedError is an error that is raised when an archived repo should be modified.

Operation ID: issueCreateIssueDependencies

delete

delete(owner: str, repo: str, index: int, *, body_index: int, body_owner: str, body_repo: str) -> Issue

Remove an issue dependency.

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
body_index int

Wire field index.

required
body_owner str

Wire field owner.

required
body_repo str

Wire field repo.

required

Returns:

Type Description
Issue

Issue.

Raises:

Type Description
NotFoundError
  1. APINotFound is a not found error response.
LockedError
  1. APIRepoArchivedError is an error that is raised when an archived repo should be modified.

Operation ID: issueRemoveIssueDependencies

list

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

List an issue's dependencies, i.e all issues that block this 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[Issue]

IssueListWithoutPagination - Issues without pagination headers (used for pinned issues, dependencies, etc.).

Raises:

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

Operation ID: issueListIssueDependencies

AsyncReposIssuesDependencies

The repos.issues.dependencies namespace.

create

create(owner: str, repo: str, index: int, *, body_index: int, body_owner: str, body_repo: str) -> Issue

Make the issue in the url depend on the issue in the form.

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
body_index int

Wire field index.

required
body_owner str

Wire field owner.

required
body_repo str

Wire field repo.

required

Returns:

Type Description
Issue

Issue.

Raises:

Type Description
NotFoundError
  1. the issue does not exist.
LockedError
  1. APIRepoArchivedError is an error that is raised when an archived repo should be modified.

Operation ID: issueCreateIssueDependencies

delete

delete(owner: str, repo: str, index: int, *, body_index: int, body_owner: str, body_repo: str) -> Issue

Remove an issue dependency.

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
body_index int

Wire field index.

required
body_owner str

Wire field owner.

required
body_repo str

Wire field repo.

required

Returns:

Type Description
Issue

Issue.

Raises:

Type Description
NotFoundError
  1. APINotFound is a not found error response.
LockedError
  1. APIRepoArchivedError is an error that is raised when an archived repo should be modified.

Operation ID: issueRemoveIssueDependencies

list

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

List an issue's dependencies, i.e all issues that block this 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[Issue]

IssueListWithoutPagination - Issues without pagination headers (used for pinned issues, dependencies, etc.).

Raises:

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

Operation ID: issueListIssueDependencies