summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2016-07-24 18:06:29 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2016-07-24 18:06:29 +0200
commit580f21ea9a80bfe7062296ac7684489d5375df69 (patch)
treea9f33f46af28fc403cb9046848d431d916a9ecd2 /docs
parent261f9470f457673e8082e673fb09861a993fdabc (diff)
downloadgitlab-580f21ea9a80bfe7062296ac7684489d5375df69.tar.gz
Add support from listing group issues
Diffstat (limited to 'docs')
-rw-r--r--docs/gl_objects/issues.py10
-rw-r--r--docs/gl_objects/issues.rst16
2 files changed, 26 insertions, 0 deletions
diff --git a/docs/gl_objects/issues.py b/docs/gl_objects/issues.py
index e0eadbe..a378910 100644
--- a/docs/gl_objects/issues.py
+++ b/docs/gl_objects/issues.py
@@ -8,6 +8,16 @@ closed_issues = gl.issues.list(state='closed')
tagged_issues = gl.issues.list(labels=['foo', 'bar'])
# end filtered list
+# group issues list
+issues = gl.group_issues.list(group_id=1)
+# or
+issues = group.issues.list()
+# Filter using the state, labels and milestone parameters
+issues = group.issues.list(milestone='1.0', state='opened')
+# Order using the order_by and sort parameters
+issues = group.issues.list(order_by='created_at', sort='desc')
+# end group issues list
+
# project issues list
issues = gl.project_issues.list(project_id=1)
# or
diff --git a/docs/gl_objects/issues.rst b/docs/gl_objects/issues.rst
index 335ec54..ac23043 100644
--- a/docs/gl_objects/issues.rst
+++ b/docs/gl_objects/issues.rst
@@ -25,6 +25,22 @@ Use the ``state`` and ``label`` parameters to filter the results. Use the
:start-after: # filtered list
:end-before: # end filtered list
+Group issues
+============
+
+Use :class:`~gitlab.objects.GroupIssue` objects to manipulate issues. The
+:attr:`gitlab.Gitlab.project_issues` and :attr:`Group.issues
+<gitlab.objects.Group.issues>` manager objects provide helper functions.
+
+Examples
+--------
+
+List the group issues:
+
+.. literalinclude:: issues.py
+ :start-after: # group issues list
+ :end-before: # end group issues list
+
Project issues
==============