docs/gl_objects/todos.rst


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
44
45
46
47
48

#####
Todos
#####

Use :class:`~gitlab.objects.Todo` objects to manipulate todos. The
:attr:`gitlab.Gitlab.todos` manager object provides helper functions.

Examples
--------

List active todos:

.. literalinclude:: todos.py
   :start-after: # list
   :end-before: # end list

You can filter the list using the following parameters:

* ``action``: can be ``assigned``, ``mentioned``, ``build_failed``, ``marked``,
  or ``approval_required``
* ``author_id``
* ``project_id``
* ``state``: can be ``pending`` or ``done``
* ``type``: can be ``Issue`` or ``MergeRequest``

For example:

.. literalinclude:: todos.py
   :start-after: # filter
   :end-before: # end filter

Get a single todo:

.. literalinclude:: todos.py
   :start-after: # get
   :end-before: # end get

Mark a todo as done:

.. literalinclude:: todos.py
   :start-after: # delete
   :end-before: # end delete

Mark all the todos as done:

.. literalinclude:: todos.py
   :start-after: # all_delete
   :end-before: # end all_delete