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
|
#####
Todos
#####
Reference
---------
* v4 API:
+ :class:`~gitlab.objects.Todo`
+ :class:`~gitlab.objects.TodoManager`
+ :attr:`gitlab.Gitlab.todos`
* GitLab API: https://docs.gitlab.com/ce/api/todos.html
Examples
--------
List active todos::
todos = gl.todos.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::
todos = gl.todos.list(project_id=1)
todos = gl.todos.list(state='done', type='Issue')
Mark a todo as done::
todos = gl.todos.list(project_id=1)
todos[0].mark_as_done()
Mark all the todos as done::
gl.todos.mark_all_as_done()
|