이모지 반응 API
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
이 API를 사용하여 이모지 반응을 관리합니다. 이모지 반응을 허용하는 GitLab 객체를 awardable이라고 합니다. 댓글과 이 엔드포인트를 사용하는 방법은 댓글에 반응 추가를 참조하세요. 지정된 이슈, 스니펫 또는 머지 리퀘스트의 모든 이모지 반응을 나열합니다.
히스토리
- GitLab 16.0에서 "award emoji"에서 "emoji reactions"로 이름이 변경되었습니다.
이 API를 사용하여 이모지 반응을 관리합니다.
이모지 반응을 허용하는 GitLab 객체를 awardable이라고 합니다. 다음 리소스에서 이모지로 반응할 수 있습니다:
이슈, 머지 리퀘스트 및 스니펫#
댓글과 이 엔드포인트를 사용하는 방법은 댓글에 반응 추가를 참조하세요.
리소스의 모든 이모지 반응 나열#
히스토리
- GitLab 15.1에서 공개 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 (머지 리퀘스트/이슈의 경우 iid, 스니펫의 경우 id). |
요청 예시:
curl --request GET \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "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에서 공개 awardable에 대한 미인증 접근을 허용하도록 변경되었습니다.
이슈, 스니펫 또는 머지 리퀘스트에서 지정된 이모지 반응을 조회합니다. awardable이 공개적으로 접근 가능한 경우 이 엔드포인트는 인증 없이 접근할 수 있습니다.
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 |
정수 | 예 | awardable의 ID (머지 리퀘스트/이슈의 경우 iid, 스니펫의 경우 id). |
award_id |
정수 | 예 | 이모지 반응의 ID. |
요청 예시:
curl --request GET \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "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 |
정수 | 예 | awardable의 ID (머지 리퀘스트/이슈의 경우 iid, 스니펫의 경우 id). |
name |
문자열 | 예 | 콜론 없이 이모지의 이름. |
curl --request POST \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "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 |
정수 | 예 | awardable의 ID (머지 리퀘스트/이슈의 경우 iid, 스니펫의 경우 id). |
award_id |
정수 | 예 | 이모지 반응의 ID. |
curl --request DELETE \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "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 |
정수 또는 문자열 | 예 | 프로젝트의 ID 또는 URL-인코딩된 경로. |
issue_iid |
정수 | 예 | 이슈의 내부 ID. |
note_id |
정수 | 예 | 댓글(노트)의 ID. |
요청 예시:
curl --request GET \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "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 --request GET \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "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>" \
--url "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>" \
--url "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/345"
