프로젝트 마일스톤 API

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

REST API를 사용하여 프로젝트 마일스톤을 활용하세요. 별도의 그룹 마일스톤 API 페이지도 있습니다.

프로젝트 마일스톤 디렉터리

프로젝트 마일스톤 디렉터리을 반환합니다. 

GET /projects/:id/milestones
GET /projects/:id/milestones?iids[]=42
GET /projects/:id/milestones?iids[]=42&iids[]=43
GET /projects/:id/milestones?state=active
GET /projects/:id/milestones?state=closed
GET /projects/:id/milestones?title=1.0
GET /projects/:id/milestones?search=version
GET /projects/:id/milestones?updated_before=2013-10-02T09%3A24%3A18Z
GET /projects/:id/milestones?updated_after=2013-10-02T09%3A24%3A18Z

매개변수:

속성 유형 필수 여부 설명
id 정수 또는 문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로
iids[] 정수 배열 아니요 주어진 iid를 가진 마일스톤만 반환합니다. include_ancestors가 true인 경우에는 무시됩니다.
state 문자열 아니요 active 또는 closed 상태의 마일스톤만 반환합니다.
title 문자열 아니요 주어진 title을 가진 마일스톤만 반환합니다.
search 문자열 아니요 제공된 문자열과 일치하는 제목 또는 설명을 가진 마일스톤만 반환합니다.
include_parent_milestones 부울 아니요 GitLab 16.7에서 사용이 중단되었습니다. 대신 include_ancestors를 사용하세요.
include_ancestors 부울 아니요 모든 상위 그룹에서 마일스톤을 포함합니다.
updated_before 날짜 및 시간 아니요 주어진 날짜 및 시간 이전에 업데이트된 마일스톤만 반환합니다. ISO 8601 형식(2019-03-15T08:00:00Z)으로 예상됩니다. GitLab 15.10에서 도입되었습니다.
updated_after 날짜 및 시간 아니요 주어진 날짜 및 시간 이후에 업데이트된 마일스톤만 반환합니다. ISO 8601 형식(2019-03-15T08:00:00Z)으로 예상됩니다. GitLab 15.10에서 도입되었습니다. 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/milestones"

예시 응답: 

[
  {
    "id": 12,
    "iid": 3,
    "project_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
  }
]

단일 마일스톤 가져오기

단일 프로젝트 마일스톤을 가져옵니다. 

GET /projects/:id/milestones/:milestone_id

매개변수:

속성 유형 필수 여부 설명
id 정수 또는 문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로
milestone_id 정수 예 프로젝트 마일스톤의 ID

새 마일스톤 생성

새로운 프로젝트 마일스톤을 생성합니다. 

POST /projects/:id/milestones

매개변수:

속성 유형 필수 여부 설명
id 정수 또는 문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로
title 문자열 예 마일스톤의 제목
description 문자열 아니요 마일스톤의 설명
due_date 문자열 아니요 마일스톤의 마감일 (YYYY-MM-DD)
start_date 문자열 아니요 마일스톤의 시작일 (YYYY-MM-DD)

마일스톤 수정

기존의 프로젝트 마일스톤을 업데이트합니다. 

PUT /projects/:id/milestones/:milestone_id

매개변수:

속성 유형 필수 여부 설명
id 정수 또는 문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로
milestone_id 정수 예 프로젝트 마일스톤의 ID
title 문자열 아니요 마일스톤의 제목
description 문자열 아니요 마일스톤의 설명
due_date 문자열 아니요 마일스톤의 마감일 (YYYY-MM-DD)
start_date 문자열 아니요 마일스톤의 시작일 (YYYY-MM-DD)
state_event 문자열 아니요 마일스톤의 상태 이벤트(닫기 또는 활성화)

프로젝트 마일스톤 삭제

  • Changed 15.0에서 최소 사용자 역할을 개발자에서 기고자로 변경했습니다.

프로젝트에 기여자 역할을 적어도 가진 사용자만 가능합니다. 

DELETE /projects/:id/milestones/:milestone_id

매개변수:

속성 유형 필수 여부 설명
id 정수 또는 문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로
milestone_id 정수 예 프로젝트 마일스톤의 ID

단일 마일스톤에 할당된 모든 이슈 가져오기

단일 프로젝트 마일스톤에 할당된 모든 이슈를 가져옵니다. 

GET /projects/:id/milestones/:milestone_id/issues

매개변수:

속성 유형 필수 여부 설명
id 정수 또는 문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로
milestone_id 정수 예 프로젝트 마일스톤의 ID

단일 마일스톤에 할당된 모든 Merge Request 가져오기

단일 프로젝트 마일스톤에 할당된 모든 Merge Request을 가져옵니다. 

GET /projects/:id/milestones/:milestone_id/merge_requests

매개변수:

속성 유형 필수 여부 설명
id 정수 또는 문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로
milestone_id 정수 예 프로젝트 마일스톤의 ID

프로젝트 마일스톤을 그룹 마일스톤으로 승격

  • 변경됨 GitLab 15.0에서 최소 사용자 역할을 개발자에서 보고자로 변경했습니다.

그룹 내에서 적어도 기록자 역할을 가진 사용자만 가능합니다. 

POST /projects/:id/milestones/:milestone_id/promote

파라미터:

속성 타입 필수 여부 설명
id 정수 또는 문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로
milestone_id 정수 예 프로젝트의 마일스톤 ID

단일 마일스톤의 모든 버다운 차트 이벤트 가져오기

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

단일 마일스톤의 모든 버다운 차트 이벤트를 가져옵니다. 

GET /projects/:id/milestones/:milestone_id/burndown_events

파라미터:

속성 타입 필수 여부 설명
id 정수 또는 문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로
milestone_id 정수 예 프로젝트의 마일스톤 ID