이모지 반응 API

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

이름 변경됨 “award emoji”에서 “emoji reactions”로 GitLab 16.0에서.

이모지 반응은 천 마디의 말을 전달합니다.

우리는 이모지로 반응할 수 있는 GitLab 객체를 “awardables”라고 부릅니다.

다음에서 이모지로 반응할 수 있습니다:

Issues, merge requests, and snippets

이러한 엔드포인트를 코멘트와 함께 사용하는 방법에 대한 정보는 코멘트에 반응 추가를 참조하십시오.

awardable의 이모지 반응 목록

  • 변경됨 GitLab 15.1에서 공개 awardables에 대한 비인증 액세스를 허용합니다.

지정된 awardable의 모든 이모지 반응 목록을 가져옵니다. 이 엔드포인트는 awardable이 공개적으로 액세스 가능할 경우 인증 없이 액세스할 수 있습니다.

GET /projects/:id/issues/:issue_iid/award_emoji  
GET /projects/:id/merge_requests/:merge_request_iid/award_emoji  
GET /projects/:id/snippets/:snippet_id/award_emoji

매개변수:

속성 유형 필수 여부 설명
id 정수/문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로.
issue_iid/merge_request_iid/snippet_id 정수 예 awardable의 ID(merge requests/issues의 경우 iid, snippets의 경우 id`).

예시 요청:

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji"

예시 응답:

[  
  {  
    "id": 4,  
    "name": "1234",  
    "user": {  
      "name": "관리자",  
      "username": "root",  
      "id": 1,  
      "state": "active",  
      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",  
      "web_url": "http://gitlab.example.com/root"  
    },  
    "created_at": "2016-06-15T10:09:34.206Z",  
    "updated_at": "2016-06-15T10:09:34.206Z",  
    "awardable_id": 80,  
    "awardable_type": "Issue"  
  },  
  {  
    "id": 1,  
    "name": "microphone",  
    "user": {  
      "name": "User 4",  
      "username": "user4",  
      "id": 26,  
      "state": "active",  
      "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon",  
      "web_url": "http://gitlab.example.com/user4"  
    },  
    "created_at": "2016-06-15T10:09:34.177Z",  
    "updated_at": "2016-06-15T10:09:34.177Z",  
    "awardable_id": 80,  
    "awardable_type": "Issue"  
  }  
]

단일 이모지 반응 가져오기

  • GitLab 15.1에서 변경된 사항으로 인해 인증받지 않은 사용자가 공개 어워더블에 접근할 수 있습니다.

문제, 스니펫 또는 병합 요청에서 단일 이모지 반응을 가져옵니다. 이 엔드포인트는 어워더블이 공개적으로 접근 가능하면 인증 없이 접근할 수 있습니다.

GET /projects/:id/issues/:issue_iid/award_emoji/:award_id
GET /projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id
GET /projects/:id/snippets/:snippet_id/award_emoji/:award_id

매개변수:

속성 유형 필수 설명
id 정수/문자열 예 프로젝트의 ID 또는 URL 인코딩 경로.
issue_iid/merge_request_iid/snippet_id 정수 예 어워더블의 ID(merge requests/issues의 경우 iid, 스니펫의 경우 id).
award_id 정수 예 이모지 반응의 ID.

예제 요청:

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/1"

예제 응답:

{
  "id": 1,
  "name": "microphone",
  "user": {
    "name": "User 4",
    "username": "user4",
    "id": 26,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon",
    "web_url": "http://gitlab.example.com/user4"
  },
  "created_at": "2016-06-15T10:09:34.177Z",
  "updated_at": "2016-06-15T10:09:34.177Z",
  "awardable_id": 80,
  "awardable_type": "Issue"
}

새 이모지 반응 추가

지정된 어워더블에 이모지 반응을 추가합니다.

POST /projects/:id/issues/:issue_iid/award_emoji
POST /projects/:id/merge_requests/:merge_request_iid/award_emoji
POST /projects/:id/snippets/:snippet_id/award_emoji

매개변수:

속성 유형 필수 설명
id 정수/문자열 예 프로젝트의 ID 또는 URL 인코딩 경로.
issue_iid/merge_request_iid/snippet_id 정수 예 어워더블의 ID(merge requests/issues의 경우 iid, 스니펫의 경우 id).
name 문자열 예 콜론 없이 이모지의 이름. 
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji?name=blowfish"

예제 응답:

{
  "id": 344,
  "name": "blowfish",
  "user": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
    "web_url": "http://gitlab.example.com/root"
  },
  "created_at": "2016-06-17T17:47:29.266Z",
  "updated_at": "2016-06-17T17:47:29.266Z",
  "awardable_id": 80,
  "awardable_type": "Issue"
}

이모지 리액션 삭제

가끔은 정말 그럴 필요가 없고 리액션을 제거해야 할 필요가 있습니다.

이모지 리액션을 삭제할 수 있는 것은 관리자 또는 리액션의 작성자만 가능합니다.

DELETE /projects/:id/issues/:issue_iid/award_emoji/:award_id
DELETE /projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id
DELETE /projects/:id/snippets/:snippet_id/award_emoji/:award_id

매개변수:

속성 타입 필수 설명
id integer/string yes 프로젝트의 ID 또는 URL 인코딩된 경로입니다.
issue_iid/merge_request_iid/snippet_id integer yes 상의 별 또는 스니펫의 ID(merge requests/issues의 경우 iid, snippets의 경우 id)입니다.
award_id integer yes 이모지 리액션의 ID입니다. 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/344"

댓글에 리액션 추가

댓글(노트라고도 함)은 이슈, 병합 요청 및 스니펫의 하위 리소스입니다.

노트: 아래 예제는 이슈의 댓글에 대한 이모지 리액션 작업을 설명하지만, 병합 요청 및 스니펫의 댓글에도 적용할 수 있습니다. 따라서, issue_iid를 merge_request_iid 또는 snippet_id로 교체해야 합니다.

댓글의 이모지 리액션 목록

  • 변경됨 GitLab 15.1에서 공개 댓글에 대한 인증되지 않은 접근을 허용합니다.

댓글(노트)에 대한 모든 이모지 리액션을 가져옵니다. 이 엔드포인트는 댓글이 공개적으로 접근 가능할 경우 인증 없이 접근할 수 있습니다.

GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji

매개변수:

속성 타입 필수 설명
id integer/string yes 프로젝트의 ID 또는 URL 인코딩된 경로입니다.
issue_iid integer yes 이슈의 내부 ID입니다.
note_id integer yes 댓글(노트)의 ID입니다.

예제 요청:

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji"

예제 응답:

[
  {
    "id": 2,
    "name": "mood_bubble_lightning",
    "user": {
      "name": "User 4",
      "username": "user4",
      "id": 26,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon",
      "web_url": "http://gitlab.example.com/user4"
    },
    "created_at": "2016-06-15T10:09:34.197Z",
    "updated_at": "2016-06-15T10:09:34.197Z",
    "awardable_id": 1,
    "awardable_type": "Note"
  }
]

댓글에 대한 이모지 반응 받기

  • 변경됨 GitLab 15.1에서 공개 댓글에 대한 비인증 접근을 허용하도록.

댓글(노트)에 대한 단일 이모지 반응을 가져옵니다. 이 엔드포인트는 댓글이 공개적으로 접근 가능한 경우 인증 없이 접근할 수 있습니다.

GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id

매개변수:

속성 유형 필수 설명
id 정수/문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로.
issue_iid 정수 예 이슈의 내부 ID.
note_id 정수 예 댓글(노트)의 ID.
award_id 정수 예 이모지 반응의 ID.

예시 요청:

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji/2"

예시 응답:

{
  "id": 2,
  "name": "mood_bubble_lightning",
  "user": {
    "name": "User 4",
    "username": "user4",
    "id": 26,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon",
    "web_url": "http://gitlab.example.com/user4"
  },
  "created_at": "2016-06-15T10:09:34.197Z",
  "updated_at": "2016-06-15T10:09:34.197Z",
  "awardable_id": 1,
  "awardable_type": "Note"
}

댓글에 새로운 이모지 반응 추가하기

지정된 댓글(노트)에 이모지 반응을 생성합니다.

POST /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji

매개변수:

속성 유형 필수 설명
id 정수/문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로.
issue_iid 정수 예 이슈의 내부 ID.
note_id 정수 예 댓글(노트)의 ID.
name 문자열 예 콜론 없이 이모지의 이름.

예시 요청:

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji?name=rocket"

예시 응답:

{
  "id": 345,
  "name": "rocket",
  "user": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
    "web_url": "http://gitlab.example.com/root"
  },
  "created_at": "2016-06-17T19:59:55.888Z",
  "updated_at": "2016-06-17T19:59:55.888Z",
  "awardable_id": 1,
  "awardable_type": "Note"
}

댓글에서 이모지 반응 삭제하기

가끔은 운명이 아니어서 반응을 삭제해야 할 필요가 있습니다.

이모지 반응을 삭제할 수 있는 것은 관리자 또는 반응 작성자뿐입니다.

DELETE /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id

매개변수:

속성 유형 필수 설명
id 정수/문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로.
issue_iid 정수 예 이슈의 내부 ID.
note_id 정수 예 댓글(노트)의 ID.
award_id 정수 예 이모지 반응의 ID.

예시 요청:

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/345"