sync_fork
Accessed as client.repos.sync_fork; the async client mirrors it.
ReposSyncFork
The repos.sync_fork namespace.
get
get(owner: str, repo: str) -> SyncForkInfo
Gets information about syncing the fork default branch with the base branch.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
owner
|
str
|
owner of the repo |
required |
repo
|
str
|
name of the repo |
required |
Returns:
| Type | Description |
|---|---|
SyncForkInfo
|
SyncForkInfo. |
Raises:
| Type | Description |
|---|---|
BadRequestError
|
|
NotFoundError
|
|
Operation ID: repoSyncForkDefaultInfo
get_branch
get_branch(owner: str, repo: str, branch: str) -> SyncForkInfo
Gets information about syncing a fork branch with the base branch.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
owner
|
str
|
owner of the repo |
required |
repo
|
str
|
name of the repo |
required |
branch
|
str
|
The branch |
required |
Returns:
| Type | Description |
|---|---|
SyncForkInfo
|
SyncForkInfo. |
Raises:
| Type | Description |
|---|---|
BadRequestError
|
|
NotFoundError
|
|
Operation ID: repoSyncForkBranchInfo
sync
sync(owner: str, repo: str) -> None
Syncs the default branch of a fork with the base branch.
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 |
|---|---|
BadRequestError
|
|
NotFoundError
|
|
Operation ID: repoSyncForkDefault
sync_branch
sync_branch(owner: str, repo: str, branch: str) -> None
Syncs a fork branch with the base branch.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
owner
|
str
|
owner of the repo |
required |
repo
|
str
|
name of the repo |
required |
branch
|
str
|
The branch |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
BadRequestError
|
|
NotFoundError
|
|
Operation ID: repoSyncForkBranch
AsyncReposSyncFork
The repos.sync_fork namespace.
get
get(owner: str, repo: str) -> SyncForkInfo
Gets information about syncing the fork default branch with the base branch.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
owner
|
str
|
owner of the repo |
required |
repo
|
str
|
name of the repo |
required |
Returns:
| Type | Description |
|---|---|
SyncForkInfo
|
SyncForkInfo. |
Raises:
| Type | Description |
|---|---|
BadRequestError
|
|
NotFoundError
|
|
Operation ID: repoSyncForkDefaultInfo
get_branch
get_branch(owner: str, repo: str, branch: str) -> SyncForkInfo
Gets information about syncing a fork branch with the base branch.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
owner
|
str
|
owner of the repo |
required |
repo
|
str
|
name of the repo |
required |
branch
|
str
|
The branch |
required |
Returns:
| Type | Description |
|---|---|
SyncForkInfo
|
SyncForkInfo. |
Raises:
| Type | Description |
|---|---|
BadRequestError
|
|
NotFoundError
|
|
Operation ID: repoSyncForkBranchInfo
sync
sync(owner: str, repo: str) -> None
Syncs the default branch of a fork with the base branch.
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 |
|---|---|
BadRequestError
|
|
NotFoundError
|
|
Operation ID: repoSyncForkDefault
sync_branch
sync_branch(owner: str, repo: str, branch: str) -> None
Syncs a fork branch with the base branch.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
owner
|
str
|
owner of the repo |
required |
repo
|
str
|
name of the repo |
required |
branch
|
str
|
The branch |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
BadRequestError
|
|
NotFoundError
|
|
Operation ID: repoSyncForkBranch