Project badges API

Project badges API

在 GitLab 10.6 中引入 .

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

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

List all badges of a project

获取项目徽章及其组徽章的列表.

  1. curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges"
  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":  "project"  },  {  "name":  "Pipeline",  "id":  2,  "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/projects/:id/badges/:badge_id"

    响应示例：

    Add a badge to a project

    将徽章添加到项目.

    1. POST /projects/: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/projects/: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":  "project"  }

    更新项目的徽章.

    1. PUT /projects/: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":  "project"  }

    Remove a badge from a project

    从项目中删除徽章. 使用此端点将仅删除项目的标志.

    1. curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"
    1. GET /projects/:id/badges/render
    Attribute Type Required Description
    id integer/string yes 经过身份验证的用户拥有的项目的 ID 或
    link_url string yes 徽章链接的 URL
    image_url string yes 徽章图片的网址

    响应示例：