diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-06-03 15:10:18 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-06-03 15:10:18 +0300 |
| commit | f5987db869d7025fb8f403edc5106c5f2a3e448f (patch) | |
| tree | 804c2c04e607f8d5010be1541fac4e325b9d116a /doc/api/releases | |
| parent | e5f183140340a76754af3beabff0fcd74212a102 (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/releases')
| -rw-r--r-- | doc/api/releases/index.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/api/releases/index.md b/doc/api/releases/index.md index cedaf3c85fb..0cbf613c598 100644 --- a/doc/api/releases/index.md +++ b/doc/api/releases/index.md @@ -10,7 +10,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w > - Using this API you can manipulate GitLab [Release](../../user/project/releases/index.md) entries. > - For manipulating links as a release asset, see [Release Links API](links.md). > - Release Evidences were [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/26019) in GitLab 12.5. -> - `description_html` field was [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/299447) in GitLab 13.12. +> - `description_html` became an opt-in field [with GitLab 13.12 for performance reasons](https://gitlab.com/gitlab-org/gitlab/-/issues/299447). + Please pass the `include_html_description` query string parameter if you need it. ## List Releases @@ -25,6 +26,7 @@ GET /projects/:id/releases | `id` | integer/string | yes | The ID or [URL-encoded path of the project](../README.md#namespaced-path-encoding). | | `order_by` | string | no | The field to use as order. Either `released_at` (default) or `created_at`. | | `sort` | string | no | The direction of the order. Either `desc` (default) for descending order or `asc` for ascending order. | +| `include_html_description` | boolean | no | If `true`, a response includes HTML rendered Markdown of the release description. | Example request: @@ -228,6 +230,7 @@ GET /projects/:id/releases/:tag_name | ------------- | -------------- | -------- | ----------------------------------------------------------------------------------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](../README.md#namespaced-path-encoding). | | `tag_name` | string | yes | The Git tag the release is associated with. | +| `include_html_description` | boolean | no | If `true`, a response includes HTML rendered Markdown of the release description. | Example request: |