summaryrefslogtreecommitdiff
path: root/doc/api/jobs.md
diff options
context:
space:
mode:
authorLin Jen-Shin <godfat@godfat.org>2018-04-03 19:50:28 +0800
committerLin Jen-Shin <godfat@godfat.org>2018-04-03 19:50:28 +0800
commit1fe57d3f01f8fc7a6f0f71e63d0562512d1e5506 (patch)
tree0f1945a23ccb3fa5b2aee255f24cab2d314cc798 /doc/api/jobs.md
parent437f59c2fe326552f27fc13289cb2b727f173baa (diff)
parent98278abd590198832c09445ee69df4df6cd006a2 (diff)
downloadgitlab-ce-1fe57d3f01f8fc7a6f0f71e63d0562512d1e5506.tar.gz
Merge remote-tracking branch 'upstream/master' into qa-add-more-key-tests
* upstream/master: (147 commits) Replace the `project/issues/issues.feature` spinach test with an rspec analog [Rails5] Isolate `test_after_commit` gem backport missing object storage worker specs Resolve "Clicking confidential and lock icons on sidebar should also activate dropdown" Add button type to settings toggle Move Sidekiq exporter logs to log/sidekiq_exporter.log Rename allow_private_networks to allow_local_network Make error messages even more descriptive Added rescue to show a custom error when testing project integrations Raise more descriptive errors when URLs are blocked Backport changes in EE MR 4972: System Header and Footer Adds validators and rack cookie helper apply feedback add changelog fix the rake task from being to strict about Group Bump html-pipeline to 2.7.1 Update docs for API for issue and merge request description templates Add pagination docs to commit status API Update brakeman 3.6.1 to 4.2.1 Handle CR-LFs properly in .gitmodules file ...
Diffstat (limited to 'doc/api/jobs.md')
-rw-r--r--doc/api/jobs.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/doc/api/jobs.md b/doc/api/jobs.md
index e7060e154f4..db4fe2f6880 100644
--- a/doc/api/jobs.md
+++ b/doc/api/jobs.md
@@ -294,9 +294,10 @@ Example of response
## Get job artifacts
-> [Introduced][ce-2893] in GitLab 8.5
+> **Notes**:
+- [Introduced][ce-2893] in GitLab 8.5.
-Get job artifacts of a project
+Get job artifacts of a project.
```
GET /projects/:id/jobs/:job_id/artifacts
@@ -307,8 +308,10 @@ GET /projects/:id/jobs/:job_id/artifacts
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `job_id` | integer | yes | The ID of a job |
+Example requests:
+
```
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/jobs/8/artifacts"
+curl --location --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/jobs/8/artifacts"
```
Response:
@@ -322,7 +325,8 @@ Response:
## Download the artifacts archive
-> [Introduced][ce-5347] in GitLab 8.10.
+> **Notes**:
+- [Introduced][ce-5347] in GitLab 8.10.
Download the artifacts archive from the given reference name and job provided the
job finished successfully.
@@ -339,7 +343,7 @@ Parameters
| `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:
+Example requests:
```
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/jobs/artifacts/master/download?job=test"