summaryrefslogtreecommitdiff
path: root/doc/api/wikis.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/wikis.md')
-rw-r--r--doc/api/wikis.md24
1 files changed, 18 insertions, 6 deletions
diff --git a/doc/api/wikis.md b/doc/api/wikis.md
index fb49e9465bc..b7c9d0d6008 100644
--- a/doc/api/wikis.md
+++ b/doc/api/wikis.md
@@ -6,6 +6,10 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# 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.
@@ -34,18 +38,21 @@ Example response:
"content" : "Here is an instruction how to deploy this project.",
"format" : "markdown",
"slug" : "deploy",
- "title" : "deploy"
+ "title" : "deploy",
+ "encoding": "UTF-8"
},
{
"content" : "Our development process is described here.",
"format" : "markdown",
"slug" : "development",
- "title" : "development"
+ "title" : "development",
+ "encoding": "UTF-8"
},{
"content" : "* [Deploy](deploy)\n* [Development](development)",
"format" : "markdown",
"slug" : "home",
- "title" : "home"
+ "title" : "home",
+ "encoding": "UTF-8"
}
]
```
@@ -62,6 +69,8 @@ GET /projects/:id/wikis/:slug
| --------- | ------- | -------- | --------------------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) |
| `slug` | string | yes | URLencoded 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"
@@ -74,7 +83,8 @@ Example response:
"content" : "home page",
"format" : "markdown",
"slug" : "home",
- "title" : "home"
+ "title" : "home",
+ "encoding": "UTF-8"
}
```
@@ -105,7 +115,8 @@ Example response:
"content" : "Hello world",
"format" : "markdown",
"slug" : "Hello",
- "title" : "Hello"
+ "title" : "Hello",
+ "encoding": "UTF-8"
}
```
@@ -137,7 +148,8 @@ Example response:
"content" : "documentation",
"format" : "markdown",
"slug" : "Docs",
- "title" : "Docs"
+ "title" : "Docs",
+ "encoding": "UTF-8"
}
```