Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Léo-Paul Géneau
gitlab-ce
Commits
2aad8426
Commit
2aad8426
authored
Feb 13, 2019
by
Robert Schilling
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
API: Clarify the award emoji docs
parent
7a8f8714
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
6 additions
and
5 deletions
+6
-5
doc/api/award_emoji.md
doc/api/award_emoji.md
+6
-5
No files found.
doc/api/award_emoji.md
View file @
2aad8426
...
...
@@ -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
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment