그룹 라벨 API

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

- GitLab 11.8에서 소개되었습니다.

이 API는 그룹 라벨을 관리하는 데 도움이 됩니다. 사용자는 그룹 라벨을 나열, 생성, 업데이트 및 삭제할 수 있습니다. 더불어, 사용자는 그룹 라벨을 구독하거나 구독 취소할 수 있습니다.

description_html - GitLab 12.7의 응답 JSON에 추가되었습니다.

그룹 라벨 나열

특정 그룹에 대한 모든 라벨을 가져옵니다.

GET /groups/:id/labels

속성	유형	필수	설명
`id`	정수/문자열	예	인증된 사용자가 소유한 그룹의 ID 또는 URL-인코딩된 경로
`with_counts`	부울	아니오	이슈 및 병합 요청 개수를 포함할지 여부. 기본값은 `false` (GitLab 12.2에서 소개)
`include_ancestor_groups`	부울	아니오	조상 그룹을 포함할지 여부. 기본값은 `true`.
`include_descendant_groups`	부울	아니오	자손 그룹을 포함할지 여부. 기본값은 `false`. GitLab 13.6에서 소개
`only_group_labels`	부울	아니오	그룹 라벨만 포함할지 여부를 전환합니다. 기본값은 `true`. GitLab 13.6에서 소개
`search`	문자열	아니오	라벨을 키워드로 필터링합니다. GitLab 13.6에서 소개

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

응답 예시:

[
  {
    "id": 7,
    "name": "bug",
    "color": "#FF0000",
    "text_color" : "#FFFFFF",
    "description": null,
    "description_html": null,
    "open_issues_count": 0,
    "closed_issues_count": 0,
    "open_merge_requests_count": 0,
    "subscribed": false
  },
  {
    "id": 4,
    "name": "feature",
    "color": "#228B22",
    "text_color" : "#FFFFFF",
    "description": null,
    "description_html": null,
    "open_issues_count": 0,
    "closed_issues_count": 0,
    "open_merge_requests_count": 0,
    "subscribed": false
  }
]

단일 그룹 라벨 가져오기

특정 그룹의 단일 라벨을 가져옵니다.

GET /groups/:id/labels/:label_id

속성	유형	필수	설명
`id`	정수 또는 문자열	예	인증된 사용자가 소유한 그룹의 ID 또는 URL-인코딩된 경로
`label_id`	정수 또는 문자열	예	그룹의 라벨 ID 또는 제목
`include_ancestor_groups`	부울	아니오	조상 그룹을 포함할지 여부. 기본값은 `true`.
`include_descendant_groups`	부울	아니오	자손 그룹을 포함할지 여부. 기본값은 `false`. GitLab 13.6에서 소개
`only_group_labels`	부울	아니오	그룹 라벨만 포함할지 여부를 전환합니다. 기본값은 `true`. GitLab 13.6에서 소개

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

응답 예시:

{
  "id": 7,
  "name": "bug",
  "color": "#FF0000",
  "text_color" : "#FFFFFF",
  "description": null,
  "description_html": null,
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": false
}

그룹 레이블 생성

특정 그룹에 대한 새로운 그룹 레이블을 생성합니다.

POST /groups/:id/labels

속성	타입	필수	설명
`id`	정수/문자열	예	인증된 사용자가 소유한 그룹의 ID 또는 URL 인코딩된 경로
`name`	문자열	예	레이블의 이름
`color`	문자열	예	6자리 16진수로 표시된 레이블의 색상(‘#’ 기호로 시작) 또는 CSS 색상 이름 중 하나
`description`	문자열	아니요	레이블의 설명

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" \
     --data '{"name": "Feature Proposal", "color": "#FFA500", "description": "새로운 아이디어에 대한 설명" }' \
     "https://gitlab.example.com/api/v4/groups/5/labels"

응답 예시:

{
  "id": 9,
  "name": "Feature Proposal",
  "color": "#FFA500",
  "text_color" : "#FFFFFF",
  "description": "새로운 아이디어에 대한 설명",
  "description_html": "새로운 아이디어에 대한 설명",
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": false
}

그룹 레이블 업데이트

기존 그룹 레이블을 업데이트합니다. 그룹 레이블을 업데이트하려면 하나 이상의 매개변수가 필요합니다.

PUT /groups/:id/labels/:label_id

속성	타입	필수	설명
`id`	정수 또는 문자열	예	인증된 사용자가 소유한 그룹의 ID 또는 URL 인코딩된 경로
`label_id`	정수 또는 문자열	예	그룹 레이블의 ID 또는 제목
`new_name`	문자열	아니요	레이블의 새 이름
`color`	문자열	아니요	6자리 16진수로 표시된 레이블의 색상(‘#’ 기호로 시작) 또는 CSS 색상 이름 중 하나
`description`	문자열	아니요	레이블의 설명

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" \
     --data '{"new_name": "Feature Idea" }' "https://gitlab.example.com/api/v4/groups/5/labels/Feature%20Proposal"

응답 예시:

{
  "id": 9,
  "name": "Feature Idea",
  "color": "#FFA500",
  "text_color" : "#FFFFFF",
  "description": "새로운 아이디어에 대한 설명",
  "description_html": "새로운 아이디어에 대한 설명",
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": false
}

참고: 매개변수 중 name을 사용한 이전 엔드포인트인 PUT /groups/:id/labels는 여전히 사용 가능하지만 사용이 중지되었습니다.

그룹 레이블 삭제

지정된 이름의 그룹 레이블을 삭제합니다.

DELETE /groups/: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/groups/5/labels/bug"

참고: 매개변수 중 name을 사용한 이전 엔드포인트인 DELETE /groups/:id/labels는 여전히 사용 가능하지만 사용이 중지되었습니다.

그룹 레이블 구독

그룹 레이블에 대한 알림을 받기 위해 인증된 사용자를 해당 그룹 레이블에 구독시킵니다. 사용자가 이미 레이블을 구독했으면 상태 코드 304가 반환됩니다.

POST /groups/: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/groups/5/labels/9/subscribe"

응답 예시:

{
  "id": 9,
  "name": "Feature Idea",
  "color": "#FFA500",
  "text_color" : "#FFFFFF",
  "description": "새로운 아이디어에 대한 설명",
  "description_html": "새로운 아이디어에 대한 설명",
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": true
}

그룹 레이블 구독 취소

인증된 사용자가 그룹 레이블의 알림을 받지 않도록 하기 위해 그룹 레이블에서 구독을 해지합니다. 사용자가 해당 레이블에 구독되어 있지 않은 경우 상태 코드 304가 반환됩니다.

POST /groups/: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/groups/5/labels/9/unsubscribe"

예시 응답:

{
  "id": 9,
  "name": "기능 아이디어",
  "color": "#FFA500",
  "text_color" : "#FFFFFF",
  "description": "새로운 아이디어를 설명합니다",
  "description_html": "새로운 아이디어를 설명합니다",
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": false
}

그룹 라벨 API

그룹 라벨 나열

단일 그룹 라벨 가져오기

그룹 레이블 생성

그룹 레이블 업데이트

그룹 레이블 삭제

그룹 레이블 구독

그룹 레이블 구독 취소

도움말

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

도움받기