From 0be81cb8f48b7497a05ec7d1e7cf0a1b6eb045a1 Mon Sep 17 00:00:00 2001
From: Gauvain Pocentek <gauvain@pocentek.net>
Date: Tue, 29 May 2018 09:08:52 +0200
Subject: Implement runner jobs listing

---
 docs/gl_objects/runners.rst | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

(limited to 'docs')

diff --git a/docs/gl_objects/runners.rst b/docs/gl_objects/runners.rst
index 70bd60f..1e6f81b 100644
--- a/docs/gl_objects/runners.rst
+++ b/docs/gl_objects/runners.rst
@@ -94,3 +94,29 @@ Enable a specific runner for a project::
 Disable a specific runner for a project::
 
     project.runners.delete(runner.id)
+
+Runner jobs
+===========
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.RunnerJob`
+  + :class:`gitlab.v4.objects.RunnerJobManager`
+  + :attr:`gitlab.v4.objects.Runner.jobs`
+
+* GitLab API: https://docs.gitlab.com/ce/api/runners.html
+
+Examples
+--------
+
+List for jobs for a runner::
+
+    jobs = runner.jobs.list()
+
+Filter the list using the jobs status::
+
+    # status can be 'running', 'success', 'failed' or 'canceled'
+    active_jobs = runner.jobs.list(status='running')
-- 
cgit v1.2.1