Skip to content

Latest commit

 

History

History
169 lines (114 loc) · 5.68 KB

File metadata and controls

169 lines (114 loc) · 5.68 KB

Wiki

Project and group wiki page CRUD. Attachment uploads where supported.

!!! note "Feature toggle" Opt-in. Enable via GITLAB_TOOLSETS=wiki (or GITLAB_TOOLSETS=all), or use the legacy USE_GITLAB_WIKI=true flag for backward compatibility.

Tools in this group


list_wiki_pages

📖 Read-only

List wiki pages in a project

Parameters

Parameter Type Required Description
project_id string Project ID or URL-encoded path
with_content boolean Include content of the wiki pages
render_html boolean Return rendered HTML content and include front_matter (e.g., the custom title)
page number Page number for pagination (default: 1)
per_page number Number of items per page (max: 100, default: 20)

get_wiki_page

📖 Read-only

Get details of a specific wiki page

Parameters

Parameter Type Required Description
project_id string Project ID or URL-encoded path
slug string Slug of the wiki page (will be URL-encoded internally)
render_html boolean Return rendered HTML content and include front_matter (e.g., the custom title)

create_wiki_page

✏️ Writes

Create a wiki page in a project

Parameters

Parameter Type Required Description
project_id string Project ID or URL-encoded path
title string Title of the wiki page
content string Content of the wiki page
format string Content format, e.g., markdown, rdoc

update_wiki_page

✏️ Writes

Update a wiki page in a project

Parameters

Parameter Type Required Description
project_id string Project ID or URL-encoded path
slug string Slug of the wiki page (will be URL-encoded internally)
title string New title of the wiki page. WARNING: setting this renames the page and changes its slug/URL (for nested pages it can also move the page to a different path), which breaks existing links. To change only the displayed title while keeping the URL, omit this parameter and instead set a title: field in the content's YAML front matter.
content string New content of the wiki page
format string Content format, e.g., markdown, rdoc

delete_wiki_page

✏️ Writes

Delete a wiki page from a project

Parameters

Parameter Type Required Description
project_id string Project ID or URL-encoded path
slug string Slug of the wiki page (will be URL-encoded internally)

list_group_wiki_pages

📖 Read-only

List wiki pages in a group

Parameters

Parameter Type Required Description
group_id string Group ID or URL-encoded path
with_content boolean Include content of the wiki pages
render_html boolean Return rendered HTML content and include front_matter (e.g., the custom title)
page number Page number for pagination (default: 1)
per_page number Number of items per page (max: 100, default: 20)

get_group_wiki_page

📖 Read-only

Get details of a specific group wiki page

Parameters

Parameter Type Required Description
group_id string Group ID or URL-encoded path
slug string Slug of the wiki page (will be URL-encoded internally)
render_html boolean Return rendered HTML content and include front_matter (e.g., the custom title)

create_group_wiki_page

✏️ Writes

Create a wiki page in a group

Parameters

Parameter Type Required Description
group_id string Group ID or URL-encoded path
title string Title of the wiki page
content string Content of the wiki page
format string Content format, e.g., markdown, rdoc

update_group_wiki_page

✏️ Writes

Update a wiki page in a group

Parameters

Parameter Type Required Description
group_id string Group ID or URL-encoded path
slug string Slug of the wiki page (will be URL-encoded internally)
title string New title of the wiki page. WARNING: setting this renames the page and changes its slug/URL (for nested pages it can also move the page to a different path), which breaks existing links. To change only the displayed title while keeping the URL, omit this parameter and instead set a title: field in the content's YAML front matter.
content string New content of the wiki page
format string Content format, e.g., markdown, rdoc

delete_group_wiki_page

✏️ Writes

Delete a wiki page from a group

Parameters

Parameter Type Required Description
group_id string Group ID or URL-encoded path
slug string Slug of the wiki page (will be URL-encoded internally)