summaryrefslogtreecommitdiff
path: root/doc/api/group_wikis.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/group_wikis.md')
-rw-r--r--doc/api/group_wikis.md25
1 files changed, 18 insertions, 7 deletions
diff --git a/doc/api/group_wikis.md b/doc/api/group_wikis.md
index 4af907bd387..a78f989a755 100644
--- a/doc/api/group_wikis.md
+++ b/doc/api/group_wikis.md
@@ -7,7 +7,10 @@ type: reference, api
# Group wikis API **(PREMIUM)**
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/212199) in GitLab 13.5.
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/212199) in GitLab 13.5.
+> - 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 [group wikis](../user/project/wiki/group.md) API is available only in APIv4.
An API for [project wikis](wikis.md) is also available.
@@ -37,18 +40,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"
}
]
```
@@ -65,6 +71,8 @@ GET /groups/:id/wikis/:slug
| --------- | ------- | -------- | --------------------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](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/groups/1/wikis/home"
@@ -77,7 +85,8 @@ Example response:
"content" : "home page",
"format" : "markdown",
"slug" : "home",
- "title" : "home"
+ "title" : "home",
+ "encoding": "UTF-8"
}
```
@@ -109,7 +118,8 @@ Example response:
"content" : "Hello world",
"format" : "markdown",
"slug" : "Hello",
- "title" : "Hello"
+ "title" : "Hello",
+ "encoding": "UTF-8"
}
```
@@ -142,7 +152,8 @@ Example response:
"content" : "documentation",
"format" : "markdown",
"slug" : "Docs",
- "title" : "Docs"
+ "title" : "Docs",
+ "encoding": "UTF-8"
}
```