debian-mirror-gitlab/doc/api/award_emoji.md

361 lines
13 KiB
Markdown
Raw Normal View History

2017-09-10 17:25:29 +05:30
# Award Emoji API
2016-06-22 15:30:34 +05:30
2020-03-09 13:42:32 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/4575) in GitLab 8.9. Snippet support added in 8.12.
2016-09-29 09:46:39 +05:30
2019-03-02 22:35:43 +05:30
An [awarded emoji](../user/award_emojis.md) tells a thousand words.
2016-06-22 15:30:34 +05:30
2019-03-02 22:35:43 +05:30
Emoji can be awarded on the following (known as "awardables"):
- [Issues](../user/project/issues/index.md) ([API](issues.md)).
- [Merge requests](../user/project/merge_requests/index.md) ([API](merge_requests.md)).
- [Snippets](../user/snippets.md) ([API](snippets.md)).
2020-03-09 13:42:32 +05:30
Emoji can also [be awarded](../user/award_emojis.md#award-emoji-for-comments) on comments (also known as notes). See also [Notes API](notes.md).
2016-06-22 15:30:34 +05:30
2016-09-29 09:46:39 +05:30
## Issues, merge requests, and snippets
2016-06-22 15:30:34 +05:30
2019-03-02 22:35:43 +05:30
See [Award Emoji on Comments](#award-emoji-on-comments) for information on using these endpoints with comments.
2016-06-22 15:30:34 +05:30
### List an awardable's award emoji
2019-03-02 22:35:43 +05:30
Get a list of all award emoji for a specified awardable.
2016-06-22 15:30:34 +05:30
2019-03-02 22:35:43 +05:30
```text
2017-08-17 22:00:37 +05:30
GET /projects/:id/issues/:issue_iid/award_emoji
GET /projects/:id/merge_requests/:merge_request_iid/award_emoji
2016-09-29 09:46:39 +05:30
GET /projects/:id/snippets/:snippet_id/award_emoji
2016-06-22 15:30:34 +05:30
```
Parameters:
2019-03-02 22:35:43 +05:30
| Attribute | Type | Required | Description |
|:---------------|:---------------|:---------|:-----------------------------------------------------------------------------|
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
2019-07-07 11:18:12 +05:30
| `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. |
2016-06-22 15:30:34 +05:30
2019-03-02 22:35:43 +05:30
Example request:
2020-03-09 13:42:32 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji
2016-06-22 15:30:34 +05:30
```
2019-03-02 22:35:43 +05:30
Example response:
2016-06-22 15:30:34 +05:30
```json
[
{
"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",
2016-11-03 12:29:30 +05:30
"web_url": "http://gitlab.example.com/root"
2016-06-22 15:30:34 +05:30
},
"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",
2016-11-03 12:29:30 +05:30
"web_url": "http://gitlab.example.com/user4"
2016-06-22 15:30:34 +05:30
},
"created_at": "2016-06-15T10:09:34.177Z",
"updated_at": "2016-06-15T10:09:34.177Z",
"awardable_id": 80,
"awardable_type": "Issue"
}
]
```
2016-09-13 17:45:13 +05:30
### Get single award emoji
2016-06-22 15:30:34 +05:30
2019-03-02 22:35:43 +05:30
Get a single award emoji from an issue, snippet, or merge request.
2016-06-22 15:30:34 +05:30
2019-03-02 22:35:43 +05:30
```text
2017-08-17 22:00:37 +05:30
GET /projects/:id/issues/:issue_iid/award_emoji/:award_id
GET /projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id
2016-09-29 09:46:39 +05:30
GET /projects/:id/snippets/:snippet_id/award_emoji/:award_id
2016-06-22 15:30:34 +05:30
```
Parameters:
2019-03-02 22:35:43 +05:30
| Attribute | Type | Required | Description |
|:---------------|:---------------|:---------|:-----------------------------------------------------------------------------|
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
2019-07-07 11:18:12 +05:30
| `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. |
2019-03-02 22:35:43 +05:30
| `award_id` | integer | yes | ID of the award emoji. |
Example request:
2016-06-22 15:30:34 +05:30
2020-03-09 13:42:32 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/1
2016-06-22 15:30:34 +05:30
```
2019-03-02 22:35:43 +05:30
Example response:
2016-06-22 15:30:34 +05:30
```json
{
"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",
2016-11-03 12:29:30 +05:30
"web_url": "http://gitlab.example.com/user4"
2016-06-22 15:30:34 +05:30
},
"created_at": "2016-06-15T10:09:34.177Z",
"updated_at": "2016-06-15T10:09:34.177Z",
"awardable_id": 80,
"awardable_type": "Issue"
}
```
### Award a new emoji
2019-03-02 22:35:43 +05:30
Create an award emoji on the specified awardable.
2016-06-22 15:30:34 +05:30
2019-03-02 22:35:43 +05:30
```text
2017-08-17 22:00:37 +05:30
POST /projects/:id/issues/:issue_iid/award_emoji
POST /projects/:id/merge_requests/:merge_request_iid/award_emoji
2016-09-29 09:46:39 +05:30
POST /projects/:id/snippets/:snippet_id/award_emoji
2016-06-22 15:30:34 +05:30
```
Parameters:
2019-03-02 22:35:43 +05:30
| Attribute | Type | Required | Description |
|:---------------|:---------------|:---------|:-----------------------------------------------------------------------------|
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
2019-07-07 11:18:12 +05:30
| `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. |
2019-03-02 22:35:43 +05:30
| `name` | string | yes | Name of the emoji without colons. |
2016-06-22 15:30:34 +05:30
2020-03-09 13:42:32 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji?name=blowfish
2016-06-22 15:30:34 +05:30
```
Example Response:
```json
{
"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",
2016-11-03 12:29:30 +05:30
"web_url": "http://gitlab.example.com/root"
2016-06-22 15:30:34 +05:30
},
"created_at": "2016-06-17T17:47:29.266Z",
"updated_at": "2016-06-17T17:47:29.266Z",
"awardable_id": 80,
"awardable_type": "Issue"
2017-08-17 22:00:37 +05:30
}
2016-06-22 15:30:34 +05:30
```
### Delete an award emoji
2019-03-02 22:35:43 +05:30
Sometimes it's just not meant to be and you'll have to remove the award.
2016-06-22 15:30:34 +05:30
2019-03-02 22:35:43 +05:30
NOTE: **Note:**
Only available to administrators or the author of the award.
```text
2017-08-17 22:00:37 +05:30
DELETE /projects/:id/issues/:issue_iid/award_emoji/:award_id
DELETE /projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id
2016-09-29 09:46:39 +05:30
DELETE /projects/:id/snippets/:snippet_id/award_emoji/:award_id
2016-06-22 15:30:34 +05:30
```
Parameters:
2019-03-02 22:35:43 +05:30
| Attribute | Type | Required | Description |
|:---------------|:---------------|:---------|:-----------------------------------------------------------------------------|
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
2019-07-07 11:18:12 +05:30
| `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. |
2019-03-02 22:35:43 +05:30
| `award_id` | integer | yes | ID of an award emoji. |
2016-06-22 15:30:34 +05:30
2020-03-09 13:42:32 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/344
2016-06-22 15:30:34 +05:30
```
2019-03-02 22:35:43 +05:30
## Award Emoji on Comments
2016-06-22 15:30:34 +05:30
2019-03-02 22:35:43 +05:30
Comments (also known as notes) are a sub-resource of issues, merge requests, and snippets.
2016-06-22 15:30:34 +05:30
2019-03-02 22:35:43 +05:30
NOTE: **Note:**
The examples below describe working with award emoji on comments for an issue, but can be
2019-07-07 11:18:12 +05:30
easily adapted for comments on a merge request or on a snippet. Therefore, you have to replace
`issue_iid` either with `merge_request_iid` or with the `snippet_id`.
2016-06-22 15:30:34 +05:30
2019-03-02 22:35:43 +05:30
### List a comment's award emoji
Get all award emoji for a comment (note).
```text
2017-08-17 22:00:37 +05:30
GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji
2016-06-22 15:30:34 +05:30
```
Parameters:
2019-03-02 22:35:43 +05:30
| Attribute | Type | Required | Description |
|:------------|:---------------|:---------|:-----------------------------------------------------------------------------|
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
| `issue_iid` | integer | yes | Internal ID of an issue. |
| `note_id` | integer | yes | ID of a comment (note). |
2016-06-22 15:30:34 +05:30
2019-03-02 22:35:43 +05:30
Example request:
2016-06-22 15:30:34 +05:30
2020-03-09 13:42:32 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji
2016-06-22 15:30:34 +05:30
```
2019-03-02 22:35:43 +05:30
Example response:
2016-06-22 15:30:34 +05:30
```json
[
{
"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",
2016-11-03 12:29:30 +05:30
"web_url": "http://gitlab.example.com/user4"
2016-06-22 15:30:34 +05:30
},
"created_at": "2016-06-15T10:09:34.197Z",
"updated_at": "2016-06-15T10:09:34.197Z",
"awardable_id": 1,
"awardable_type": "Note"
}
]
```
2019-03-02 22:35:43 +05:30
### Get an award emoji for a comment
2016-06-22 15:30:34 +05:30
2019-03-02 22:35:43 +05:30
Get a single award emoji for a comment (note).
```text
2017-08-17 22:00:37 +05:30
GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id
2016-06-22 15:30:34 +05:30
```
Parameters:
2019-03-02 22:35:43 +05:30
| Attribute | Type | Required | Description |
|:------------|:---------------|:---------|:-----------------------------------------------------------------------------|
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
| `issue_iid` | integer | yes | Internal ID of an issue. |
| `note_id` | integer | yes | ID of a comment (note). |
| `award_id` | integer | yes | ID of the award emoji. |
Example request:
2016-06-22 15:30:34 +05:30
2020-03-09 13:42:32 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji/2
2016-06-22 15:30:34 +05:30
```
2019-03-02 22:35:43 +05:30
Example response:
2016-06-22 15:30:34 +05:30
```json
{
"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",
2016-11-03 12:29:30 +05:30
"web_url": "http://gitlab.example.com/user4"
2016-06-22 15:30:34 +05:30
},
"created_at": "2016-06-15T10:09:34.197Z",
"updated_at": "2016-06-15T10:09:34.197Z",
"awardable_id": 1,
"awardable_type": "Note"
}
```
2019-03-02 22:35:43 +05:30
### Award a new emoji on a comment
2016-06-22 15:30:34 +05:30
2019-03-02 22:35:43 +05:30
Create an award emoji on the specified comment (note).
```text
2017-08-17 22:00:37 +05:30
POST /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji
2016-06-22 15:30:34 +05:30
```
Parameters:
2019-03-02 22:35:43 +05:30
| Attribute | Type | Required | Description |
|:------------|:---------------|:---------|:-----------------------------------------------------------------------------|
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
| `issue_iid` | integer | yes | Internal ID of an issue. |
| `note_id` | integer | yes | ID of a comment (note). |
| `name` | string | yes | Name of the emoji without colons. |
2016-06-22 15:30:34 +05:30
2019-03-02 22:35:43 +05:30
Example request:
2020-03-09 13:42:32 +05:30
```shell
2019-02-15 15:39:39 +05:30
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
2016-06-22 15:30:34 +05:30
```
2019-03-02 22:35:43 +05:30
Example response:
2016-06-22 15:30:34 +05:30
```json
{
"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",
2016-11-03 12:29:30 +05:30
"web_url": "http://gitlab.example.com/root"
2016-06-22 15:30:34 +05:30
},
"created_at": "2016-06-17T19:59:55.888Z",
"updated_at": "2016-06-17T19:59:55.888Z",
"awardable_id": 1,
"awardable_type": "Note"
}
```
2019-03-02 22:35:43 +05:30
### Delete an award emoji from a comment
2016-06-22 15:30:34 +05:30
2019-03-02 22:35:43 +05:30
Sometimes it's just not meant to be and you'll have to remove the award.
2016-06-22 15:30:34 +05:30
2019-03-02 22:35:43 +05:30
NOTE: **Note:**
Only available to administrators or the author of the award.
```text
2017-08-17 22:00:37 +05:30
DELETE /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id
2016-06-22 15:30:34 +05:30
```
Parameters:
2019-03-02 22:35:43 +05:30
| Attribute | Type | Required | Description |
|:------------|:---------------|:---------|:-----------------------------------------------------------------------------|
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
| `issue_iid` | integer | yes | Internal ID of an issue. |
| `note_id` | integer | yes | ID of a comment (note). |
| `award_id` | integer | yes | ID of an award_emoji. |
Example request:
2016-06-22 15:30:34 +05:30
2020-03-09 13:42:32 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/345
2016-06-22 15:30:34 +05:30
```