diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api-objects.rst | 1 | ||||
| -rw-r--r-- | docs/gl_objects/events.rst | 48 | ||||
| -rw-r--r-- | docs/gl_objects/projects.py | 6 | ||||
| -rw-r--r-- | docs/gl_objects/projects.rst | 30 |
4 files changed, 49 insertions, 36 deletions
diff --git a/docs/api-objects.rst b/docs/api-objects.rst index 6879856..f2e72e2 100644 --- a/docs/api-objects.rst +++ b/docs/api-objects.rst @@ -15,6 +15,7 @@ API examples gl_objects/deploy_keys gl_objects/deployments gl_objects/environments + gl_objects/events gl_objects/features gl_objects/groups gl_objects/issues diff --git a/docs/gl_objects/events.rst b/docs/gl_objects/events.rst new file mode 100644 index 0000000..807dcad --- /dev/null +++ b/docs/gl_objects/events.rst @@ -0,0 +1,48 @@ +###### +Events +###### + +Reference +--------- + +* v4 API: + + + :class:`gitlab.v4.objects.Event` + + :class:`gitlab.v4.objects.EventManager` + + :attr:`gitlab.Gitlab.events` + + :class:`gitlab.v4.objects.ProjectEvent` + + :class:`gitlab.v4.objects.ProjectEventManager` + + :attr:`gitlab.v4.objects.Project.events` + + :class:`gitlab.v4.objects.UserEvent` + + :class:`gitlab.v4.objects.UserEventManager` + + :attr:`gitlab.v4.objects.User.events` + +* v3 API (projects events only): + + + :class:`gitlab.v3.objects.ProjectEvent` + + :class:`gitlab.v3.objects.ProjectEventManager` + + :attr:`gitlab.v3.objects.Project.events` + + :attr:`gitlab.Gitlab.project_events` + +* GitLab API: https://docs.gitlab.com/ce/api/events.html + +Examples +-------- + +You can list events for an entire Gitlab instance (admin), users and projects. +You can filter you events you want to retrieve using the ``action`` and +``target_type`` attributes. The possibole values for these attributes are +available on `the gitlab documentation +<https://docs.gitlab.com/ce/api/events.html>`_. + +List all the events (paginated):: + + events = gl.events.list() + +List the issue events on a project:: + + events = project.events.list(target_type='issue') + +List the user events:: + + events = project.events.list() diff --git a/docs/gl_objects/projects.py b/docs/gl_objects/projects.py index 425bbe2..a633ee8 100644 --- a/docs/gl_objects/projects.py +++ b/docs/gl_objects/projects.py @@ -69,12 +69,6 @@ project.archive() project.unarchive() # end archive -# events list -gl.project_events.list(project_id=1) -# or -project.events.list() -# end events list - # members list members = project.members.list() # end members list diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst index 0395950..0c556f4 100644 --- a/docs/gl_objects/projects.rst +++ b/docs/gl_objects/projects.rst @@ -484,36 +484,6 @@ Delete a note for a resource: :start-after: # notes delete :end-before: # end notes delete -Project events -============== - -Reference ---------- - -* v4 API: - - + :class:`gitlab.v4.objects.ProjectEvent` - + :class:`gitlab.v4.objects.ProjectEventManager` - + :attr:`gitlab.v4.objects.Project.events` - -* v3 API: - - + :class:`gitlab.v3.objects.ProjectEvent` - + :class:`gitlab.v3.objects.ProjectEventManager` - + :attr:`gitlab.v3.objects.Project.events` - + :attr:`gitlab.Gitlab.project_events` - -* GitLab API: https://docs.gitlab.com/ce/api/repository_files.html - -Examples --------- - -List the project events: - -.. literalinclude:: projects.py - :start-after: # events list - :end-before: # end events list - Project members =============== |