Merge pull request #619 from python-gitlab/issue/595

[docs] Add an example of pipeline schedule vars listing

1 files changed, 7 insertions, 0 deletions

diff --git a/docs/gl_objects/builds.rst b/docs/gl_objects/builds.rst
index 51e7496..ee45090 100644
--- a/docs/gl_objects/builds.rst
+++ b/docs/gl_objects/builds.rst
@@ -141,6 +141,13 @@ Delete a schedule::
 
     sched.delete()
 
+List schedule variables::
+
+    # note: you need to use get() to retrieve the schedule variables. The
+    # attribute is not present in the response of a list() call
+    sched = projects.pipelineschedules.get(schedule_id)
+    vars = sched.attributes['variables']
+
 Create a schedule variable::
 
     var = sched.variables.create({'key': 'foo', 'value': 'bar'})