이 API를 사용하여 프로젝트 배지를 관리합니다.

배지는 링크와 이미지 URL 모두에서 실시간으로 대체되는 자리표시자를 지원합니다. 다음 자리표시자를 사용할 수 있습니다:

• %{project_path}: 프로젝트 경로로 대체됩니다.
• %{project_title}: 프로젝트 제목으로 대체됩니다.
• %{project_name}: 프로젝트 이름으로 대체됩니다.
• %{project_id}: 프로젝트 ID로 대체됩니다.
• %{project_namespace}: 프로젝트의 네임스페이스 전체 경로로 대체됩니다.
• %{group_name}: 프로젝트의 최상위 그룹 이름으로 대체됩니다.
• %{gitlab_server}: 프로젝트의 서버 이름으로 대체됩니다.
• %{gitlab_pages_domain}: GitLab Pages를 호스팅하는 도메인 이름으로 대체됩니다.
• %{default_branch}: 프로젝트 기본 브랜치로 대체됩니다.
• %{commit_sha}: 프로젝트의 마지막 커밋 SHA로 대체됩니다.
• %{latest_tag}: 프로젝트의 마지막 태그로 대체됩니다.

프로젝트의 모든 배지 목록#

그룹 배지를 포함하여 프로젝트의 모든 배지를 나열합니다.

GET /projects/:id/badges

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/:id/badges?name=Coverage"

응답 예시:

[
  {
    "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=main",
    "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=main",
    "rendered_image_url": "https://shields.io/my/badge",
    "kind": "group"
  }
]

프로젝트의 배지 조회#

프로젝트의 배지를 조회합니다.

GET /projects/:id/badges/:badge_id

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"

응답 예시:

{
  "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=main",
  "rendered_image_url": "https://shields.io/my/badge",
  "kind": "project"
}

프로젝트에 배지 생성#

프로젝트에 배지를 생성합니다.

POST /projects/:id/badges

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --form "link_url=https://gitlab.com/gitlab-org/gitlab-foss/commits/main" \
  --form "image_url=https://shields.io/my/badge1" \
  --form "name=mybadge" \
  --url "https://gitlab.example.com/api/v4/projects/:id/badges"

응답 예시:

{
  "id": 1,
  "name": "mybadge",
  "link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/main",
  "image_url": "https://shields.io/my/badge1",
  "rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/main",
  "rendered_image_url": "https://shields.io/my/badge1",
  "kind": "project"
}

프로젝트의 배지 업데이트#

프로젝트의 배지를 업데이트합니다.

PUT /projects/:id/badges/:badge_id

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"

응답 예시:

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

프로젝트에서 배지 삭제#

프로젝트에서 배지를 삭제합니다. 그룹 배지를 삭제하려면 대신 그룹 배지 API를 사용하세요.

DELETE /projects/:id/badges/:badge_id

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

프로젝트의 배지 미리보기#

자리표시자 보간을 해결한 후 link_url 및 image_url 최종 URL이 어떻게 될지 반환합니다.

GET /projects/:id/badges/render

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/:id/badges/render?link_url=http%3A%2F%2Fexample.com%2Fci_status.svg%3Fproject%3D%25%7Bproject_path%7D%26ref%3D%25%7Bdefault_branch%7D&image_url=https%3A%2F%2Fshields.io%2Fmy%2Fbadge"

응답 예시:

{
  "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=main",
  "rendered_image_url": "https://shields.io/my/badge"
}