starred
Accessed as client.user.starred; the async client mirrors it.
UserStarred
The user.starred namespace.
add
add(owner: str, repo: str) -> None
Star the given repo.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
owner
|
str
|
owner of the repo to star |
required |
repo
|
str
|
name of the repo to star |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
UnauthorizedError
|
|
ForbiddenError
|
|
NotFoundError
|
|
Operation ID: userCurrentPutStar
get
get(owner: str, repo: str) -> None
Whether the authenticated is starring the repo.
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 |
|---|---|
UnauthorizedError
|
|
ForbiddenError
|
|
NotFoundError
|
|
Operation ID: userCurrentCheckStarring
list
list(*, page: int | None = None, limit: int | None = None) -> Paginated[Repository]
The repos that the authenticated user has starred.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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[Repository]
|
RepositoryList. |
Raises:
| Type | Description |
|---|---|
UnauthorizedError
|
|
ForbiddenError
|
|
Operation ID: userCurrentListStarred
remove
remove(owner: str, repo: str) -> None
Unstar the given repo.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
owner
|
str
|
owner of the repo to unstar |
required |
repo
|
str
|
name of the repo to unstar |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
UnauthorizedError
|
|
ForbiddenError
|
|
NotFoundError
|
|
Operation ID: userCurrentDeleteStar
AsyncUserStarred
The user.starred namespace.
add
add(owner: str, repo: str) -> None
Star the given repo.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
owner
|
str
|
owner of the repo to star |
required |
repo
|
str
|
name of the repo to star |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
UnauthorizedError
|
|
ForbiddenError
|
|
NotFoundError
|
|
Operation ID: userCurrentPutStar
get
get(owner: str, repo: str) -> None
Whether the authenticated is starring the repo.
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 |
|---|---|
UnauthorizedError
|
|
ForbiddenError
|
|
NotFoundError
|
|
Operation ID: userCurrentCheckStarring
list
list(*, page: int | None = None, limit: int | None = None) -> AsyncPaginated[Repository]
The repos that the authenticated user has starred.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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[Repository]
|
RepositoryList. |
Raises:
| Type | Description |
|---|---|
UnauthorizedError
|
|
ForbiddenError
|
|
Operation ID: userCurrentListStarred
remove
remove(owner: str, repo: str) -> None
Unstar the given repo.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
owner
|
str
|
owner of the repo to unstar |
required |
repo
|
str
|
name of the repo to unstar |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
UnauthorizedError
|
|
ForbiddenError
|
|
NotFoundError
|
|
Operation ID: userCurrentDeleteStar