Skip to content

Commit 2aad842

Browse files
committed
API: Clarify the award emoji docs
1 parent 7a8f871 commit 2aad842

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

doc/api/award_emoji.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Parameters:
3131
| Attribute | Type | Required | Description |
3232
|:---------------|:---------------|:---------|:-----------------------------------------------------------------------------|
3333
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
34-
| `awardable_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. |
34+
| `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. |
3535

3636
Example request:
3737

@@ -93,7 +93,7 @@ Parameters:
9393
| Attribute | Type | Required | Description |
9494
|:---------------|:---------------|:---------|:-----------------------------------------------------------------------------|
9595
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
96-
| `awardable_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. |
96+
| `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. |
9797
| `award_id` | integer | yes | ID of the award emoji. |
9898

9999
Example request:
@@ -138,7 +138,7 @@ Parameters:
138138
| Attribute | Type | Required | Description |
139139
|:---------------|:---------------|:---------|:-----------------------------------------------------------------------------|
140140
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
141-
| `awardable_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. |
141+
| `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. |
142142
| `name` | string | yes | Name of the emoji without colons. |
143143

144144
```sh
@@ -184,7 +184,7 @@ Parameters:
184184
| Attribute | Type | Required | Description |
185185
|:---------------|:---------------|:---------|:-----------------------------------------------------------------------------|
186186
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
187-
| `awardable_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. |
187+
| `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. |
188188
| `award_id` | integer | yes | ID of an award emoji. |
189189

190190
```sh
@@ -197,7 +197,8 @@ Comments (also known as notes) are a sub-resource of issues, merge requests, and
197197

198198
NOTE: **Note:**
199199
The examples below describe working with award emoji on comments for an issue, but can be
200-
easily adapted for comments on a merge request.
200+
easily adapted for comments on a merge request or on a snippet. Therefore, you have to replace
201+
`issue_iid` either with `merge_request_iid` or with the `snippet_id`.
201202

202203
### List a comment's award emoji
203204

0 commit comments

Comments
 (0)