module Gitlab::Client::ProjectBadges

def add_project_badge(project, options = {})

Returns:
  • (Gitlab::ObjectifiedHash) - Information about the added project badge.

Options Hash: (**options)
  • :image_url(required) (String) -- URL of the badge image
  • :link_url(required) (String) -- URL of the badge link

Parameters:
  • options (Hash) -- A customizable set of options.
  • project (Integer, String) -- The ID or name of a project. 
def add_project_badge(project, options = {})
  post("/projects/#{url_encode project}/badges", body: options)
end

def edit_project_badge(project, badge_id, options = {})

Returns:
  • (Gitlab::ObjectifiedHash) - Information about the updated project badge.

Options Hash: (**options)
  • :image_url(optional) (String) -- URL of the badge image
  • :link_url(optional) (String) -- URL of the badge link

Parameters:
  • options (Hash) -- A customizable set of options.
  • badge_id (Integer) -- The badge ID.
  • project (Integer, String) -- The ID or name of a project. 
def edit_project_badge(project, badge_id, options = {})
  put("/projects/#{url_encode project}/badges/#{badge_id}", body: options)
end

def preview_project_badge(project, link_url, image_url)

Returns:
  • (Gitlab::ObjectifiedHash) - Returns how the link_url and image_url final URLs would be after resolving the placeholder interpolation.

Parameters:
  • :image_url (String) -- URL of the badge image
  • :link_url (String) -- URL of the badge link
  • project (Integer, String) -- The ID or name of a project. 
def preview_project_badge(project, link_url, image_url)
  query = { link_url: link_url, image_url: image_url }
  get("/projects/#{url_encode project}/badges/render", query: query)
end

def project_badge(project, badge_id)

Returns:
  • (Gitlab::ObjectifiedHash) - Information about the requested badge

Parameters:
  • badge_id (Integer) -- The badge ID.
  • project (Integer, String) -- The ID or name of a project. 
def project_badge(project, badge_id)
  get("/projects/#{url_encode project}/badges/#{badge_id}")
end

def project_badges(project)

Returns:
  • (Array) - List of all badges of a project

Parameters:
  • project (Integer, String) -- The ID or name of a project. 
def project_badges(project)
  get("/projects/#{url_encode project}/badges")
end

def remove_project_badge(project, badge_id)

Returns:
  • (nil) - This API call returns an empty response body.

Parameters:
  • badge_id (Integer) -- The badge ID.
  • project (Integer, String) -- The ID or name of a project. 
def remove_project_badge(project, badge_id)
  delete("/projects/#{url_encode project}/badges/#{badge_id}")
end