diff options
| author | Filipa Lacerda <filipa@gitlab.com> | 2018-05-18 17:25:24 +0100 |
|---|---|---|
| committer | Filipa Lacerda <filipa@gitlab.com> | 2018-05-18 17:25:24 +0100 |
| commit | 7f0f8594d3e5cbee41771c476e3b7496946db300 (patch) | |
| tree | 1981c15675409386908b3b05d4f1aa75b1755957 /doc/api | |
| parent | 068186555cb85e85bbfe04afe858fb3eb4801207 (diff) | |
| parent | 8bacfbd1cc4f6c3678d50dd516df2b59eb0c8864 (diff) | |
| download | gitlab-ce-5845-extract-ee-environments-files.tar.gz | |
Merge branch 'master' into 5845-extract-ee-environments-files5845-extract-ee-environments-files
* master: (69 commits)
Calculating repository checksums executed by Gitaly
Resolve "Expand API: Render an arbitrary Markdown document"
Update EE > CE downgrade service removal steps
Make stores export a createStore() which can be used in tests
Simplify pattern lexeme fabrication and matcher
Simplify untrusted regexp factory method
Fix api_json.log not always reporting the right HTTP status code
Move group lists css from framework/lists.scss to pages/groups.scss
Resolve "Web IDE: Previewing Markdown in Firefox doesn’t show a scroll bar"
Add Keyboard shortcuts for "Kubernetes" and "Environments"
Move API group deletion to Sidekiq
fix typos. add a reference to deliverable and stretch for design artifact
fix / assigne username wrapping problem has been fixed
Memoize Gitlab::Database.version
Conditionally add Gitaly deprecation warnings based on ENV variable
Bring CE-EE parity to app/services/milestones/base_service.rb
Bring CE-EE parity to app/services/lfs/unlock_file_service.rb
Fixes 500 error on /estimate BIG_VALUE
Fix: Use case in-sensitive ordering by name for groups
Fix group lists visual
...
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/README.md | 1 | ||||
| -rw-r--r-- | doc/api/groups.md | 3 | ||||
| -rw-r--r-- | doc/api/markdown.md | 29 |
3 files changed, 33 insertions, 0 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index e777fc63d2b..194907accc7 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -33,6 +33,7 @@ following locations: - [Jobs](jobs.md) - [Keys](keys.md) - [Labels](labels.md) +- [Markdown](markdown.md) - [Merge Requests](merge_requests.md) - [Project milestones](milestones.md) - [Group milestones](group_milestones.md) diff --git a/doc/api/groups.md b/doc/api/groups.md index 923fd662a5b..96842ef330f 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -487,6 +487,9 @@ Parameters: - `id` (required) - The ID or path of a user group +This will queue a background job to delete all projects in the group. The +response will be a 202 Accepted if the user has authorization. + ## Search for group Get all groups that match your string in their name or path. diff --git a/doc/api/markdown.md b/doc/api/markdown.md new file mode 100644 index 00000000000..f406838e887 --- /dev/null +++ b/doc/api/markdown.md @@ -0,0 +1,29 @@ +# Markdown API + +> [Introduced][ce-18926] in GitLab 11.0. + +Available only in APIv4. + +## Render an arbitrary Markdown document + +``` +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. Default is `false` | +| `project` | string | no (optional) | Use `project` as a context when creating references using GitLab Flavored Markdown. [Authentication](README.html#authentication) is required if a project is not public. | + +```bash +curl --header Content-Type:application/json --data '{"text":"Hello world! :tada:", "gfm":true, "project":"group_example/project_example"}' https://gitlab.example.com/api/v4/markdown +``` + +Response example: + +```json +{ "html": "<p dir=\"auto\">Hello world! <gl-emoji title=\"party popper\" data-name=\"tada\" data-unicode-version=\"6.0\">🎉</gl-emoji></p>" } +``` + +[ce-18926]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/18926 |