diff options
| -rw-r--r-- | docs/api-objects.rst | 1 | ||||
| -rw-r--r-- | docs/gl_objects/builds.rst | 6 | ||||
| -rw-r--r-- | docs/gl_objects/issues.py | 65 | ||||
| -rw-r--r-- | docs/gl_objects/issues.rst | 84 | ||||
| -rw-r--r-- | docs/gl_objects/projects.rst | 2 |
5 files changed, 154 insertions, 4 deletions
diff --git a/docs/api-objects.rst b/docs/api-objects.rst index 47daf74..cd50b4c 100644 --- a/docs/api-objects.rst +++ b/docs/api-objects.rst @@ -8,6 +8,7 @@ API objects manipulation gl_objects/builds gl_objects/commits gl_objects/groups + gl_objects/issues gl_objects/projects gl_objects/runners gl_objects/users diff --git a/docs/gl_objects/builds.rst b/docs/gl_objects/builds.rst index ce4cc0e..1c4c525 100644 --- a/docs/gl_objects/builds.rst +++ b/docs/gl_objects/builds.rst @@ -7,7 +7,7 @@ Build triggers Use :class:`~gitlab.objects.ProjectTrigger` objects to manipulate build triggers. The :attr:`gitlab.Gitlab.project_triggers` and -:attr:`gitlab.objects.Projeect.triggers` manager objects provide helper +:attr:`gitlab.objects.Project.triggers` manager objects provide helper functions. Examples @@ -42,7 +42,7 @@ Build variables Use :class:`~gitlab.objects.ProjectVariable` objects to manipulate build variables. The :attr:`gitlab.Gitlab.project_variables` and -:attr:`gitlab.objects.Projeect.variables` manager objects provide helper +:attr:`gitlab.objects.Project.variables` manager objects provide helper functions. Examples @@ -82,7 +82,7 @@ Builds ====== Use :class:`~gitlab.objects.ProjectBuild` objects to manipulate builds. The -:attr:`gitlab.Gitlab.project_builds` and :attr:`gitlab.objects.Projeect.builds` +:attr:`gitlab.Gitlab.project_builds` and :attr:`gitlab.objects.Project.builds` manager objects provide helper functions. Examples diff --git a/docs/gl_objects/issues.py b/docs/gl_objects/issues.py new file mode 100644 index 0000000..e0eadbe --- /dev/null +++ b/docs/gl_objects/issues.py @@ -0,0 +1,65 @@ +# list +issues = gl.issues.list() +# end list + +# filtered list +open_issues = gl.issues.list(state='opened') +closed_issues = gl.issues.list(state='closed') +tagged_issues = gl.issues.list(labels=['foo', 'bar']) +# end filtered list + +# project issues list +issues = gl.project_issues.list(project_id=1) +# or +issues = project.issues.list() +# Filter using the state, labels and milestone parameters +issues = project.issues.list(milestone='1.0', state='opened') +# Order using the order_by and sort parameters +issues = project.issues.list(order_by='created_at', sort='desc') +# end project issues list + +# project issues get +issue = gl.project_issues.get(issue_id, project_id=1) +# or +issue = project.issues.get(issue_id) +# end project issues get + +# project issues create +issue = gl.project_issues.create({'title': 'I have a bug', + 'description': 'Something useful here.'}, + project_id=1) +# or +issue = project.issues.create({'title': 'I have a bug', + 'description': 'Something useful here.'}) +# end project issues create + +# project issue update +issue.labels = ['foo', 'bar'] +issue.save() +# end project issue update + +# project issue open_close +# close an issue +issue.state_event = 'close' +issue.save() +# reopen it +issue.state_event = 'reopen' +issue.save() +# end project issue open_close + +# project issue delete +gl.project_issues.delete(issue_id, project_id=1) +# or +project.issues.delete(issue_id) +# pr +issue.delete() +# end project issue delete + +# project issue subscribe +issue.subscribe() +issue.unsubscribe() +# end project issue subscribe + +# project issue move +issue.move(new_project_id) +# end project issue move diff --git a/docs/gl_objects/issues.rst b/docs/gl_objects/issues.rst new file mode 100644 index 0000000..335ec54 --- /dev/null +++ b/docs/gl_objects/issues.rst @@ -0,0 +1,84 @@ +###### +Issues +###### + +Reported issues +=============== + +Use :class:`~gitlab.objects.Issues` objects to manipulate issues the +authenticated user reported. The :attr:`gitlab.Gitlab.issues` manager object +provides helper functions. + +Examples +-------- + +List the issues: + +.. literalinclude:: issues.py + :start-after: # list + :end-before: # end list + +Use the ``state`` and ``label`` parameters to filter the results. Use the +``order_by`` and ``sort`` attributes to sort the results: + +.. literalinclude:: issues.py + :start-after: # filtered list + :end-before: # end filtered list + +Project issues +============== + +Use :class:`~gitlab.objects.ProjectIssue` objects to manipulate issues. The +:attr:`gitlab.Gitlab.project_issues` and :attr:`Project.issues +<gitlab.objects.Project.issues>` manager objects provide helper functions. + +Examples +-------- + +List the project issues: + +.. literalinclude:: issues.py + :start-after: # project issues list + :end-before: # end project issues list + +Get a project issue: + +.. literalinclude:: issues.py + :start-after: # project issues get + :end-before: # end project issues get + +Create a new issue: + +.. literalinclude:: issues.py + :start-after: # project issues create + :end-before: # end project issues create + +Update an issue: + +.. literalinclude:: issues.py + :start-after: # project issue update + :end-before: # end project issue update + +Close / reopen an issue: + +.. literalinclude:: issues.py + :start-after: # project issue open_close + :end-before: # end project issue open_close + +Delete an issue: + +.. literalinclude:: issues.py + :start-after: # project issue delete + :end-before: # end project issue delete + +Subscribe / unsubscribe from an issue: + +.. literalinclude:: issues.py + :start-after: # project issue subscribe + :end-before: # end project issue subscribe + +Move an issue to another project: + +.. literalinclude:: issues.py + :start-after: # project issue move + :end-before: # end project issue move diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst index e9c5b6c..294c3f2 100644 --- a/docs/gl_objects/projects.rst +++ b/docs/gl_objects/projects.rst @@ -91,7 +91,7 @@ Archive/unarchive a project: Events ------ -Use :class:`~gitlab.objects.ProjectEvent` objects to manipulate projects. The +Use :class:`~gitlab.objects.ProjectEvent` objects to manipulate events. The :attr:`gitlab.Gitlab.project_events` and :attr:`Project.events <gitlab.objects.Project.events>` manager objects provide helper functions. |