diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-11-26 09:09:20 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-11-26 09:09:20 +0300 |
| commit | f8bb64721a58ed2fa5a8dceb3743c99fb379ea57 (patch) | |
| tree | ef4175827a2ca7231a1ce3a3d3819bb1561b19df /doc/api/releases | |
| parent | 846ebeb02e405ed42f8a45f34e941c70e3ca2ee3 (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/releases')
| -rw-r--r-- | doc/api/releases/index.md | 6 | ||||
| -rw-r--r-- | doc/api/releases/links.md | 18 |
2 files changed, 12 insertions, 12 deletions
diff --git a/doc/api/releases/index.md b/doc/api/releases/index.md index 7c65e9da74b..321b6fa963f 100644 --- a/doc/api/releases/index.md +++ b/doc/api/releases/index.md @@ -1,7 +1,7 @@ --- stage: Release group: Release Management -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Releases API @@ -365,8 +365,8 @@ POST /projects/:id/releases | `ref` | string | yes, if `tag_name` doesn't exist | If a tag specified in `tag_name` doesn't exist, the release will be created from `ref` and tagged with `tag_name`. It can be a commit SHA, another tag name, or a branch name. | | `milestones` | array of string | no | The title of each milestone the release is associated with. [GitLab Premium](https://about.gitlab.com/pricing/) customers can specify group milestones. | | `assets:links` | array of hash | no | An array of assets links. | -| `assets:links:name`| string | required by: `assets:links` | The name of the link. | -| `assets:links:url` | string | required by: `assets:links` | The URL of the link. | +| `assets:links:name`| string | required by: `assets:links` | The name of the link. Link names must be unique within the release. | +| `assets:links:url` | string | required by: `assets:links` | The URL of the link. Link URLs must be unique within the release. | | `assets:links:filepath` | string | no | Optional path for a [Direct Asset link](../../user/project/releases/index.md#permanent-links-to-release-assets). | `assets:links:link_type` | string | no | The type of the link: `other`, `runbook`, `image`, `package`. Defaults to `other`. | `released_at` | datetime | no | The date when the release will be/was ready. Defaults to the current time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`). | diff --git a/doc/api/releases/links.md b/doc/api/releases/links.md index 2b33f6a4dc7..a2f5c33e44b 100644 --- a/doc/api/releases/links.md +++ b/doc/api/releases/links.md @@ -1,7 +1,7 @@ --- stage: Release group: Release Management -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Release links API @@ -91,14 +91,14 @@ Create an asset as a link from a Release. POST /projects/:id/releases/:tag_name/assets/links ``` -| Attribute | Type | Required | Description | -| ------------- | -------------- | -------- | --------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../README.md#namespaced-path-encoding). | -| `tag_name` | string | yes | The tag associated with the Release. | -| `name` | string | yes | The name of the link. | -| `url` | string | yes | The URL of the link. | -| `filepath` | string | no | Optional path for a [Direct Asset link](../../user/project/releases/index.md#permanent-links-to-release-assets). -| `link_type` | string | no | The type of the link: `other`, `runbook`, `image`, `package`. Defaults to `other`. | +| Attribute | Type | Required | Description | +| ------------- | -------------- | -------- | ---------------------------------------------------------------------------------------------------------------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../README.md#namespaced-path-encoding). | +| `tag_name` | string | yes | The tag associated with the Release. | +| `name` | string | yes | The name of the link. Link names must be unique within the release. | +| `url` | string | yes | The URL of the link. Link URLs must be unique within the release. | +| `filepath` | string | no | Optional path for a [Direct Asset link](../../user/project/releases/index.md#permanent-links-to-release-assets). | +| `link_type` | string | no | The type of the link: `other`, `runbook`, `image`, `package`. Defaults to `other`. | Example request: |