InfoGrab Docs

임시 메모 API

요약

이 API를 사용하여 임시 메모를 관리합니다. 게시 전에는 임시 메모가 작성자에게만 표시됩니다. 모든 머지 리퀘스트 임시 메모를 나열합니다. 머지 리퀘스트의 임시 메모를 조회합니다. 머지 리퀘스트의 임시 메모를 생성합니다.

이 API를 사용하여 임시 메모를 관리합니다. 임시 메모는 머지 리퀘스트에 대한 대기 중인 미게시 댓글입니다. 임시 메모는 토론을 시작하거나 답글로 기존 토론을 계속할 수 있습니다.

게시 전에는 임시 메모가 작성자에게만 표시됩니다.

모든 머지 리퀘스트 임시 메모 나열#

모든 머지 리퀘스트 임시 메모를 나열합니다.

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": null,
    "note": "Example title",
    "commit_id": null,
    "line_code": null,
    "position": {
      "base_sha": null,
      "start_sha": null,
      "head_sha": null,
      "old_path": null,
      "new_path": null,
      "position_type": "text",
      "old_line": null,
      "new_line": null,
      "line_range": null
    }
  }
]

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": null,
    "note": "Example title",
    "commit_id": null,
    "line_code": null,
    "position": {
      "base_sha": null,
      "start_sha": null,
      "head_sha": null,
      "old_path": null,
      "new_path": null,
      "position_type": "text",
      "old_line": null,
      "new_line": null,
      "line_range": null
    }
  }
]

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 해시 아니요 diff 메모 생성 시의 위치. 생략하면 일반 토론 메모가 생성됩니다.
position[base_sha] 문자열 예 (position이 제공된 경우) 소스 브랜치의 기본 커밋 SHA.
position[head_sha] 문자열 예 (position이 제공된 경우) 이 머지 리퀘스트의 HEAD를 참조하는 SHA.
position[start_sha] 문자열 예 (position이 제공된 경우) 대상 브랜치의 커밋을 참조하는 SHA.
position[new_path] 문자열 예 (위치 유형이 text인 경우) 변경 후의 파일 경로.
position[old_path] 문자열 예 (위치 유형이 text인 경우) 변경 전의 파일 경로.
position[position_type] 문자열 예 (position이 제공된 경우) 위치 참조의 유형. 허용되는 값: text, image 또는 file. file은 GitLab 16.4에서 도입되었습니다.
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-인코딩된 경로.
draft_note_id 정수 예 임시 메모의 ID.
merge_request_iid 정수 예 프로젝트 머지 리퀘스트의 IID.
note 문자열 아니요 메모의 내용.
position 해시 아니요 diff 메모 생성 시의 위치.
position[base_sha] 문자열 예 (position이 제공된 경우) 소스 브랜치의 기본 커밋 SHA.
position[head_sha] 문자열 예 (position이 제공된 경우) 이 머지 리퀘스트의 HEAD를 참조하는 SHA.
position[start_sha] 문자열 예 (position이 제공된 경우) 대상 브랜치의 커밋을 참조하는 SHA.
position[new_path] 문자열 예 (위치 유형이 text인 경우) 변경 후의 파일 경로.
position[old_path] 문자열 예 (위치 유형이 text인 경우) 변경 전의 파일 경로.
position[position_type] 문자열 예 (position이 제공된 경우) 위치 참조의 유형. 허용되는 값: text, image 또는 file. file은 GitLab 16.4에서 도입되었습니다.
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"

임시 메모 삭제#

머지 리퀘스트의 임시 메모를 삭제합니다.

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"

임시 메모 API

Tier: Free, Premium, Ultimate
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
원문 보기
요약

이 API를 사용하여 임시 메모를 관리합니다. 게시 전에는 임시 메모가 작성자에게만 표시됩니다. 모든 머지 리퀘스트 임시 메모를 나열합니다. 머지 리퀘스트의 임시 메모를 조회합니다. 머지 리퀘스트의 임시 메모를 생성합니다.

이 API를 사용하여 임시 메모를 관리합니다. 임시 메모는 머지 리퀘스트에 대한 대기 중인 미게시 댓글입니다. 임시 메모는 토론을 시작하거나 답글로 기존 토론을 계속할 수 있습니다.

게시 전에는 임시 메모가 작성자에게만 표시됩니다.

모든 머지 리퀘스트 임시 메모 나열#

모든 머지 리퀘스트 임시 메모를 나열합니다.

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": null,
    "note": "Example title",
    "commit_id": null,
    "line_code": null,
    "position": {
      "base_sha": null,
      "start_sha": null,
      "head_sha": null,
      "old_path": null,
      "new_path": null,
      "position_type": "text",
      "old_line": null,
      "new_line": null,
      "line_range": null
    }
  }
]

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": null,
    "note": "Example title",
    "commit_id": null,
    "line_code": null,
    "position": {
      "base_sha": null,
      "start_sha": null,
      "head_sha": null,
      "old_path": null,
      "new_path": null,
      "position_type": "text",
      "old_line": null,
      "new_line": null,
      "line_range": null
    }
  }
]

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 해시 아니요 diff 메모 생성 시의 위치. 생략하면 일반 토론 메모가 생성됩니다.
position[base_sha] 문자열 예 (position이 제공된 경우) 소스 브랜치의 기본 커밋 SHA.
position[head_sha] 문자열 예 (position이 제공된 경우) 이 머지 리퀘스트의 HEAD를 참조하는 SHA.
position[start_sha] 문자열 예 (position이 제공된 경우) 대상 브랜치의 커밋을 참조하는 SHA.
position[new_path] 문자열 예 (위치 유형이 text인 경우) 변경 후의 파일 경로.
position[old_path] 문자열 예 (위치 유형이 text인 경우) 변경 전의 파일 경로.
position[position_type] 문자열 예 (position이 제공된 경우) 위치 참조의 유형. 허용되는 값: text, image 또는 file. file은 GitLab 16.4에서 도입되었습니다.
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-인코딩된 경로.
draft_note_id 정수 예 임시 메모의 ID.
merge_request_iid 정수 예 프로젝트 머지 리퀘스트의 IID.
note 문자열 아니요 메모의 내용.
position 해시 아니요 diff 메모 생성 시의 위치.
position[base_sha] 문자열 예 (position이 제공된 경우) 소스 브랜치의 기본 커밋 SHA.
position[head_sha] 문자열 예 (position이 제공된 경우) 이 머지 리퀘스트의 HEAD를 참조하는 SHA.
position[start_sha] 문자열 예 (position이 제공된 경우) 대상 브랜치의 커밋을 참조하는 SHA.
position[new_path] 문자열 예 (위치 유형이 text인 경우) 변경 후의 파일 경로.
position[old_path] 문자열 예 (위치 유형이 text인 경우) 변경 전의 파일 경로.
position[position_type] 문자열 예 (position이 제공된 경우) 위치 참조의 유형. 허용되는 값: text, image 또는 file. file은 GitLab 16.4에서 도입되었습니다.
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"

임시 메모 삭제#

머지 리퀘스트의 임시 메모를 삭제합니다.

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"