diff options
| author | Gauvain Pocentek <gauvain.pocentek@objectif-libre.com> | 2017-12-16 08:05:36 +0100 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain.pocentek@objectif-libre.com> | 2017-12-16 08:05:36 +0100 |
| commit | 93f149919e569bdecab072b120ee6a6ea528452f (patch) | |
| tree | 8f2de2474e73cdb791c34d7a1befe0289ce20200 /docs | |
| parent | b0ce3c80757f19a93733509360e5440c52920f48 (diff) | |
| download | gitlab-93f149919e569bdecab072b120ee6a6ea528452f.tar.gz | |
Add missing doc file
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/gl_objects/emojis.rst | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/gl_objects/emojis.rst b/docs/gl_objects/emojis.rst new file mode 100644 index 0000000..179141f --- /dev/null +++ b/docs/gl_objects/emojis.rst @@ -0,0 +1,45 @@ +############ +Award Emojis +############ + +Reference +--------- + +* v4 API: + + + :class:`gitlab.v4.objects.ProjectIssueAwardEmoji` + + :class:`gitlab.v4.objects.ProjectIssueNoteAwardEmoji` + + :class:`gitlab.v4.objects.ProjectMergeRequestAwardEmoji` + + :class:`gitlab.v4.objects.ProjectMergeRequestNoteAwardEmoji` + + :class:`gitlab.v4.objects.ProjectSnippetAwardEmoji` + + :class:`gitlab.v4.objects.ProjectSnippetNoteAwardEmoji` + + :class:`gitlab.v4.objects.ProjectIssueAwardEmojiManager` + + :class:`gitlab.v4.objects.ProjectIssueNoteAwardEmojiManager` + + :class:`gitlab.v4.objects.ProjectMergeRequestAwardEmojiManager` + + :class:`gitlab.v4.objects.ProjectMergeRequestNoteAwardEmojiManager` + + :class:`gitlab.v4.objects.ProjectSnippetAwardEmojiManager` + + :class:`gitlab.v4.objects.ProjectSnippetNoteAwardEmojiManager` + + +* GitLab API: https://docs.gitlab.com/ce/api/award_emoji.html + +Examples +-------- + +List emojis for a resource:: + + emojis = obj.awardemojis.list() + +Get a single emoji:: + + emoji = obj.awardemojis.get(emoji_id) + +Add (create) an emoji:: + + emoji = obj.awardemojis.create({'name': 'tractor'}) + +Delete an emoji:: + + emoji.delete + # or + obj.awardemojis.delete(emoji_id) |