diff options
Diffstat (limited to 'doc/api/releases')
| -rw-r--r-- | doc/api/releases/index.md | 10 | ||||
| -rw-r--r-- | doc/api/releases/links.md | 10 |
2 files changed, 15 insertions, 5 deletions
diff --git a/doc/api/releases/index.md b/doc/api/releases/index.md index c603be9489c..6023adb79d0 100644 --- a/doc/api/releases/index.md +++ b/doc/api/releases/index.md @@ -53,7 +53,7 @@ Example response: [ { "tag_name":"v0.2", - "description":"## CHANGELOG\r\n\r\n- Escape label and milestone titles to prevent XSS in GFM autocomplete. !2740\r\n- Prevent private snippets from being embeddable.\r\n- Add subresources removal to member destroy service.", + "description":"## CHANGELOG\r\n\r\n- Escape label and milestone titles to prevent XSS in GLFM autocomplete. !2740\r\n- Prevent private snippets from being embeddable.\r\n- Add subresources removal to member destroy service.", "name":"Awesome app v0.2 beta", "created_at":"2019-01-03T01:56:19.539Z", "released_at":"2019-01-03T01:56:19.539Z", @@ -241,10 +241,10 @@ Get a Release for the given tag. GET /projects/:id/releases/:tag_name ``` -| Attribute | Type | Required | Description | -| ------------- | -------------- | -------- | ----------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../index.md#namespaced-path-encoding). | -| `tag_name` | string | yes | The Git tag the release is associated with. | +| Attribute | Type | Required | Description | +|----------------------------| -------------- | -------- | ----------------------------------------------------------------------------------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../index.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: diff --git a/doc/api/releases/links.md b/doc/api/releases/links.md index 282ef0adc78..66808900ab6 100644 --- a/doc/api/releases/links.md +++ b/doc/api/releases/links.md @@ -11,6 +11,16 @@ links. For manipulating other Release assets, see [Release API](index.md). GitLab supports links to `http`, `https`, and `ftp` assets. +## Authentication + +For authentication, the Release Links API accepts: + +- A [Personal Access Token](../../user/profile/personal_access_tokens.md) using the + `PRIVATE-TOKEN` header. +- A [Project Access Token](../../user/project/settings/project_access_tokens.md) using the `PRIVATE-TOKEN` header. + +The [GitLab CI/CD job token](../../ci/jobs/ci_job_token.md) `$CI_JOB_TOKEN` is not supported. See [GitLab issue #50819](https://gitlab.com/gitlab-org/gitlab/-/issues/250819) for more details. + ## Get links Get assets as links from a Release. |