Draft Notes API

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

Draft notes는 미완료 상태의, 아직 발행되지 않은 병합 요청에 대한 코멘트입니다. 이들은 다음과 같습니다:

  • 토론을 시작합니다.
  • 기존 토론을 답글로 이어 나갑니다.

발행 전에, draft notes는 작성자에게만 보입니다.

모든 병합 요청 draft notes 열람

특정 병합 요청에 대한 모든 draft notes 목록을 가져옵니다. 

GET /projects/:id/merge_requests/:merge_request_iid/draft_notes
속성 타입 필수 설명
id integer 또는 string 예 프로젝트의 ID 또는 URL-encoded path
merge_request_iid integer 예 프로젝트 병합 요청의 IID 
[{
  id: 5,
  author_id: 23,
  merge_request_id: 11,
  resolve_discussion: false,
  discussion_id: nil,
  note: "Example title",
  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"

단일 draft note 가져오기

주어진 병합 요청에 대한 개별 draft note를 반환합니다. 

GET /projects/:id/merge_requests/:merge_request_iid/draft_notes/:draft_note_id
속성 타입 필수 설명
id integer 또는 string 예 프로젝트의 ID 또는 [URL-encoded path (rest/index.md#namespaced-paths)]
draft_note_id integer 예 draft note의 ID
merge_request_iid integer 예 프로젝트 병합 요청의 IID 
{
  id: 5,
  author_id: 23,
  merge_request_id: 11,
  resolve_discussion: false,
  discussion_id: nil,
  note: "Example title",
  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"

draft note 생성

주어진 병합 요청에 대한 draft note를 생성합니다. 

POST /projects/:id/merge_requests/:merge_request_iid/draft_notes
속성 타입 필수 설명
id integer 또는 string 예 프로젝트의 ID 또는 URL-encoded path.
merge_request_iid integer 예 프로젝트 병합 요청의 IID.
note string 예 note의 내용.
commit_id string 아니요 draft note를 연결할 commit의 SHA.
in_reply_to_discussion_id string 아니요 draft note가 응답하는 토론의 ID.
resolve_discussion boolean 아니요 연관된 토론을 해결해야 합니까?
position[base_sha] string 예 소스 브랜치의 기본 커밋 SHA.
position[head_sha] string 예 병합 요청의 HEAD를 가리키는 SHA.
position[start_sha] string 예 대상 브랜치에 있는 커밋을 가리키는 SHA.
position[new_path] string 예 (position 타입이 text인 경우) 변경 후 파일 경로.
position[old_path] string 예 (position 타입이 text인 경우) 변경 전 파일 경로.
position[position_type] string 예 위치 참조의 유형. 허용되는 값: text, image, 또는 file. file은 GitLab 16.4에서 도입되었습니다.
position 해시 아니요 diff note를 생성할 때의 위치.
position[new_line] integer 아니요 text diff notes의 경우 변경 후의 줄 번호.
position[old_line] integer 아니요 text diff notes의 경우 변경 전의 줄 번호.
position[line_range] 해시 아니요 다중 줄 diff note를 위한 줄 범위.
position[width] integer 아니요 image diff notes의 경우 이미지의 너비.
position[height] integer 아니요 image diff notes의 경우 이미지의 높이.
position[x] 실수 아니요 image diff notes의 경우 X 좌표.
position[y] 실수 아니요 image diff notes의 경우 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 또는 file. file은 GitLab 16.4에서 도입됨
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"