레이블 API

Tier: Free, Premium, Ultimate

Offering: GitLab.com, Self-managed, GitLab Dedicated

REST API를 사용하여 레이블과 상호 작용하세요.

레이블 목록

주어진 프로젝트에 대한 모든 레이블을 가져옵니다.

기본적으로 이 요청은 한 번에 20개의 결과를 반환합니다. API 결과는 페이지네이션됩니다.

GET /projects/:id/labels

속성	유형	필수	설명
`id`	integer/string	예	프로젝트의 ID 또는 URL 인코딩된 경로
`with_counts`	boolean	아니요	이슈 및 병합 요청 수를 포함할지 여부. 기본값은 `false`입니다.
`include_ancestor_groups`	boolean	아니요	상위 그룹을 포함합니다. 기본값은 `true`입니다.
`search`	string	아니요	레이블을 필터링하기 위한 키워드입니다.

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/labels?with_counts=true"

예시 응답:

[
  {
    "id" : 1,
    "name" : "버그",
    "color" : "#d9534f",
    "text_color" : "#FFFFFF",
    "description": "유저가 보고한 버그",
    "description_html": "유저가 보고한 버그",
    "open_issues_count": 1,
    "closed_issues_count": 0,
    "open_merge_requests_count": 1,
    "subscribed": false,
    "priority": 10,
    "is_project_label": true
  },
  {
    "id" : 4,
    "color" : "#d9534f",
    "text_color" : "#FFFFFF",
    "name" : "확인됨",
    "description": "확인된 이슈",
    "description_html": "확인된 이슈",
    "open_issues_count": 2,
    "closed_issues_count": 5,
    "open_merge_requests_count": 0,
    "subscribed": false,
    "priority": null,
    "is_project_label": true
  },
  {
    "id" : 7,
    "name" : "치명적",
    "color" : "#d9534f",
    "text_color" : "#FFFFFF",
    "description": "치명적인 이슈. ASAP으로 수정 필요",
    "description_html": "치명적인 이슈. ASAP으로 수정 필요",
    "open_issues_count": 1,
    "closed_issues_count": 3,
    "open_merge_requests_count": 1,
    "subscribed": false,
    "priority": null,
    "is_project_label": true
  },
  {
    "id" : 8,
    "name" : "문서화",
    "color" : "#f0ad4e",
    "text_color" : "#FFFFFF",
    "description": "문서 관련 이슈",
    "description_html": "문서 관련 이슈",
    "open_issues_count": 1,
    "closed_issues_count": 0,
    "open_merge_requests_count": 2,
    "subscribed": false,
    "priority": null,
    "is_project_label": false
  },
  {
    "id" : 9,
    "color" : "#5cb85c",
    "text_color" : "#FFFFFF",
    "name" : "개선",
    "description": "개선 제안",
    "description_html": "개선 제안",
    "open_issues_count": 1,
    "closed_issues_count": 0,
    "open_merge_requests_count": 1,
    "subscribed": true,
    "priority": null,
    "is_project_label": true
  }
]

단일 프로젝트 레이블 가져오기

주어진 프로젝트에 대한 단일 레이블을 가져옵니다.

GET /projects/:id/labels/:label_id

속성	유형	필수	설명
`id`	integer 또는 string	예	프로젝트의 ID 또는 URL-인코딩된 경로
`label_id`	integer 또는 string	예	프로젝트 레이블의 ID 또는 제목.
`include_ancestor_groups`	boolean	아니오	상위 그룹 포함. 기본값은 `true`.

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/labels/bug"

예시 응답:

{
  "id" : 1,
  "name" : "bug",
  "color" : "#d9534f",
  "text_color" : "#FFFFFF",
  "description": "사용자에 의해 보고된 버그",
  "description_html": "사용자에 의해 보고된 버그",
  "open_issues_count": 1,
  "closed_issues_count": 0,
  "open_merge_requests_count": 1,
  "subscribed": false,
  "priority": 10,
  "is_project_label": true
}

새 레이블 생성

주어진 이름과 색상으로 주어진 리포지토리에 대한 새 레이블을 생성합니다.

POST /projects/:id/labels

속성	유형	필수	설명
`id`	integer/string	예	프로젝트의 ID 또는 URL-인코딩된 경로
`name`	string	예	레이블의 이름
`color`	string	예	레이블의 색상으로, ‘#’ 기호가 있는 6자리 16진수 표기법(예: #FFAABB) 또는 CSS 색상 이름 중 하나.
`description`	string	아니오	레이블의 설명
`priority`	integer	아니오	레이블의 우선 순위. 0 또는 `null`보다 크거나 같아야 합니다. 우선 순위를 제거하려면 `null`로 설정합니다.

curl --data "name=feature&color=#5843AD" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/labels"

예시 응답:

{
  "id" : 10,
  "name" : "feature",
  "color" : "#5843AD",
  "text_color" : "#FFFFFF",
  "description":null,
  "description_html":null,
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": false,
  "priority": null,
  "is_project_label": true
}

레이블 삭제

주어진 이름을 가진 레이블을 삭제합니다.

DELETE /projects/:id/labels/:label_id

속성	유형	필수	설명
`id`	integer 또는 string	예	프로젝트의 ID 또는 URL-인코딩된 경로
`label_id`	integer 또는 string	예	그룹 레이블의 ID 또는 제목.

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/labels/bug"

참고: name 매개변수가 있는 이전 엔드포인트 DELETE /projects/:id/labels는 여전히 사용 가능하지만, 더 이상 권장되지 않습니다.

기존 레이블 편집

기존 레이블을 새로운 이름이나 새로운 색상으로 업데이트합니다. 레이블을 업데이트하기 위해서는 적어도 하나의 매개변수가 필요합니다.

PUT /projects/:id/labels/:label_id

속성	유형	필수 여부	설명
`id`	정수 또는 문자열	예	프로젝트의 ID 또는 URL 인코딩된 경로
`label_id`	정수 또는 문자열	예	그룹 레이블의 ID 또는 제목.
`new_name`	문자열	`color`가 제공되지 않는 경우	레이블의 새로운 이름
`color`	문자열	`new_name`이 제공되지 않는 경우	색상은 6자리 16진수 표기법으로 ‘#’ 기호로 시작 (예: #FFAABB) 또는 CSS 색상 이름 중 하나
`description`	문자열	아니오	레이블의 새로운 설명
`priority`	정수	아니오	레이블의 새로운 우선순위. 0 이상 또는 우선순위를 제거하기 위해 `null`이어야 합니다.

curl --request PUT --data "new_name=docs&color=#8E44AD&description=Documentation" \
     --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/labels/documentation"

예시 응답:

{
  "id" : 8,
  "name" : "docs",
  "color" : "#8E44AD",
  "text_color" : "#FFFFFF",
  "description": "Documentation",
  "description_html": "Documentation",
  "open_issues_count": 1,
  "closed_issues_count": 0,
  "open_merge_requests_count": 2,
  "subscribed": false,
  "priority": null,
  "is_project_label": true
}

참고: 매개변수에 name 또는 label_id가 포함된 이전 엔드포인트 PUT /projects/:id/labels는 여전히 사용 가능하지만, 더 이상 권장되지 않습니다.

프로젝트 레이블을 그룹 레이블로 승격

프로젝트 레이블을 그룹 레이블로 승격합니다. 레이블은 ID를 유지합니다.

PUT /projects/:id/labels/:label_id/promote

속성	유형	필수 여부	설명
`id`	정수 또는 문자열	예	프로젝트의 ID 또는 URL 인코딩된 경로
`label_id`	정수 또는 문자열	예	그룹 레이블의 ID 또는 제목.

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/labels/documentation/promote"

예시 응답:

{
  "id" : 8,
  "name" : "documentation",
  "color" : "#8E44AD",
  "description": "Documentation",
  "description_html": "Documentation",
  "open_issues_count": 1,
  "closed_issues_count": 0,
  "open_merge_requests_count": 2,
  "subscribed": false
}

참고: 매개변수에 name이 포함된 이전 엔드포인트 PUT /projects/:id/labels/promote는 여전히 사용 가능하지만, 더 이상 권장되지 않습니다.

라벨 구독하기

인증된 사용자를 라벨에 구독하여 알림을 받습니다.

사용자가 이미 라벨에 구독되어 있는 경우, 상태 코드 304가 반환됩니다.

POST /projects/:id/labels/:label_id/subscribe

속성	유형	필수	설명
`id`	정수 또는 문자열	예	프로젝트의 ID 또는 URL 인코딩된 경로
`label_id`	정수 또는 문자열	예	프로젝트 라벨의 ID 또는 제목

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/labels/1/subscribe"

예시 응답:

{
  "id" : 1,
  "name" : "bug",
  "color" : "#d9534f",
  "text_color" : "#FFFFFF",
  "description": "사용자가 보고한 버그",
  "description_html": "사용자가 보고한 버그",
  "open_issues_count": 1,
  "closed_issues_count": 0,
  "open_merge_requests_count": 1,
  "subscribed": true,
  "priority": null,
  "is_project_label": true
}

라벨 구독 취소하기

인증된 사용자가 라벨에서 구독을 취소하여 더 이상 알림을 받지 않습니다.

사용자가 라벨에 구독되어 있지 않은 경우, 상태 코드 304가 반환됩니다.

POST /projects/:id/labels/:label_id/unsubscribe

속성	유형	필수	설명
`id`	정수 또는 문자열	예	프로젝트의 ID 또는 URL 인코딩된 경로
`label_id`	정수 또는 문자열	예	프로젝트 라벨의 ID 또는 제목

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/labels/1/unsubscribe"

레이블 API

레이블 목록

단일 프로젝트 레이블 가져오기

새 레이블 생성

레이블 삭제

기존 레이블 편집

프로젝트 레이블을 그룹 레이블로 승격

라벨 구독하기

라벨 구독 취소하기

도움말

기능 사용 가능성과 제품 평가판

도움받기