프로젝트 뱃지 API
Tier: Free, Premium, Ultimate
Offering: GitLab.com, Self-Managed, GitLab Dedicated
플레이스홀더 토큰
뱃지는 링크 및 이미지 URL에서 실시간으로 대체되는 플레이스홀더를 지원합니다. 허용되는 플레이스홀더는 다음과 같습니다:
- %{project_path}: 프로젝트 경로로 대체됨.
- %{project_title}: 프로젝트 제목으로 대체됨.
- %{project_name}: 프로젝트 이름으로 대체됨.
- %{project_id}: 프로젝트 ID로 대체됨.
- %{default_branch}: 프로젝트의 기본 브랜치로 대체됨.
- %{commit_sha}: 마지막 프로젝트 커밋 SHA로 대체됨.
프로젝트의 모든 뱃지 나열
프로젝트의 뱃지 및 그룹 뱃지 디렉터리을 가져옵니다.
GET /projects/:id/badges
속성 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
id
| 정수/문자열 | 예 | 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로 |
name
| 문자열 | 아니요 | 반환할 뱃지의 이름 (대소문자 구분). |
curl --header "PRIVATE-TOKEN: <your_access_token>" "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
속성 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
id
| 정수/문자열 | 예 | 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로 |
badge_id
| 정수 | 예 | 뱃지 ID |
curl --header "PRIVATE-TOKEN: <your_access_token>" "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
속성 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
id
| 정수/문자열 | 예 | 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로 |
link_url
| 문자열 | 예 | 뱃지 링크의 URL |
image_url
| 문자열 | 예 | 뱃지 이미지의 URL |
name
| 문자열 | 아니요 | 뱃지의 이름 |
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
--data "link_url=https://gitlab.com/gitlab-org/gitlab-foss/commits/main&image_url=https://shields.io/my/badge1&name=mybadge" \
"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
속성 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
id
| 정수/문자열 | 예 | 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로 |
badge_id
| 정수 | 예 | 뱃지 ID |
link_url
| 문자열 | 아니요 | 뱃지 링크의 URL |
image_url
| 문자열 | 아니요 | 뱃지 이미지의 URL |
name
| 문자열 | 아니요 | 뱃지의 이름 |
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "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"
}
프로젝트에서 뱃지 제거
프로젝트에서 뱃지를 제거합니다. 이 엔드포인트를 사용하여 프로젝트 뱃지만을 제거합니다.
DELETE /projects/:id/badges/:badge_id
속성 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
id
| 정수/문자열 | 예 | 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로 |
badge_id
| 정수 | 예 | 뱃지 ID |
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"
프로젝트에서 뱃지 미리보기
link_url
및 image_url
의 플레이스홀더 보간 후 최종 URL이 어떻게 되는지 반환합니다.
GET /projects/:id/badges/render
속성 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
id
| 정수/문자열 | 예 | 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로 |
link_url
| 문자열 | 예 | 뱃지 링크의 URL |
image_url
| 문자열 | 예 | 뱃지 이미지의 URL |
curl --header "PRIVATE-TOKEN: <your_access_token>" "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"
}