그룹 마일스톤 API
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
이 API를 사용하여 그룹 마일스톤을 관리합니다. 프로젝트 마일스톤은 프로젝트 마일스톤 API를 사용하세요. 기존 그룹 마일스톤을 업데이트합니다. 그룹에 대한 Developer 역할이 있는 사용자만 가능합니다. 단일 그룹 마일스톤에 할당된 모든 이슈를 가져옵니다.
이 API를 사용하여 그룹 마일스톤을 관리합니다.
프로젝트 마일스톤은 프로젝트 마일스톤 API를 사용하세요.
그룹 마일스톤 나열#
그룹 마일스톤 목록을 반환합니다.
GET /groups/:id/milestones
GET /groups/:id/milestones?iids[]=42
GET /groups/:id/milestones?iids[]=42&iids[]=43
GET /groups/:id/milestones?state=active
GET /groups/:id/milestones?state=closed
GET /groups/:id/milestones?title=1.0
GET /groups/:id/milestones?search=version
GET /groups/:id/milestones?search_title=17.3+17.4
GET /groups/:id/milestones?search_title=17.3%2017.4
GET /groups/:id/milestones?updated_before=2013-10-02T09%3A24%3A18Z
GET /groups/:id/milestones?updated_after=2013-10-02T09%3A24%3A18Z
GET /groups/:id/milestones?containing_date=2013-10-02T09%3A24%3A18Z
GET /groups/:id/milestones?start_date=2013-10-02T09%3A24%3A18Z&end_date=2013-11-02T09%3A24%3A18Z
파라미터:
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 또는 문자열 | yes | 그룹의 ID 또는 URL 인코딩된 경로. |
iids[] |
정수 배열 | no | 주어진 iid를 가진 마일스톤만 반환. include_ancestors가 true이면 무시됨. |
state |
문자열 | no | active 또는 closed 마일스톤만 반환. |
title |
문자열 | no | 주어진 title을 가진 마일스톤만 반환(대소문자 구분). |
search |
문자열 | no | 제공된 문자열과 제목 또는 설명이 일치하는 마일스톤만 반환(대소문자 구분 없음). |
search_title |
문자열 | no | 제공된 문자열과 제목이 일치하는 마일스톤만 반환(대소문자 구분 없음). 여러 단어를 + 또는 %20으로 구분하여 제공할 수 있으며 AND 조건으로 처리됩니다. 예: 17.4+17.5는 하위 문자열 17.4와 17.5를 순서에 상관없이 매칭합니다. GitLab 11.8에 도입됨. |
include_parent_milestones |
불리언 | no | GitLab 16.7에서 더 이상 사용되지 않음. 대신 include_ancestors를 사용하세요. |
include_ancestors |
불리언 | no | 모든 상위 그룹의 마일스톤을 포함. |
include_descendants |
불리언 | no | 그룹 및 해당 하위 항목의 마일스톤을 포함. GitLab 16.7에서 도입됨. |
updated_before |
날짜시간 | no | 주어진 날짜시간 이전에 업데이트된 마일스톤만 반환. ISO 8601 형식으로 예상(2019-03-15T08:00:00Z). GitLab 15.10에 도입됨. |
updated_after |
날짜시간 | no | 주어진 날짜시간 이후에 업데이트된 마일스톤만 반환. ISO 8601 형식으로 예상(2019-03-15T08:00:00Z). GitLab 15.10에 도입됨. |
containing_date |
날짜시간 | no | start_date <= containing_date <= due_date인 마일스톤만 반환. ISO 8601 형식으로 예상(2019-03-15T08:00:00Z). GitLab 13.5에 도입됨. |
start_date |
날짜시간 | no | due_date >= 제공된 start_date인 마일스톤만 반환. ISO 8601 형식으로 예상(2019-03-15T08:00:00Z). 참고: end_date도 제공된 경우에만 유효. GitLab 12.8에 도입됨. |
end_date |
날짜시간 | no | start_date <= 제공된 end_date인 마일스톤만 반환. ISO 8601 형식으로 예상(2019-03-15T08:00:00Z). 참고: start_date도 제공된 경우에만 유효. GitLab 12.8에 도입됨. |
curl --request GET \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/5/milestones"
예시 응답:
[
{
"id": 12,
"iid": 3,
"group_id": 16,
"title": "10.0",
"description": "Version",
"due_date": "2013-11-29",
"start_date": "2013-11-10",
"state": "active",
"updated_at": "2013-10-02T09:24:18Z",
"created_at": "2013-10-02T09:24:18Z",
"expired": false,
"web_url": "https://gitlab.com/groups/gitlab-org/-/milestones/42"
}
]
단일 마일스톤 가져오기#
단일 그룹 마일스톤을 가져옵니다.
GET /groups/:id/milestones/:milestone_id
파라미터:
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 또는 문자열 | yes | 그룹의 ID 또는 URL 인코딩된 경로 |
milestone_id |
정수 | yes | 그룹 마일스톤의 ID |
새 마일스톤 만들기#
새 그룹 마일스톤을 만듭니다.
POST /groups/:id/milestones
파라미터:
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 또는 문자열 | yes | 그룹의 ID 또는 URL 인코딩된 경로 |
title |
문자열 | yes | 마일스톤의 제목 |
description |
문자열 | no | 마일스톤의 설명 |
due_date |
날짜 | no | ISO 8601 형식(YYYY-MM-DD)의 마일스톤 마감일 |
start_date |
날짜 | no | ISO 8601 형식(YYYY-MM-DD)의 마일스톤 시작일 |
마일스톤 편집#
기존 그룹 마일스톤을 업데이트합니다.
PUT /groups/:id/milestones/:milestone_id
파라미터:
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 또는 문자열 | yes | 그룹의 ID 또는 URL 인코딩된 경로 |
milestone_id |
정수 | yes | 그룹 마일스톤의 ID |
title |
문자열 | no | 마일스톤의 제목 |
description |
문자열 | no | 마일스톤의 설명 |
due_date |
날짜 | no | ISO 8601 형식(YYYY-MM-DD)의 마일스톤 마감일 |
start_date |
날짜 | no | ISO 8601 형식(YYYY-MM-DD)의 마일스톤 시작일 |
state_event |
문자열 | no | 마일스톤의 상태 이벤트 (close 또는 activate) |
그룹 마일스톤 삭제#
그룹에 대한 Developer 역할이 있는 사용자만 가능합니다.
DELETE /groups/:id/milestones/:milestone_id
파라미터:
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 또는 문자열 | yes | 그룹의 ID 또는 URL 인코딩된 경로 |
milestone_id |
정수 | yes | 그룹 마일스톤의 ID |
단일 마일스톤에 할당된 모든 이슈 가져오기#
단일 그룹 마일스톤에 할당된 모든 이슈를 가져옵니다.
GET /groups/:id/milestones/:milestone_id/issues
파라미터:
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 또는 문자열 | yes | 그룹의 ID 또는 URL 인코딩된 경로 |
milestone_id |
정수 | yes | 그룹 마일스톤의 ID |
현재 이 API 엔드포인트는 하위 그룹의 이슈를 반환하지 않습니다.
모든 마일스톤의 이슈를 가져오려면 이슈 나열 API를 사용하고
특정 마일스톤을 필터링하면 됩니다(예: GET /issues?milestone=1.0.0&state=opened).
단일 마일스톤에 할당된 모든 머지 리퀘스트 가져오기#
단일 그룹 마일스톤에 할당된 모든 머지 리퀘스트를 가져옵니다.
GET /groups/:id/milestones/:milestone_id/merge_requests
파라미터:
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 또는 문자열 | yes | 그룹의 ID 또는 URL 인코딩된 경로 |
milestone_id |
정수 | yes | 그룹 마일스톤의 ID |
단일 마일스톤의 모든 번다운 차트 이벤트 가져오기#
단일 마일스톤의 모든 번다운 차트 이벤트를 가져옵니다.
GET /groups/:id/milestones/:milestone_id/burndown_events
파라미터:
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 또는 문자열 | yes | 그룹의 ID 또는 URL 인코딩된 경로 |
milestone_id |
정수 | yes | 그룹 마일스톤의 ID |
