# Feature OP-19736 - API v3: expose wiki page content and support list/create/update for wiki pages

Project: OpenProject
Status: new
URL: https://community.openproject.org/work_packages/OP-19736

## Planning

| Attribute | Value |
| --- | --- |
| Date |  |
| Priority | Medium |
| Target versions | Wish List |
| Sprint |  |
| Backlog bucket |  |
| Votes | 1 |
| List |  |
| Roadmap |  |
| Relevance |  |

## OPEN POINTS / FEEDBACK

_No work packages_

## Features and Chunks

_No work packages_

## Bugs and other work packages

_No work packages_

## Technical Details

| Attribute | Value |
| --- | --- |
| Module | API, Modules and project features / Wiki |
| Feature Flag |  |
| Requires doc change | No |
| Enterprise plan |  |

## Details

| Attribute | Value |
| --- | --- |
| Pull preview |  |
| Mockups |  |
| Accessibility | No |

## People

| Attribute | Value |
| --- | --- |
| Assignee |  |
| Accountable |  |
| Product manager |  |
| Feature Lead |  |
| Developers |  |
| Designer |  |
| Ordered by |  |
| Signed off by |  |
| Interest by |  |

## Estimates and progress

| Attribute | Value |
| --- | --- |
| PD (min) |  |
| PD (max) |  |
| Work |  |
| Labor costs |  |

## Description

**As a** developer building an integration on the OpenProject API v3  
**I want to** read a wiki page&#x27;s content and list, create, and update wiki pages through the API v3  
**so that** project wikis can be maintained programmatically and kept in sync with other systems, not only through the web UI.

**Acceptance criteria**

*   `GET /api/v3/wiki_pages/{id}` returns the page **body** as a formattable text field (`text: {format, raw, html}`), in addition to `id`/`title`/`_links`.
    
*   A **listing** endpoint exists, e.g. `GET /api/v3/projects/{id}/wiki_pages` (and/or a filterable `GET /api/v3/wiki_pages`), returning `id`, `title`, `slug` per page.
    
*   **Create** supported: `POST /api/v3/projects/{id}/wiki_pages` (or `POST /api/v3/wiki_pages`) with `{title, text: {format, raw}, parent link}`.
    
*   **Update** supported: `PATCH /api/v3/wiki_pages/{id}` with `lockVersion` + `title`/`text` (optimistic locking, as for work packages).
    
*   Parent/child placement settable via a `parent` link on create/update.
    
*   All operations respect existing wiki permissions and return proper `403`/`404`.
    

**Technical notes**

*   Today (Core 17.5.1) the v3 API exposes only `GET /api/v3/wiki_pages/{id}` and `GET|POST /api/v3/wiki_pages/{id}/attachments`. `Wiki_PageModel` = `{id, title, _links}` — no `text`/body and no `lockVersion`; there is no `wiki_pages` collection and no project→wiki link, so pages can&#x27;t be listed/discovered and their content can&#x27;t be read via the API.
    
*   Attachments already work (`GET|POST /wiki_pages/{id}/attachments`), so the resource and permission plumbing exist — this request is about exposing page **content**, **CRUD**, and **listing**.
    
*   Reuse the existing formattable-text pattern (work package `description`, news): `text: {format: "markdown", raw: "..."}`, and the same optimistic-locking (`lockVersion`) convention used for work packages.
    

**Permissions and visibility considerations**

**To whom is this feature visible?**

*   Users and API tokens holding the project&#x27;s wiki permissions: &quot;view wiki pages&quot; (read/list/content) and &quot;edit/manage wiki&quot; (create/update) — the same permission model as the web UI.
    

**When is it not visible?**

*   When the wiki module is disabled on the project, or the user/token lacks the relevant permission — the API should then return `403`/`404` accordingly, consistent with other resources.
    

**Translation considerations**

**Key terms and phrases in the key languages**

<figure class="table op-uc-figure_align-center op-uc-figure"><table class="op-uc-table" style="background-color:rgb(243, 243, 243);border:0.833333px solid rgba(97, 97, 97, 0.2);"><thead class="op-uc-table--head"><tr class="op-uc-table--row"><th class="op-uc-table--cell op-uc-table--cell_head" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">English</p></th><th class="op-uc-table--cell op-uc-table--cell_head" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Deutsch</p></th><th class="op-uc-table--cell op-uc-table--cell_head" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Français</p></th><th class="op-uc-table--cell op-uc-table--cell_head" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Español</p></th></tr></thead><tbody><tr class="op-uc-table--row"><td class="op-uc-table--cell" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Wiki page</p></td><td class="op-uc-table--cell" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Wiki-Seite</p></td><td class="op-uc-table--cell" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Page wiki</p></td><td class="op-uc-table--cell" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Página wiki</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Content / text</p></td><td class="op-uc-table--cell" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Inhalt / Text</p></td><td class="op-uc-table--cell" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Contenu / texte</p></td><td class="op-uc-table--cell" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Contenido / texto</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Parent page</p></td><td class="op-uc-table--cell" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Übergeordnete Seite</p></td><td class="op-uc-table--cell" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Page parente</p></td><td class="op-uc-table--cell" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Página superior</p></td></tr><tr class="op-uc-table--row"><td class="op-uc-table--cell" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Slug</p></td><td class="op-uc-table--cell" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Titel-Kürzel (Slug)</p></td><td class="op-uc-table--cell" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Identifiant (slug)</p></td><td class="op-uc-table--cell" style="border-color:rgba(97, 97, 97, 0.2);border-width:0.833333px;padding:2px;"><p class="op-uc-p">Identificador (slug)</p></td></tr></tbody></table></figure>

*   `lockVersion` is a technical API field name and stays untranslated (as elsewhere in the API). No new user-facing strings are introduced beyond already-localized wiki/permission/error messages.
    

**Out of scope**

*   WYSIWYG/rich-text editor specifics; hierarchy reorganization beyond a `parent` link; HTML-rendering changes; any browser/HTML-scraping workaround.
    

_Set the To be informed/consulted teams field to include all teams necessary to be informed of the changes._

**Additional context — current API state (feasibility evidence)**

A read-only probe against a live instance (**OpenProject Core 17.5.1**, using its own `/api/v3/spec.json` plus live `GET`s) established the exact gap this request addresses:

*   Wiki API surface = **only** `GET /api/v3/wiki_pages/{id}` and `GET|POST /api/v3/wiki_pages/{id}/attachments`.
    
*   No create/update/delete for wiki pages (absent from the spec; page `_links` expose no update/delete).
    
*   No listing: `GET /api/v3/wiki_pages` → 404; `GET /api/v3/projects/{id}/wiki_pages` → 404; the project resource exposes no wiki link.
    
*   No page body: `Wiki_PageModel` = `{id, title, _links}`; a live `GET /wiki_pages/{id}` returns title + project + attachments only — no `text` content, no `lockVersion`.
    
*   Working today: page metadata by numeric id, and attachment list/upload/download.
