Remove docs for removed endpoint
This commit is contained in:
parent
75123fa9f7
commit
699e955324
104
doc/api/jobs.md
104
doc/api/jobs.md
|
@ -115,110 +115,6 @@ Example of response
|
|||
]
|
||||
```
|
||||
|
||||
## List commit jobs
|
||||
|
||||
Get a list of jobs for specific commit in a project.
|
||||
|
||||
This endpoint will return all jobs, from all pipelines for a given commit.
|
||||
If the commit SHA is not found, it will respond with 404, otherwise it will
|
||||
return an array of jobs (an empty array if there are no jobs for this
|
||||
particular commit).
|
||||
|
||||
```
|
||||
GET /projects/:id/repository/commits/:sha/jobs
|
||||
```
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
|-----------|---------|----------|---------------------|
|
||||
| `id` | integer | yes | The ID of a project |
|
||||
| `sha` | string | yes | The SHA id of a commit |
|
||||
| `scope` | string **or** array of strings | no | The scope of jobs to show, one or array of: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`; showing all jobs if none provided |
|
||||
|
||||
```
|
||||
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" 'https://gitlab.example.com/api/v4/projects/1/repository/commits/0ff3ae198f8601a285adcf5c0fff204ee6fba5fd/jobs?scope%5B0%5D=pending&scope%5B1%5D=running'
|
||||
```
|
||||
|
||||
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,
|
||||
"created_at": "2016-01-11T10:13:33.506Z",
|
||||
"artifacts_file": null,
|
||||
"finished_at": "2016-01-11T10:14:09.526Z",
|
||||
"id": 69,
|
||||
"name": "rubocop",
|
||||
"pipeline": {
|
||||
"id": 6,
|
||||
"ref": "master",
|
||||
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
|
||||
"status": "pending"
|
||||
},
|
||||
"ref": "master",
|
||||
"runner": null,
|
||||
"stage": "test",
|
||||
"started_at": null,
|
||||
"status": "canceled",
|
||||
"tag": false,
|
||||
"user": null
|
||||
},
|
||||
{
|
||||
"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,
|
||||
"created_at": "2015-12-24T15:51:21.957Z",
|
||||
"artifacts_file": null,
|
||||
"finished_at": "2015-12-24T17:54:33.913Z",
|
||||
"id": 9,
|
||||
"name": "brakeman",
|
||||
"pipeline": {
|
||||
"id": 6,
|
||||
"ref": "master",
|
||||
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
|
||||
"status": "pending"
|
||||
},
|
||||
"ref": "master",
|
||||
"runner": null,
|
||||
"stage": "test",
|
||||
"started_at": "2015-12-24T17:54:33.727Z",
|
||||
"status": "failed",
|
||||
"tag": false,
|
||||
"user": {
|
||||
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
|
||||
"bio": null,
|
||||
"created_at": "2015-12-21T13:14:24.077Z",
|
||||
"id": 1,
|
||||
"is_admin": true,
|
||||
"linkedin": "",
|
||||
"name": "Administrator",
|
||||
"skype": "",
|
||||
"state": "active",
|
||||
"twitter": "",
|
||||
"username": "root",
|
||||
"web_url": "http://gitlab.dev/root",
|
||||
"website_url": ""
|
||||
}
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
## Get a single job
|
||||
|
||||
Get a single job of a project
|
||||
|
|
Loading…
Reference in New Issue