diff options
| author | Robert Schilling <rschilling@student.tugraz.at> | 2019-02-13 20:23:04 +0100 |
|---|---|---|
| committer | Robert Schilling <rschilling@student.tugraz.at> | 2019-02-13 20:25:12 +0100 |
| commit | 2aad8426f601e2fea4f3e8f44cfc193135bf4857 (patch) | |
| tree | 2b38f51185a352fa8c8f3db4315c7046097a189c /doc/api | |
| parent | 7a8f8714cc65b36b8dbc4fe180eeb73aa2eeba0f (diff) | |
| download | gitlab-ce-2aad8426f601e2fea4f3e8f44cfc193135bf4857.tar.gz | |
API: Clarify the award emoji docs
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/award_emoji.md | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/doc/api/award_emoji.md b/doc/api/award_emoji.md index 92936a277ac..1d0e39e6bbf 100644 --- a/doc/api/award_emoji.md +++ b/doc/api/award_emoji.md @@ -31,7 +31,7 @@ Parameters: | Attribute | Type | Required | Description | |:---------------|:---------------|:---------|:-----------------------------------------------------------------------------| | `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | -| `awardable_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. | +| `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. | Example request: @@ -93,7 +93,7 @@ Parameters: | Attribute | Type | Required | Description | |:---------------|:---------------|:---------|:-----------------------------------------------------------------------------| | `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | -| `awardable_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. | +| `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. | | `award_id` | integer | yes | ID of the award emoji. | Example request: @@ -138,7 +138,7 @@ Parameters: | Attribute | Type | Required | Description | |:---------------|:---------------|:---------|:-----------------------------------------------------------------------------| | `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | -| `awardable_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. | +| `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. | | `name` | string | yes | Name of the emoji without colons. | ```sh @@ -184,7 +184,7 @@ Parameters: | Attribute | Type | Required | Description | |:---------------|:---------------|:---------|:-----------------------------------------------------------------------------| | `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | -| `awardable_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. | +| `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. | | `award_id` | integer | yes | ID of an award emoji. | ```sh @@ -197,7 +197,8 @@ Comments (also known as notes) are a sub-resource of issues, merge requests, and NOTE: **Note:** The examples below describe working with award emoji on comments for an issue, but can be -easily adapted for comments on a merge request. +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`. ### List a comment's award emoji |