summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGrzegorz Bizon <grzegorz@gitlab.com>2017-09-28 11:37:21 +0000
committerGrzegorz Bizon <grzegorz@gitlab.com>2017-09-28 11:37:21 +0000
commite0e49f2f7120fee6ee34236ed6463e4c130f2ad1 (patch)
tree1a23ce5e3290bdc4253e4511e3dd8479e6ee8141
parent7689c3ec88eab153a1b4d8e6f8ac45df35231e1e (diff)
parent3c26326e71d532455bb91ea84611942b0de6cd3c (diff)
downloadgitlab-ce-e0e49f2f7120fee6ee34236ed6463e4c130f2ad1.tar.gz
Merge branch 'docs-28814-clarify-artifacts-ref' into 'master'
Clarify artifact download via the API only accepts branch or tag name for ref See merge request gitlab-org/gitlab-ce!14545
-rw-r--r--changelogs/unreleased/docs-28814-clarify-artifacts-ref.yml5
-rw-r--r--doc/api/jobs.md2
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: