라벨 API

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-Managed, GitLab Dedicated

라벨을 REST API를 사용하여 상호 작용합니다.

라벨 목록

특정 프로젝트의 모든 라벨을 가져옵니다.

기본적으로 API 결과가 페이지 구성되기 때문에 기본적으로 한 번에 20개의 결과가 반환됩니다.

GET /projects/:id/labels

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

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

예시 응답:

[
  {
    "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
  },
  {
    "id" : 4,
    "color" : "#d9534f",
    "text_color" : "#FFFFFF",
    "name" : "confirmed",
    "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" : "critical",
    "color" : "#d9534f",
    "text_color" : "#FFFFFF",
    "description": "중요한 이슈. 최대한 빨리 수정해야 함",
    "description_html": "중요한 이슈. 최대한 빨리 수정해야 함",
    "open_issues_count": 1,
    "closed_issues_count": 3,
    "open_merge_requests_count": 1,
    "subscribed": false,
    "priority": null,
    "is_project_label": true
  },
  {
    "id" : 8,
    "name" : "documentation",
    "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" : "enhancement",
    "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`	정수 또는 문자열	예	프로젝트의 ID 또는 URL 인코딩된 경로
`label_id`	정수 또는 문자열	예	프로젝트의 라벨 ID 또는 타이틀
`include_ancestor_groups`	부울값	아니오	상위 그룹을 포함할지 여부. 기본값은 `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`	정수/문자열	예	프로젝트의 ID 또는 URL 인코딩된 경로
`name`	문자열	예	라벨의 이름
`color`	문자열	예	라벨의 색상 (예: #FFAABB와 같이 선행 ‘#’ 부호가 있는 6자리 16진수 표기법 또는 CSS 색상명 중 하나)
`description`	문자열	아니오	라벨의 설명
`priority`	정수	아니오	라벨의 우선순위. 0 이상이거나 `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`	정수 또는 문자열	예	프로젝트의 ID 또는 URL 인코딩된 경로
`label_id`	정수 또는 문자열	예	그룹 레이블의 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`	정수	아니오	레이블의 새 우선 순위. 제로 이상이거나 우선 순위를 제거하려면 `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": "Bug reported by user",
  "description_html": "Bug reported by user",
  "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

라벨 목록

단일 프로젝트 라벨 가져오기

새로운 라벨 생성

레이블 삭제

기존 레이블 편집

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

레이블 구독

레이블 구독 해지

도움말

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

도움받기