wiki

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

SyncAsync

ReposWiki

The repos.wiki namespace.

page: ReposWikiPage = ReposWikiPage(client)

revisions: ReposWikiRevisions = ReposWikiRevisions(client)

create(
    owner: str, repo: str, *, content_base64: str | None = None, message: str | None = None, title: str | None = None
) -> WikiPage

Create a wiki page.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`content_base64`	`str \| None`	content must be base64 encoded	`None`
`message`	`str \| None`	optional commit message summarizing the change	`None`
`title`	`str \| None`	page title. leave empty to keep unchanged	`None`

Returns:

Type	Description
`WikiPage`	WikiPage.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`PayloadTooLargeError`	QuotaExceeded.
`LockedError`	APIRepoArchivedError is an error that is raised when an archived repo should be modified.

Operation ID: repoCreateWikiPage

pages(owner: str, repo: str, *, page: int | None = None, limit: int | None = None) -> Paginated[WikiPageMetaData]

Get all wiki pages.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	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[WikiPageMetaData]`	WikiPageList.

Raises:

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

Operation ID: repoGetWikiPages

The repos.wiki namespace.

page: AsyncReposWikiPage = AsyncReposWikiPage(client)

revisions: AsyncReposWikiRevisions = AsyncReposWikiRevisions(client)

create(
    owner: str, repo: str, *, content_base64: str | None = None, message: str | None = None, title: str | None = None
) -> WikiPage

Create a wiki page.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`content_base64`	`str \| None`	content must be base64 encoded	`None`
`message`	`str \| None`	optional commit message summarizing the change	`None`
`title`	`str \| None`	page title. leave empty to keep unchanged	`None`

Returns:

Type	Description
`WikiPage`	WikiPage.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`PayloadTooLargeError`	QuotaExceeded.
`LockedError`	APIRepoArchivedError is an error that is raised when an archived repo should be modified.

Operation ID: repoCreateWikiPage

pages(owner: str, repo: str, *, page: int | None = None, limit: int | None = None) -> AsyncPaginated[WikiPageMetaData]

Get all wiki pages.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	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[WikiPageMetaData]`	WikiPageList.

Raises:

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

Operation ID: repoGetWikiPages