misc

Accessed as client.misc; the async client mirrors it.

SyncAsync

Misc

The misc namespace.

gitignore

gitignore: MiscGitignore = MiscGitignore(client)

label

label: MiscLabel = MiscLabel(client)

licenses

licenses: MiscLicenses = MiscLicenses(client)

markdown

markdown: MiscMarkdown = MiscMarkdown(client)

org

org: MiscOrg = MiscOrg(client)

repositories

repositories: MiscRepositories = MiscRepositories(client)

topics

topics: MiscTopics = MiscTopics(client)

markup

markup(
    *,
    branch_path: str | None = None,
    context: str | None = None,
    file_path: str | None = None,
    mode: str | None = None,
    text: str | None = None,
    wiki: bool | None = None,
) -> str

Render a markup document as HTML.

Parameters:

Name	Type	Description	Default
`branch_path`	`str \| None`	The current branch path where the form gets posted	`None`
`context`	`str \| None`	Context to render	`None`
`file_path`	`str \| None`	File path for detecting extension in file mode	`None`
`mode`	`str \| None`	Mode to render (comment, gfm, markdown, file)	`None`
`text`	`str \| None`	Text markup to render	`None`
`wiki`	`bool \| None`	Is it a wiki page ?	`None`

Returns:

Type	Description
`str`	MarkupRender is a rendered markup document.

Raises:

Type	Description
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: renderMarkup

nodeinfo

nodeinfo() -> NodeInfo

Returns the nodeinfo of the Forgejo application.

Returns:

Type	Description
`NodeInfo`	NodeInfo.

Operation ID: getNodeInfo

signing_key_gpg

signing_key_gpg() -> str

Get default signing-key.gpg.

Returns:

Type	Description
`str`	GPG armored public key.

Operation ID: getSigningKey

signing_key_ssh

signing_key_ssh() -> str

Get default signing-key.ssh.

Returns:

Type	Description
`str`	SSH public key in OpenSSH authorized key format.

Raises:

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

Operation ID: getSSHSigningKey

version

version() -> ServerVersion

Returns the version of the running application.

Returns:

Type	Description
`ServerVersion`	ServerVersion.

Operation ID: getVersion

AsyncMisc

The misc namespace.

gitignore

gitignore: AsyncMiscGitignore = AsyncMiscGitignore(client)

label

label: AsyncMiscLabel = AsyncMiscLabel(client)

licenses

licenses: AsyncMiscLicenses = AsyncMiscLicenses(client)

markdown

markdown: AsyncMiscMarkdown = AsyncMiscMarkdown(client)

org

org: AsyncMiscOrg = AsyncMiscOrg(client)

repositories

repositories: AsyncMiscRepositories = AsyncMiscRepositories(client)

topics

topics: AsyncMiscTopics = AsyncMiscTopics(client)

markup

markup(
    *,
    branch_path: str | None = None,
    context: str | None = None,
    file_path: str | None = None,
    mode: str | None = None,
    text: str | None = None,
    wiki: bool | None = None,
) -> str

Render a markup document as HTML.

Parameters:

Name	Type	Description	Default
`branch_path`	`str \| None`	The current branch path where the form gets posted	`None`
`context`	`str \| None`	Context to render	`None`
`file_path`	`str \| None`	File path for detecting extension in file mode	`None`
`mode`	`str \| None`	Mode to render (comment, gfm, markdown, file)	`None`
`text`	`str \| None`	Text markup to render	`None`
`wiki`	`bool \| None`	Is it a wiki page ?	`None`

Returns:

Type	Description
`str`	MarkupRender is a rendered markup document.

Raises:

Type	Description
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: renderMarkup

nodeinfo

nodeinfo() -> NodeInfo

Returns the nodeinfo of the Forgejo application.

Returns:

Type	Description
`NodeInfo`	NodeInfo.

Operation ID: getNodeInfo

signing_key_gpg

signing_key_gpg() -> str

Get default signing-key.gpg.

Returns:

Type	Description
`str`	GPG armored public key.

Operation ID: getSigningKey

signing_key_ssh

signing_key_ssh() -> str

Get default signing-key.ssh.

Returns:

Type	Description
`str`	SSH public key in OpenSSH authorized key format.

Raises:

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

Operation ID: getSSHSigningKey

version

version() -> ServerVersion

Returns the version of the running application.

Returns:

Type	Description
`ServerVersion`	ServerVersion.

Operation ID: getVersion