이모지 반응 API

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

GitLab 16.0에서 “상장 이모지”가 “이모지 반응”으로 이름이 변경되었습니다.

이모지 반응은 천 개의 말을 할 수 있습니다.

우리는 여러분이 이모지로 반응할 수 있는 GitLab 오브젝트를 “상장 가능”이라고 부릅니다. 다음에 대해 이모지로 반응할 수 있습니다:

이슈, Merge Request, 스니펫

이 엔드포인트를 코멘트와 함께 사용하는 정보는 코멘트에 반응 추가를 참조하세요.

상장 가능의 이모지 반응 디렉터리

GitLab 15.1에서는 공개 상장 가능에 대한 인증되지 않은 액세스를 허용하도록 변경되었습니다.

지정된 상장 가능에 대한 모든 이모지 반응 디렉터리을 가져옵니다. 이 엔드포인트는 상장 가능이 공개적으로 접근 가능한 경우에는 인증 없이 액세스할 수 있습니다. 

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 정수 예 상장 가능의 ID (이슈 및 Merge Request의 iid, 스니펫의 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": "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-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에서는 공개 상장 가능에 대한 인증되지 않은 액세스를 허용하도록 변경되었습니다.

이슈, 스니펫 또는 Merge Request에서 단일 이모지 반응을 가져옵니다. 이 엔드포인트는 상장 가능이 공개적으로 접근 가능한 경우에는 인증 없이 액세스할 수 있습니다. 

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 Request의 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"
}

새로운 이모지 반응 추가

지정된 수상 가능한(awardable)에 이모지 반응을 추가합니다. 

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 (중요한 문제의 iid, 스니펫의 id에 대한 iid, 이슈의 id에 대한 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 정수/문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로
issue_iid/merge_request_iid/snippet_id 정수 예 수상 가능한의 ID (중요한 문제의 iid, 스니펫의 id에 대한 iid, 이슈의 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/344"

댓글에 반응 추가

댓글(또는 노트)은 문제, Merge Request 및 스니펫의 하위 리소스입니다.

note
아래 예시는 이슈 댓글에 이모지 반응을 다루는 내용이지만 이를 Merge Request 및 스니펫의 댓글로 변형할 수 있습니다. 따라서 issue_iid를 merge_request_iid 또는 snippet_id로 대체해야 합니다.

댓글의 이모지 반응 디렉터리

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

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

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

매개변수:

속성 유형 필수 설명
id 정수/문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로
issue_iid 정수 예 이슈의 내부 ID
note_id 정수 예 댓글(노트)의 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"