Draft Notes API

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

Draft notes는 보류 중이며, 미게시된 합병 요청에 대한 코멘트입니다. 토론을 시작하거나 기존 토론에 답변으로 연결될 수 있습니다. 발행되기 전까지는 작성자만 볼 수 있습니다.

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

특정 합병 요청의 모든 드래프트 노트 디렉터리을 가져옵니다. 

GET /projects/:id/merge_requests/:merge_request_iid/draft_notes
속성 유형 필수 여부 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL-encoded path
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-encoded path
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-encoded path
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] 문자열 예 (position 타입이 text인 경우) 변경 후의 파일 경로
position[old_path] 문자열 예 (position 타입이 text인 경우) 변경 전의 파일 경로
position[position_type] 문자열 예 위치 참조의 유형. 허용된 값: text 또는 image.
position 해시 아니요 diff 노트를 만들 때의 위치
position[new_line] 정수 아니요 text diff 노트의 경우, 변경 후의 줄 번호
position[old_line] 정수 아니요 text diff 노트의 경우, 변경 전의 줄 번호
position[line_range] 해시 아니요 다중 라인 diff 노트의 라인 범위
position[width] 정수 아니요 image diff 노트의 이미지 너비
position[height] 정수 아니요 image diff 노트의 이미지 높이
position[x] 부동소수점 아니요 image diff 노트의 X 좌표
position[y] 부동소수점 아니요 image diff 노트의 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-encoded path
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 해시 아니요 diff 노트를 만들 때의 위치
position[new_line] 정수 아니요 text diff 노트의 경우, 변경 후의 줄 번호
position[old_line] 정수 아니요 text diff 노트의 경우, 변경 전의 줄 번호
position[line_range] 해시 아니요 다중 라인 diff 노트의 라인 범위
position[width] 정수 아니요 image diff 노트의 이미지 너비
position[height] 정수 아니요 image diff 노트의 이미지 높이
position[x] 부동소수점 아니요 image diff 노트의 X 좌표
position[y] 부동소수점 아니요 image diff 노트의 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"

드래프트 노트 삭제

주어진 Merge Request에 대한 기존의 드래프트 노트를 삭제합니다. 

DELETE /projects/:id/merge_requests/:merge_request_iid/draft_notes/:draft_note_id
속성 유형 필수 설명
draft_note_id 정수 예 드래프트 노트의 ID입니다.
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로입니다.
merge_request_iid 정수 예 프로젝트 Merge Request의 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"

드래프트 노트 발행

주어진 Merge Request에 대한 기존의 드래프트 노트를 발행합니다. 

PUT /projects/:id/merge_requests/:merge_request_iid/draft_notes/:draft_note_id/publish
속성 유형 필수 설명
draft_note_id 정수 예 드래프트 노트의 ID입니다.
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로입니다.
merge_request_iid 정수 예 프로젝트 Merge Request의 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"

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

사용자에 속한 주어진 Merge Request의 모든 기존 드래프트 노트를 일괄 발행합니다. 

POST /projects/:id/merge_requests/:merge_request_iid/draft_notes/bulk_publish
속성 유형 필수 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로입니다.
merge_request_iid 정수 예 프로젝트 Merge Request의 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"