diff options
| author | Marcia Ramos <marcia@gitlab.com> | 2019-02-15 09:11:33 +0000 |
|---|---|---|
| committer | Marcia Ramos <marcia@gitlab.com> | 2019-02-15 09:11:33 +0000 |
| commit | 2a5de7e0eea45f55aa3dbff789a553eb560375b4 (patch) | |
| tree | d54d19f90c7083e2fb6d236509d17f904db0fd0f /doc | |
| parent | 0328d4faeec093db7744ae5a018174ea4f558a42 (diff) | |
| parent | 2aad8426f601e2fea4f3e8f44cfc193135bf4857 (diff) | |
| download | gitlab-ce-2a5de7e0eea45f55aa3dbff789a553eb560375b4.tar.gz | |
Merge branch '36263-the-award-emoji-api-has-an-incorrect-description-of-the-id-parameter' into 'master'
Clarify IDs in the award emoji API
Closes #36263
See merge request gitlab-org/gitlab-ce!25215
Diffstat (limited to 'doc')
| -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 |