module Gitlab::Client::GroupBadges

Defines methods related to group badges. @see docs.gitlab.com/ee/api/group_badges.html

Public Instance Methods

add_group_badge(group, options = {}) click to toggle source

Adds a badge to a group.

@example

Gitlab.add_group_badge(5, { link_url: 'https://abc.com/gitlab/gitlab-ce/commits/master', image_url: 'https://shields.io/my/badge1' })

@param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user. @param [Hash] options A customizable set of options. @option options [String] :link_url(required) URL of the badge link @option options [String] :image_url(required) URL of the badge image @return [Gitlab::ObjectifiedHash] Information about the added group badge.

# File lib/gitlab/client/group_badges.rb, line 43
def add_group_badge(group, options = {})
  post("/groups/#{url_encode group}/badges", body: options)
end
edit_group_badge(group, badge_id, options = {}) click to toggle source

Updates a badge of a group.

@example

Gitlab.edit_group_badge(5, 1, { link_url: 'https://abc.com/gitlab/gitlab-ce/commits/master', image_url: 'https://shields.io/my/badge1' })

@param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user. @param [Integer] badge_id(required) The badge ID. @param [Hash] options A customizable set of options. @option options [String] :link_url(optional) URL of the badge link @option options [String] :image_url(optional) URL of the badge image @return [Gitlab::ObjectifiedHash] Information about the updated group badge.

# File lib/gitlab/client/group_badges.rb, line 58
def edit_group_badge(group, badge_id, options = {})
  put("/groups/#{url_encode group}/badges/#{badge_id}", body: options)
end
group_badge(group, badge_id) click to toggle source

Gets a badge of a group.

@example

Gitlab.group_badge(5, 42)

@param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user. @param [Integer] badge_id(required) The badge ID. @return [Gitlab::ObjectifiedHash] Information about the requested badge

# File lib/gitlab/client/group_badges.rb, line 29
def group_badge(group, badge_id)
  get("/groups/#{url_encode group}/badges/#{badge_id}")
end
group_badges(group, name = nil) click to toggle source

Gets a list of a groups badges.

@example

Gitlab.group_badges(5)
Gitlab.group_badges(5, 'Coverage')

@param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user. @param [String] name(optional) Name of the badges to return (case-sensitive). @return [Array<Gitlab::ObjectifiedHash>] List of all badges of a group

# File lib/gitlab/client/group_badges.rb, line 16
def group_badges(group, name = nil)
  query = { name: name } if name
  get("/groups/#{url_encode group}/badges", query: query)
end
preview_group_badge(group, link_url, image_url) click to toggle source

Preview a badge from a group.

@example

Gitlab.preview_group_badge(3, 'https://abc.com/gitlab/gitlab-ce/commits/master', 'https://shields.io/my/badge1')

@param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user. @param [String] :link_url(required) URL of the badge link @param [String] :image_url(required) URL of the badge image @return [Gitlab::ObjectifiedHash] Returns how the link_url and image_url final URLs would be after resolving the placeholder interpolation.

# File lib/gitlab/client/group_badges.rb, line 83
def preview_group_badge(group, link_url, image_url)
  query = { link_url: link_url, image_url: image_url }
  get("/groups/#{url_encode group}/badges/render", query: query)
end
remove_group_badge(group, badge_id) click to toggle source

Removes a badge from a group.

@example

Gitlab.remove_group_badge(5, 42)

@param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user. @param [Integer] badge_id(required) The badge ID. @return [nil] This API call returns an empty response body.

# File lib/gitlab/client/group_badges.rb, line 70
def remove_group_badge(group, badge_id)
  delete("/groups/#{url_encode group}/badges/#{badge_id}")
end