그룹 레이블 API

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

이 API는 그룹 레이블 관리를 지원합니다.
사용자는 그룹 레이블을 나열, 생성, 업데이트 및 삭제할 수 있습니다.
또한 사용자들은 그룹 레이블에 구독 및 구독 해지가 가능합니다.

그룹 레이블 목록

주어진 그룹의 모든 레이블을 가져옵니다.

GET /groups/:id/labels

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

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`	integer or string	yes	그룹의 ID 또는 URL 인코딩된 경로.
`label_id`	integer or string	yes	그룹 레이블의 ID 또는 제목입니다.
`include_ancestor_groups`	boolean	no	조상 그룹 포함. 기본값은 `true`입니다.
`include_descendant_groups`	boolean	no	자손 그룹 포함. 기본값은 `false`입니다.
`only_group_labels`	boolean	no	그룹 레이블만 포함할지 또는 프로젝트 레이블도 포함할지 전환합니다. 기본값은 `true`입니다.

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진수 색상(예: #FFAABB) 또는 CSS 색상 이름 중 하나
`description`	문자열	아니오	레이블의 설명

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" \
     --data '{"name": "Feature Proposal", "color": "#FFA500", "description": "Describes new ideas" }' \
     "https://gitlab.example.com/api/v4/groups/5/labels"

예시 응답:

{
  "id": 9,
  "name": "Feature Proposal",
  "color": "#FFA500",
  "text_color" : "#FFFFFF",
  "description": "Describes new ideas",
  "description_html": "Describes new ideas",
  "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진수 색상(예: #FFAABB) 또는 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": "Describes new ideas",
  "description_html": "Describes new ideas",
  "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"

구형 엔드포인트 DELETE /groups/:id/labels는 매개변수에 name이 포함되어 여전히 사용 가능하지만, 더 이상 사용하지 않는 것으로 표시되었습니다.

그룹 레이블 구독

인증된 사용자를 그룹 레이블에 구독하여 알림을 받습니다. 사용자가 이미 레이블에 구독되어 있는 경우 상태 코드 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": "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
}

그룹 레이블 API

그룹 레이블 목록

단일 그룹 레이블 가져오기

새 그룹 레이블 만들기

그룹 레이블 업데이트

그룹 레이블 삭제

그룹 레이블 구독

그룹 레이블 구독 취소

도움말

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

도움받기