Method: Gitlab::Client::ProjectBadges#preview_project_badge

Defined in:
lib/gitlab/client/project_badges.rb

#preview_project_badge(project, link_url, image_url) ⇒ Gitlab::ObjectifiedHash

Preview a badge from a project.

Examples:

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

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • :link_url (String) —

    URL of the badge link

  • :image_url (String) —

    URL of the badge image

Returns:

  • (Gitlab::ObjectifiedHash) —

    Returns how the link_url and image_url final URLs would be after resolving the placeholder interpolation.



80
81
82
83
 
# File 'lib/gitlab/client/project_badges.rb', line 80

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