diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2018-11-03 09:50:37 +0100 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2018-11-22 18:13:46 +0100 |
| commit | 95d0d745d4bafe702c89c972f644b049d6c810ab (patch) | |
| tree | 23f6b1aa6e9198dba5e0c18b78bbb99bfba61be9 /docs/gl_objects | |
| parent | c8eaeb2d258055b8fc77cbeef373aee5551c181a (diff) | |
| download | gitlab-95d0d745d4bafe702c89c972f644b049d6c810ab.tar.gz | |
Add support to resource label eventsfix/611/resource_label_event
Closes #611
Diffstat (limited to 'docs/gl_objects')
| -rw-r--r-- | docs/gl_objects/labels.rst | 39 | ||||
| -rw-r--r-- | docs/gl_objects/projects.rst | 2 |
2 files changed, 40 insertions, 1 deletions
diff --git a/docs/gl_objects/labels.rst b/docs/gl_objects/labels.rst index 1c98971..a4667aa 100644 --- a/docs/gl_objects/labels.rst +++ b/docs/gl_objects/labels.rst @@ -2,6 +2,9 @@ Labels ###### +Project labels +============== + Reference --------- @@ -48,3 +51,39 @@ Manage labels in issues and merge requests:: 'labels': ['foo']}) issue.labels.append('bar') issue.save() + +Label events +============ + +Resource label events keep track about who, when, and which label was added or +removed to an issuable. + +Group epic label events are only available in the EE edition. + +Reference +--------- + +* v4 API: + + + :class:`gitlab.v4.objects.ProjectIssueResourceLabelEvent` + + :class:`gitlab.v4.objects.ProjectIssueResourceLabelEventManager` + + :attr:`gitlab.v4.objects.ProjectIssue.resourcelabelevents` + + :class:`gitlab.v4.objects.ProjectMergeRequestResourceLabelEvent` + + :class:`gitlab.v4.objects.ProjectMergeRequestResourceLabelEventManager` + + :attr:`gitlab.v4.objects.ProjectMergeRequest.resourcelabelevents` + + :class:`gitlab.v4.objects.GroupEpicResourceLabelEvent` + + :class:`gitlab.v4.objects.GroupEpicResourceLabelEventManager` + + :attr:`gitlab.v4.objects.GroupEpic.resourcelabelevents` + +* GitLab API: https://docs.gitlab.com/ee/api/resource_label_events.html + +Examples +-------- + +Get the events for a resource (issue, merge request or epic):: + + events = resource.resourcelabelevents.list() + +Get a specific event for a resource:: + + event = resource.resourcelabelevents.get(event_id) diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst index 5cc223f..c8bd3eb 100644 --- a/docs/gl_objects/projects.rst +++ b/docs/gl_objects/projects.rst @@ -659,7 +659,7 @@ Delete project push rules:: pr.delete() Project protected tags -================== +====================== Reference --------- |