File: iterations.rst

package info (click to toggle)
python-gitlab 1%3A8.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,884 kB
  • sloc: python: 25,823; makefile: 171; ruby: 27; javascript: 3
file content (43 lines) | stat: -rw-r--r-- 1,049 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
##########
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/api/iterations

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(get_all=True)

List iterations for a group::

    iterations = group.iterations.list(get_all=True)

Unavailable filters or keyword conflicts::
    
    In case you are trying to pass a parameter that collides with a python
    keyword (i.e. `in`) or with python-gitlab's internal arguments, you'll have
    to use the `query_parameters` argument:

    ```
    group.iterations.list(query_parameters={"in": "title"}, get_all=True)
    ```