Skip to content

avatar

Accessed as client.repos.avatar; the async client mirrors it.

ReposAvatar

The repos.avatar namespace.

delete

delete(owner: str, repo: str) -> None

Delete a repository's avatar.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required

Returns:

Type Description
None

No content.

Raises:

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

Operation ID: repoDeleteAvatar

update

update(owner: str, repo: str, *, image: str | None = None) -> None

Update a repository's avatar.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
image str | None

image must be base64 encoded

None

Returns:

Type Description
None

No content.

Raises:

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

Operation ID: repoUpdateAvatar

AsyncReposAvatar

The repos.avatar namespace.

delete

delete(owner: str, repo: str) -> None

Delete a repository's avatar.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required

Returns:

Type Description
None

No content.

Raises:

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

Operation ID: repoDeleteAvatar

update

update(owner: str, repo: str, *, image: str | None = None) -> None

Update a repository's avatar.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
image str | None

image must be base64 encoded

None

Returns:

Type Description
None

No content.

Raises:

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

Operation ID: repoUpdateAvatar