Group badges API

Group badges API

在 GitLab 10.6 中引入 .

徽章支持占位符,这些占位符将在链接和图像 URL 中被实时替换. 允许的占位符为:

  • %{project_path} :将被项目路径替换.
  • %{project_id} :将被项目 ID 取代.
  • %{default_branch} :将被项目默认分支替换.
  • %{commit_sha} :将由上一个项目的提交 SHA 替换.

由于这些端点不在项目上下文中,因此用于替换占位符的信息将在创建日期之前来自第一组项目. 如果该组没有任何项目,则将返回带有占位符的原始 URL.

List all badges of a group

获取小组徽章的列表.

  1. curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/badges?name=Coverage"
  1. [ { "name": "Coverage", "id": 1, "link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}", "image_url": "https://shields.io/my/badge", "rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master", "rendered_image_url": "https://shields.io/my/badge", "kind": "group" } ]

获取组的徽章.

    Attribute Type Required Description
    id integer/string yes 认证用户拥有的组的 ID 或
    badge_id integer yes 徽章 ID
    1. curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/badges/:badge_id"

    响应示例:

    Add a badge to a group

    将徽章添加到组.

    1. POST /groups/:id/badges
    1. curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "link_url=https://gitlab.com/gitlab-org/gitlab-foss/commits/master&image_url=https://shields.io/my/badge1&position=0" "https://gitlab.example.com/api/v4/groups/:id/badges"

    响应示例:

    1. { "id": 1, "link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master", "image_url": "https://shields.io/my/badge1", "rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master", "rendered_image_url": "https://shields.io/my/badge1", "kind": "group" }
    1. PUT /groups/:id/badges/:badge_id
    Attribute Type Required Description
    id integer/string yes 认证用户拥有的 ID 或URL 编码路径
    badge_id integer yes 徽章 ID
    link_url string no 徽章链接的 URL
    image_url string no 徽章图片的网址

    响应示例:

    1. { "id": 1, "link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master", "image_url": "https://shields.io/my/badge", "rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master", "rendered_image_url": "https://shields.io/my/badge", "kind": "group" }

    Remove a badge from a group

    从组中删除徽章.

    1. curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/badges/:badge_id"

    返回解析占位符插值后的link_urlimage_url最终 URL.

    1. GET /groups/:id/badges/render
    Attribute Type Required Description
    id integer/string yes 认证用户拥有的组的 ID 或
    link_url string yes 徽章链接的 URL
    image_url string yes 徽章图片的网址

    响应示例: