Fix wiki docs to send the page slug url encoded

0a5bdc1b · Francisco Javier López · Amy Qualls · 1e97ffdd · 0a5bdc1b · 0a5bdc1b
Commit 0a5bdc1b authored Jun 01, 2021 by Francisco Javier López Committed by Amy Qualls Jun 01, 2021
Hide whitespace changes
Inline Side-by-side

Showing with 6 additions and 6 deletions

doc/api/group_wikis.md doc/api/group_wikis.md +3 -3

doc/api/wikis.md doc/api/wikis.md +3 -3

No files found.
--- a/doc/api/group_wikis.md
+++ b/doc/api/group_wikis.md
@@ -64,7 +64,7 @@ GET /groups/:id/wikis/:slug
 | Attribute | Type           | Required | Description                                                                   |
 | --------- | -------        | -------- | ---------------------                                                         |
 | `id`      | integer/string | yes      | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) |
-| `slug`    | string         | yes      | The slug (a unique string) of the wiki page                                   |
+| `slug`    | string         | yes      | URL-encoded slug (a unique string) of the wiki page, such as `dir%2Fpage_name`      |

 ```shell
 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/wikis/home"
@@ -127,7 +127,7 @@ PUT /groups/:id/wikis/:slug
 | `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                               | The slug (a unique identifier) of the wiki page                                                        |
+| `slug`          | string         | yes                               | URL encoded slug (a unique string) of the wiki page. Ex. dir%2Fpage_name                                                        |

 ```shell
 curl --request PUT --data "format=rdoc&content=documentation&title=Docs" \
@@ -157,7 +157,7 @@ DELETE /groups/:id/wikis/:slug
 | Attribute | Type           | Required | Description                                                                   |
 | --------- | -------        | -------- | ---------------------                                                         |
 | `id`      | integer/string | yes      | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) |
-| `slug`    | string         | yes      | The slug (a unique identifier) of the wiki page                               |
+| `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/groups/1/wikis/foo"

--- a/doc/api/wikis.md
+++ b/doc/api/wikis.md
@@ -64,7 +64,7 @@ GET /projects/:id/wikis/:slug
 | Attribute | Type    | Required | Description           |
 | --------- | ------- | -------- | --------------------- |
 | `id`      | integer/string    | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
-| `slug` | string  | yes       | The slug (a unique string) of the wiki page |
+| `slug` | string  | yes       | URLencoded slug (a unique string) of the wiki page, such as `dir%2Fpage_name`  |

 ```shell
 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/wikis/home"
@@ -125,7 +125,7 @@ PUT /projects/:id/wikis/:slug
 | `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       | The slug (a unique string) of the wiki page |
+| `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"
@@ -153,7 +153,7 @@ DELETE /projects/:id/wikis/:slug
 | Attribute | Type    | Required | Description           |
 | --------- | ------- | -------- | --------------------- |
 | `id`      | integer/string    | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
-| `slug` | string  | yes       | The slug (a unique string) of the wiki page |
+| `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"