Commit 4211f500 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Add API documentation for downloading the latest successful build

parent 5e0669e0
...@@ -283,6 +283,40 @@ Response: ...@@ -283,6 +283,40 @@ Response:
[ce-2893]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2893 [ce-2893]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2893
## Download the artifacts file
> [Introduced][ce-5347] in GitLab 8.10.
Download the artifacts file from the given reference name and job provided the
build finished successfully.
```
GET /projects/:id/artifacts/:ref_name/download?job=name
```
Parameters
| Attribute | Type | Required | Description |
|-------------|---------|----------|-------------------------- |
| `id` | integer | yes | The ID of a project |
| `ref_name` | string | yes | The ref from a repository |
| `job` | string | yes | The name of the job |
Example request:
```
curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/artifacts/master/download?job=test"
```
Example response:
| Status | Description |
|-----------|---------------------------------|
| 200 | Serves the artifacts file |
| 404 | Build not found or no artifacts |
[ce-5347]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5347
## Get a trace file ## Get a trace file
Get a trace of a specific build of a project Get a trace of a specific build of a project
...@@ -409,7 +443,7 @@ POST /projects/:id/builds/:build_id/erase ...@@ -409,7 +443,7 @@ POST /projects/:id/builds/:build_id/erase
Parameters Parameters
| Attribute | Type | required | Description | | Attribute | Type | Required | Description |
|-------------|---------|----------|---------------------| |-------------|---------|----------|---------------------|
| `id` | integer | yes | The ID of a project | | `id` | integer | yes | The ID of a project |
| `build_id` | integer | yes | The ID of a build | | `build_id` | integer | yes | The ID of a build |
...@@ -459,7 +493,7 @@ POST /projects/:id/builds/:build_id/artifacts/keep ...@@ -459,7 +493,7 @@ POST /projects/:id/builds/:build_id/artifacts/keep
Parameters Parameters
| Attribute | Type | required | Description | | Attribute | Type | Required | Description |
|-------------|---------|----------|---------------------| |-------------|---------|----------|---------------------|
| `id` | integer | yes | The ID of a project | | `id` | integer | yes | The ID of a project |
| `build_id` | integer | yes | The ID of a build | | `build_id` | integer | yes | The ID of a build |
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment