diff options
| author | Mark Fletcher <mark@gitlab.com> | 2017-09-28 10:54:19 +0700 |
|---|---|---|
| committer | Mark Fletcher <mark@gitlab.com> | 2017-09-28 10:54:19 +0700 |
| commit | 3c26326e71d532455bb91ea84611942b0de6cd3c (patch) | |
| tree | 1f33a45d74d6c2d2ad42b6bee29dee828ee28c73 | |
| parent | 92173ac55cd921a65ce137e238ed8bc4474aaccb (diff) | |
| download | gitlab-ce-3c26326e71d532455bb91ea84611942b0de6cd3c.tar.gz | |
Clarify artifact download via the API only accepts branch or tag name for ref
| -rw-r--r-- | changelogs/unreleased/docs-28814-clarify-artifacts-ref.yml | 5 | ||||
| -rw-r--r-- | doc/api/jobs.md | 2 |
2 files changed, 6 insertions, 1 deletions
diff --git a/changelogs/unreleased/docs-28814-clarify-artifacts-ref.yml b/changelogs/unreleased/docs-28814-clarify-artifacts-ref.yml new file mode 100644 index 00000000000..3cdcff8caaf --- /dev/null +++ b/changelogs/unreleased/docs-28814-clarify-artifacts-ref.yml @@ -0,0 +1,5 @@ +--- +title: Clarify artifact download via the API only accepts branch or tag name for ref +merge_request: +author: +type: other diff --git a/doc/api/jobs.md b/doc/api/jobs.md index d60c7c12881..e7060e154f4 100644 --- a/doc/api/jobs.md +++ b/doc/api/jobs.md @@ -336,7 +336,7 @@ Parameters | Attribute | Type | Required | Description | |-------------|---------|----------|-------------------------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `ref_name` | string | yes | The ref from a repository | +| `ref_name` | string | yes | The ref from a repository (can only be branch or tag name, not HEAD or SHA) | | `job` | string | yes | The name of the job | Example request: |