Add API documentation for build erase endpoint
This commit is contained in:
parent
b14c9fcdbb
commit
ec5c3c029c
1 changed files with 50 additions and 0 deletions
|
@ -338,3 +338,53 @@ Example of response
|
|||
"user": null
|
||||
}
|
||||
```
|
||||
|
||||
## Erase a build
|
||||
|
||||
Erase a single build of a project (remove build artifacts and a build trace)
|
||||
|
||||
```
|
||||
DELETE /projects/:id/builds/:build_id/content
|
||||
```
|
||||
|
||||
Parameters
|
||||
|
||||
| Attribute | Type | required | Description |
|
||||
|-----------|---------|----------|---------------------|
|
||||
| `id` | integer | yes | The ID of a project |
|
||||
| `build_id` | integer | yes | The ID of a build |
|
||||
|
||||
Example of request
|
||||
|
||||
```
|
||||
curl -X DELETE -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/builds/1/content"
|
||||
```
|
||||
|
||||
Example of response
|
||||
|
||||
```json
|
||||
{
|
||||
"commit": {
|
||||
"author_email": "admin@example.com",
|
||||
"author_name": "Administrator",
|
||||
"created_at": "2015-12-24T16:51:14.000+01:00",
|
||||
"id": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
|
||||
"message": "Test the CI integration.",
|
||||
"short_id": "0ff3ae19",
|
||||
"title": "Test the CI integration."
|
||||
},
|
||||
"coverage": null,
|
||||
"download_url": null,
|
||||
"id": 69,
|
||||
"name": "rubocop",
|
||||
"ref": "master",
|
||||
"runner": null,
|
||||
"stage": "test",
|
||||
"created_at": "2016-01-11T10:13:33.506Z",
|
||||
"started_at": "2016-01-11T10:13:33.506Z",
|
||||
"finished_at": "2016-01-11T10:15:10.506Z",
|
||||
"status": "failed",
|
||||
"tag": false,
|
||||
"user": null
|
||||
}
|
||||
```
|
||||
|
|
Loading…
Reference in a new issue