diff options
| author | blackst0ne <blackst0ne.ru@gmail.com> | 2018-05-15 03:22:35 +0300 |
|---|---|---|
| committer | blackst0ne <blackst0ne.ru@gmail.com> | 2018-05-18 02:02:21 +0300 |
| commit | fffac29fb0c3bc8d48c81142f5415e0b3cd8366d (patch) | |
| tree | 5833c8c2ac60a8d680702d31a5eebe73646c4d60 | |
| parent | 7bd39c8a60c6ad91a791259a74464561d22c6679 (diff) | |
Update docs [ci skip]
| -rw-r--r-- | doc/api/markdown.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api/markdown.md b/doc/api/markdown.md index 16104f13d73..08628ed52d8 100644 --- a/doc/api/markdown.md +++ b/doc/api/markdown.md @@ -13,8 +13,8 @@ POST /api/v4/markdown | Attribute | Type | Required | Description | | --------- | ------- | ------------- | ------------------------------------------ | | `text` | string | yes | The markdown text to render | -| `gfm` | boolean | no (optional) | Render text using GitLab Flavored Markdown | -| `project` | string | no (optional) | The full path of a project to use as the context when creating references using GitLab Flavored Markdown | +| `gfm` | boolean | no (optional) | Render text using GitLab Flavored Markdown (default: `false`) | +| `project` | string | no if `gfm` is false<br>yes if `gfm` is true | The full path of a project to use as the context when creating references using GitLab Flavored Markdown | ```bash curl -H Content-Type:application/json -d '{"text":"Hello world! :tada:", "gfm":true, "project":"group_example/project_example"}' https://gitlab.example.com/api/v4/markdown |