summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorNejc Habjan <nejc.habjan@siemens.com>2022-07-24 23:14:06 +0200
committerJohn Villalovos <john@sodarock.com>2022-07-27 08:29:24 -0700
commit194ee0100c2868c1a9afb161c15f3145efb01c7c (patch)
tree2af6cd63ec2ee357a43accbdbc13342d61f87f24 /docs/gl_objects
parent66461ba519a85bfbd3cba284a0c8de11a3ac7cde (diff)
downloadgitlab-194ee0100c2868c1a9afb161c15f3145efb01c7c.tar.gz
feat: add support for iterations API
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/iterations.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/gl_objects/iterations.rst b/docs/gl_objects/iterations.rst
new file mode 100644
index 0000000..8db0c2e
--- /dev/null
+++ b/docs/gl_objects/iterations.rst
@@ -0,0 +1,33 @@
+##########
+Iterations
+##########
+
+
+Reference
+---------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.GroupIteration`
+ + :class:`gitlab.v4.objects.GroupIterationManager`
+ + :attr:`gitlab.v4.objects.Group.iterations`
+ + :class:`gitlab.v4.objects.ProjectIterationManager`
+ + :attr:`gitlab.v4.objects.Project.iterations`
+
+* GitLab API: https://docs.gitlab.com/ee/api/iterations.html
+
+Examples
+--------
+
+.. note::
+
+ GitLab no longer has project iterations. Using a project endpoint returns
+ the ancestor groups' iterations.
+
+List iterations for a project's ancestor groups::
+
+ iterations = project.iterations.list()
+
+List iterations for a group::
+
+ iterations = group.iterations.list()