212 lines
7 KiB
Markdown
212 lines
7 KiB
Markdown
---
|
|
stage: Create
|
|
group: Editor
|
|
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
|
---
|
|
|
|
# Project wikis API **(FREE)**
|
|
|
|
> - The `encoding` field was [added](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/81150) in GitLab 14.9.
|
|
> - The `render_html` attribute was [added](https://gitlab.com/gitlab-org/gitlab/-/issues/336792) in GitLab 14.9.
|
|
> - The `version` attribute was [added](https://gitlab.com/gitlab-org/gitlab/-/issues/336792) in GitLab 14.9.
|
|
|
|
The project [wikis](../user/project/wiki/index.md) API is available only in APIv4.
|
|
An API for [group wikis](group_wikis.md) is also available.
|
|
|
|
## List wiki pages
|
|
|
|
Get all wiki pages for a given project.
|
|
|
|
```plaintext
|
|
GET /projects/:id/wikis
|
|
```
|
|
|
|
| Attribute | Type | Required | Description |
|
|
| --------- | ------- | -------- | --------------------- |
|
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) |
|
|
| `with_content` | boolean | no | Include pages' content |
|
|
|
|
```shell
|
|
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/wikis?with_content=1"
|
|
```
|
|
|
|
Example response:
|
|
|
|
```json
|
|
[
|
|
{
|
|
"content" : "Here is an instruction how to deploy this project.",
|
|
"format" : "markdown",
|
|
"slug" : "deploy",
|
|
"title" : "deploy",
|
|
"encoding": "UTF-8"
|
|
},
|
|
{
|
|
"content" : "Our development process is described here.",
|
|
"format" : "markdown",
|
|
"slug" : "development",
|
|
"title" : "development",
|
|
"encoding": "UTF-8"
|
|
},{
|
|
"content" : "* [Deploy](deploy)\n* [Development](development)",
|
|
"format" : "markdown",
|
|
"slug" : "home",
|
|
"title" : "home",
|
|
"encoding": "UTF-8"
|
|
}
|
|
]
|
|
```
|
|
|
|
## Get a wiki page
|
|
|
|
Get a wiki page for a given project.
|
|
|
|
```plaintext
|
|
GET /projects/:id/wikis/:slug
|
|
```
|
|
|
|
| Attribute | Type | Required | Description |
|
|
| --------- | ------- | -------- | --------------------- |
|
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) |
|
|
| `slug` | string | yes | URL encoded slug (a unique string) of the wiki page, such as `dir%2Fpage_name` |
|
|
| `render_html` | boolean | no | Return the rendered HTML of the wiki page |
|
|
| `version` | string | no | Wiki page version SHA |
|
|
|
|
```shell
|
|
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/wikis/home"
|
|
```
|
|
|
|
Example response:
|
|
|
|
```json
|
|
{
|
|
"content" : "home page",
|
|
"format" : "markdown",
|
|
"slug" : "home",
|
|
"title" : "home",
|
|
"encoding": "UTF-8"
|
|
}
|
|
```
|
|
|
|
## Create a new wiki page
|
|
|
|
Creates a new wiki page for the given repository with the given title, slug, and content.
|
|
|
|
```plaintext
|
|
POST /projects/:id/wikis
|
|
```
|
|
|
|
| Attribute | Type | Required | Description |
|
|
| ------------- | ------- | -------- | ---------------------------- |
|
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) |
|
|
| `content` | string | yes | The content of the wiki page |
|
|
| `title` | string | yes | The title of the wiki page |
|
|
| `format` | string | no | The format of the wiki page. Available formats are: `markdown` (default), `rdoc`, `asciidoc` and `org` |
|
|
|
|
```shell
|
|
curl --data "format=rdoc&title=Hello&content=Hello world" \
|
|
--header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/wikis"
|
|
```
|
|
|
|
Example response:
|
|
|
|
```json
|
|
{
|
|
"content" : "Hello world",
|
|
"format" : "markdown",
|
|
"slug" : "Hello",
|
|
"title" : "Hello",
|
|
"encoding": "UTF-8"
|
|
}
|
|
```
|
|
|
|
## Edit an existing wiki page
|
|
|
|
Updates an existing wiki page. At least one parameter is required to update the wiki page.
|
|
|
|
```plaintext
|
|
PUT /projects/:id/wikis/:slug
|
|
```
|
|
|
|
| Attribute | Type | Required | Description |
|
|
| --------------- | ------- | --------------------------------- | ------------------------------- |
|
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) |
|
|
| `content` | string | yes if `title` is not provided | The content of the wiki page |
|
|
| `title` | string | yes if `content` is not provided | The title of the wiki page |
|
|
| `format` | string | no | The format of the wiki page. Available formats are: `markdown` (default), `rdoc`, `asciidoc` and `org` |
|
|
| `slug` | string | yes | URL-encoded slug (a unique string) of the wiki page, such as `dir%2Fpage_name` |
|
|
|
|
```shell
|
|
curl --request PUT --data "format=rdoc&content=documentation&title=Docs" \
|
|
--header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/wikis/foo"
|
|
```
|
|
|
|
Example response:
|
|
|
|
```json
|
|
{
|
|
"content" : "documentation",
|
|
"format" : "markdown",
|
|
"slug" : "Docs",
|
|
"title" : "Docs",
|
|
"encoding": "UTF-8"
|
|
}
|
|
```
|
|
|
|
## Delete a wiki page
|
|
|
|
Deletes a wiki page with a given slug.
|
|
|
|
```plaintext
|
|
DELETE /projects/:id/wikis/:slug
|
|
```
|
|
|
|
| Attribute | Type | Required | Description |
|
|
| --------- | ------- | -------- | --------------------- |
|
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) |
|
|
| `slug` | string | yes | URL-encoded slug (a unique string) of the wiki page, such as `dir%2Fpage_name` |
|
|
|
|
```shell
|
|
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/wikis/foo"
|
|
```
|
|
|
|
On success the HTTP status code is `204` and no JSON response is expected.
|
|
|
|
## Upload an attachment to the wiki repository
|
|
|
|
Uploads a file to the attachment folder inside the wiki's repository. The
|
|
attachment folder is the `uploads` folder.
|
|
|
|
```plaintext
|
|
POST /projects/:id/wikis/attachments
|
|
```
|
|
|
|
| Attribute | Type | Required | Description |
|
|
| ------------- | ------- | -------- | ---------------------------- |
|
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) |
|
|
| `file` | string | yes | The attachment to be uploaded |
|
|
| `branch` | string | no | The name of the branch. Defaults to the wiki repository default branch |
|
|
|
|
To upload a file from your file system, use the `--form` argument. This causes
|
|
cURL to post data using the header `Content-Type: multipart/form-data`.
|
|
The `file=` parameter must point to a file on your file system and be preceded
|
|
by `@`. For example:
|
|
|
|
```shell
|
|
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
|
|
--form "file=@dk.png" "https://gitlab.example.com/api/v4/projects/1/wikis/attachments"
|
|
```
|
|
|
|
Example response:
|
|
|
|
```json
|
|
{
|
|
"file_name" : "dk.png",
|
|
"file_path" : "uploads/6a061c4cf9f1c28cb22c384b4b8d4e3c/dk.png",
|
|
"branch" : "master",
|
|
"link" : {
|
|
"url" : "uploads/6a061c4cf9f1c28cb22c384b4b8d4e3c/dk.png",
|
|
"markdown" : ""
|
|
}
|
|
}
|
|
```
|