Draft Notes API

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

드래프트 노트는 MR(병합 요청)에 대한 보류 중인 미게시된 코멘트입니다. 이들은 토론을 시작하거나 기존 토론에 회신으로 연결될 수 있습니다. 발행되기 전까지 저자만 볼 수 있습니다.

모든 병합 요청 드래프트 노트 나열

특정 병합 요청에 대한 모든 드래프트 노트 목록을 가져옵니다. 

GET /projects/:id/merge_requests/:merge_request_iid/draft_notes
속성 유형 필수여부 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로
merge_request_iid 정수 예 프로젝트 병합 요청의 IID 
[{
  id: 5,
  author_id: 23,
  merge_request_id: 11,
  resolve_discussion: false,
  discussion_id: nil,
  note: "예시 제목",
  commit_id: nil,
  line_code: nil,
  position:
  {
    base_sha: nil,
    start_sha: nil,
    head_sha: nil,
    old_path: nil,
    new_path: nil,
    position_type: "text",
    old_line: nil,
    new_line: nil,
    line_range: nil
  }
}]

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/14/merge_requests/11/draft_notes"

단일 드래프트 노트 얻기

특정 병합 요청에 대한 하나의 드래프트 노트를 반환합니다. 

GET /projects/:id/merge_requests/:merge_request_iid/draft_notes/:draft_note_id
속성 유형 필수여부 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로.
draft_note_id 정수 예 드래프트 노트의 ID.
merge_request_iid 정수 예 프로젝트 병합 요청의 IID. 
{
  id: 5,
  author_id: 23,
  merge_request_id: 11,
  resolve_discussion: false,
  discussion_id: nil,
  note: "예시 제목",
  commit_id: nil,
  line_code: nil,
  position:
  {
    base_sha: nil,
    start_sha: nil,
    head_sha: nil,
    old_path: nil,
    new_path: nil,
    position_type: "text",
    old_line: nil,
    new_line: nil,
    line_range: nil
  }
}

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/14/merge_requests/11/draft_notes/5"

드래프트 노트 생성

특정 병합 요청에 대한 드래프트 노트를 생성합니다. 

POST /projects/:id/merge_requests/:merge_request_iid/draft_notes
속성 유형 필수여부 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로.
merge_request_iid 정수 예 프로젝트 병합 요청의 IID.
note 문자열 예 노트의 내용.
commit_id 문자열 아니요 드래프트 노트를 연관시킬 커밋의 SHA.
in_reply_to_discussion_id 문자열 아니요 드래프트 노트가 회신하는 토론의 ID.
resolve_discussion 부울 아니요 관련된 토론을 해결해야 합니다.
position[base_sha] 문자열 예 소스 브랜치의 기본 커밋 SHA.
position[head_sha] 문자열 예 본 병합 요청의 HEAD를 참조하는 SHA.
position[start_sha] 문자열 예 대상 브랜치의 커밋을 참조하는 SHA.
position[new_path] 문자열 예 (위치 유형이 text인 경우) 변경 후의 파일 경로.
position[old_path] 문자열 예 (위치 유형이 text인 경우) 변경 전의 파일 경로.
position[position_type] 문자열 예 위치 참조의 유형. 허용된 값: text 또는 image.
position 해시 아니요 차이 노트를 생성할 때 위치.
position[new_line] 정수 아니요 text 차이 노트의 경우, 변경 후의 줄 번호.
position[old_line] 정수 아니요 text 차이 노트의 경우, 변경 전의 줄 번호.
position[line_range] 해시 아니요 다중 줄 차이 노트의 줄 범위.
position[width] 정수 아니요 image 차이 노트의 이미지 너비.
position[height] 정수 아니요 image 차이 노트의 이미지 높이.
position[x] 부동소수점 아니요 image 차이 노트의 X 좌표.
position[y] 부동소수점 아니요 image 차이 노트의 Y 좌표. 
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/14/merge_requests/11/draft_notes?note=note"

기존 드래프트 노트 수정

주어진 머지 리퀘스트에 대한 드래프트 노트를 수정합니다. 

PUT /projects/:id/merge_requests/:merge_request_iid/draft_notes/:draft_note_id
속성 유형 필수 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로.
draft_note_id 정수 예 드래프트 노트의 ID.
merge_request_iid 정수 예 프로젝트 머지 리퀘스트의 IID.
note 문자열 아니요 노트의 내용.
position[base_sha] 문자열 예 소스 브랜치의 기본 커밋 SHA.
position[head_sha] 문자열 예 해당 머지 리퀘스트의 HEAD를 참조하는 SHA.
position[start_sha] 문자열 예 대상 브랜치의 커밋을 참조하는 SHA.
position[new_path] 문자열 예 (position 유형이 text인 경우) 변경 후 파일 경로.
position[old_path] 문자열 예 (position 유형이 text인 경우) 변경 전 파일 경로.
position[position_type] 문자열 예 위치 참조의 유형. 허용된 값: text 또는 image.
position 해시 아니요 차이 노트를 작성할 때 위치.
position[new_line] 정수 아니요 text 차이 노트의 경우, 변경 후 라인 번호.
position[old_line] 정수 아니요 text 차이 노트의 경우, 변경 전 라인 번호.
position[line_range] 해시 아니요 다중 라인 차이 노트의 라인 범위.
position[width] 정수 아니요 image 차이 노트의 이미지 너비.
position[height] 정수 아니요 image 차이 노트의 이미지 높이.
position[x] 부동 소수점 수 아니요 image 차이 노트의 X 좌표.
position[y] 부동 소수점 수 아니요 image 차이 노트의 Y 좌표. 
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/14/merge_requests/11/draft_notes/5"

드래프트 노트 삭제

주어진 머지 리퀘스트에 대한 기존 드래프트 노트를 삭제합니다. 

DELETE /projects/:id/merge_requests/:merge_request_iid/draft_notes/:draft_note_id
속성 유형 필수 설명
draft_note_id 정수 예 드래프트 노트의 ID.
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로.
merge_request_iid 정수 예 프로젝트 머지 리퀘스트의 IID. 
curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/14/merge_requests/11/draft_notes/5"

드래프트 노트 발행

주어진 머지 리퀘스트에 대한 기존 드래프트 노트를 발행합니다. 

PUT /projects/:id/merge_requests/:merge_request_iid/draft_notes/:draft_note_id/publish
속성 유형 필수 설명
draft_note_id 정수 예 드래프트 노트의 ID.
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로.
merge_request_iid 정수 예 프로젝트 머지 리퀘스트의 IID. 
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/14/merge_requests/11/draft_notes/5/publish"

보류 중인 모든 드래프트 노트 발행

사용자에 속한 주어진 머지 리퀘스트에 대한 모든 기존 드래프트 노트를 일괄 발행합니다. 

POST /projects/:id/merge_requests/:merge_request_iid/draft_notes/bulk_publish
속성 유형 필수 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로.
merge_request_iid 정수 예 프로젝트 머지 리퀘스트의 IID. 
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/14/merge_requests/11/draft_notes/bulk_publish"