summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2018-05-29 19:32:26 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2018-05-29 19:32:26 +0200
commit9412a5ddb1217368e0ac19fc06a4ff32711b931f (patch)
treebe513e71cef4ebdab12014a312a73a6091819924 /docs/gl_objects
parent01a41efd271dd08d4b5744473fb71a67d9f5dea5 (diff)
downloadgitlab-9412a5ddb1217368e0ac19fc06a4ff32711b931f.tar.gz
Add support for group badges
Also consolidate project/group badges tests, and add some docs Fixes #469
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/badges.rst52
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/gl_objects/badges.rst b/docs/gl_objects/badges.rst
new file mode 100644
index 0000000..1bda282
--- /dev/null
+++ b/docs/gl_objects/badges.rst
@@ -0,0 +1,52 @@
+######
+Badges
+######
+
+Badges can be associated with groups and projects.
+
+Reference
+---------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.GroupBadge`
+ + :class:`gitlab.v4.objects.GroupBadgeManager`
+ + :attr:`gitlab.v4.objects.Group.badges`
+ + :class:`gitlab.v4.objects.ProjectBadge`
+ + :class:`gitlab.v4.objects.ProjectBadgeManager`
+ + :attr:`gitlab.v4.objects.Project.badges`
+
+* GitLab API:
+
+ + https://docs.gitlab.com/ce/api/group_badges.html
+ + https://docs.gitlab.com/ce/api/project_badges.html
+
+Examples
+--------
+
+List badges::
+
+ badges = group_or_project.badges.list()
+
+Get ad badge::
+
+ badge = group_or_project.badges.get(badge_id)
+
+Create a badge::
+
+ badge = group_or_project.badges.create({'link_url': link, 'image_url': image_link})
+
+Update a badge::
+
+ badge.image_link = new_link
+ badge.save()
+
+Delete a badge::
+
+ badge.delete()
+
+Render a badge (preview the generate URLs)::
+
+ output = group_or_project.badges.render(link, image_link)
+ print(output['rendered_link_url'])
+ print(output['rendered_image_url'])