Skip to content

Commit 9d27ce1

Browse files
committed
Update documentation
1 parent c0e7261 commit 9d27ce1

File tree

1 file changed

+36
-11
lines changed

1 file changed

+36
-11
lines changed

doc/api/runners.md

+36-11
Original file line numberDiff line numberDiff line change
@@ -215,9 +215,9 @@ DELETE /runners/:id
215215
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/runners/6"
216216
```
217217

218-
## List runner's running jobs
218+
## List runner's jobs
219219

220-
List running jobs assigned to the specified Runner.
220+
List jobs that are being processed or were processed by specified Runner.
221221

222222
```
223223
GET /runners/:id/jobs
@@ -226,9 +226,10 @@ GET /runners/:id/jobs
226226
| Attribute | Type | Required | Description |
227227
|-----------|---------|----------|---------------------|
228228
| `id` | integer | yes | The ID of a runner |
229+
| `status` | string | no | Status of the job; one of: `running`, `success`, `failed`, `canceled` |
229230

230231
```
231-
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/runners/1/jobs"
232+
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/runners/1/jobs%3Cspan%20class="x x-first x-last">?status=running"
232233
```
233234

234235
Example response:
@@ -247,20 +248,44 @@ Example response:
247248
"started_at": "2017-11-16T08:51:29.000Z",
248249
"finished_at": "2017-11-16T08:53:29.000Z",
249250
"duration": 120,
250-
"user": null,
251-
"commit": null,
252-
"runner": {
251+
"user": {
253252
"id": 1,
254-
"description": "My runner1",
255-
"active": true,
256-
"is_shared": true,
257-
"name": null
253+
"name": "John Doe2",
254+
"username": "user2",
255+
"state": "active",
256+
"avatar_url": "http://www.gravatar.com/avatar/c922747a93b40d1ea88262bf1aebee62?s=80&d=identicon",
257+
"web_url": "http://localhost/user2",
258+
"created_at": "2017-11-16T18:38:46.000Z",
259+
"bio": null,
260+
"location": null,
261+
"skype": "",
262+
"linkedin": "",
263+
"twitter": "",
264+
"website_url": "",
265+
"organization": null
266+
},
267+
"commit": {
268+
"id": "97de212e80737a608d939f648d959671fb0a0142",
269+
"short_id": "97de212e",
270+
"title": "Update configuration\r",
271+
"created_at": "2017-11-16T08:50:28.000Z",
272+
"parent_ids": [
273+
"1b12f15a11fc6e62177bef08f47bc7b5ce50b141",
274+
"498214de67004b1da3d820901307bed2a68a8ef6"
275+
],
276+
"message": "See merge request !123",
277+
"author_name": "John Doe2",
278+
"author_email": "[email protected]",
279+
"authored_date": "2017-11-16T08:50:27.000Z",
280+
"committer_name": "John Doe2",
281+
"committer_email": "[email protected]",
282+
"committed_date": "2017-11-16T08:50:27.000Z"
258283
},
259284
"pipeline": {
260285
"id": 2,
261286
"sha": "97de212e80737a608d939f648d959671fb0a0142",
262287
"ref": "master",
263-
"status": "pending"
288+
"status": "running"
264289
},
265290
"project": {
266291
"id": 1,

0 commit comments

Comments
 (0)