Support the scope attribute in runners.list()

Gauvain Pocentek · Gauvain Pocentek · commit de0536b1cfff · 2017-01-21T14:13:28.000+01:00
diff --git a/docs/gl_objects/runners.py b/docs/gl_objects/runners.py
@@ -1,6 +1,8 @@
 # list
 # List owned runners
 runners = gl.runners.list()
+# With a filter
+runners = gl.runners.list(scope='active')
 # List all runners, using a filter
 runners = gl.runners.all(scope='paused')
 # end list
diff --git a/docs/gl_objects/runners.rst b/docs/gl_objects/runners.rst
@@ -13,9 +13,14 @@ Examples
 
 Use the ``list()`` and ``all()`` methods to list runners.
 
-The ``all()`` method accepts a ``scope`` parameter to filter the list. Allowed
-values for this parameter are ``specific``, ``shared``, ``active``, ``paused``
-and ``online``.
+Both methods accept a ``scope`` parameter to filter the list. Allowed values
+for this parameter are:
+
+* ``active``
+* ``paused``
+* ``online``
+* ``specific`` (``all()`` only)
+* ``shared`` (``all()`` only)
 
 .. note::
 
diff --git a/gitlab/objects.py b/gitlab/objects.py
@@ -2478,6 +2478,7 @@ class Runner(GitlabObject):
     _url = '/runners'
     canCreate = False
     optionalUpdateAttrs = ['description', 'active', 'tag_list']
+    optionalListAttrs = ['scope']
 
 
 class RunnerManager(BaseManager):
