Skip to main content

:::note Generated reference Generated from honeyframeapi 0.1.8 — do not edit by hand. :::

honeyframeapi.wiki

Project Wiki — list, create, read, edit and delete a project's wiki pages.

Honeyframe project wikis are a flat set of Markdown pages per project, each addressed by a slug. CRUD over /api/wiki; reads need project.view, writes project.edit.

proj = client.get_project(1)
page = proj.create_wiki_page("Runbook", body="# Steps\n1. pull\n2. migrate")
page.update(body="# Steps\n1. pull\n2. migrate\n3. restart")
for p in proj.list_wiki_pages():
    print(p["slug"], p["title"])

class WikiPage​

A handle to a project wiki page (addressed by slug).

WikiPage.get()​

get() -> dict

Fetch the page (incl. body).

WikiPage.title​

property

title: str

WikiPage.body​

property

body: str

WikiPage.update()​

update(*, title: Optional[str] = None, body: Optional[str] = None) -> WikiPage

Update the page (PUT). Only the fields you pass change; the other is preserved (fetched first if not already loaded).

WikiPage.delete()​

delete() -> None

Delete the page.

Functions​

list_wiki_pages()​

list_wiki_pages(project) -> list[dict]

List the project's wiki pages (metadata; the body is omitted).

create_wiki_page()​

create_wiki_page(project, title: str, *, body: str = '') -> WikiPage

Create a wiki page → a WikiPage handle.

get_wiki_page()​

get_wiki_page(project, slug: str) -> WikiPage

Fetch a wiki page by slug → a populated WikiPage handle.

Verified against honeyframeapi 0.1.8.