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
7681838a
Commit
7681838a
authored
Jan 11, 2019
by
Evan Read
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Be consistent with plural form of emoji. Also, notes are comments
parent
e635592d
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
22 additions
and
24 deletions
+22
-24
doc/api/award_emoji.md
doc/api/award_emoji.md
+18
-20
doc/user/award_emojis.md
doc/user/award_emojis.md
+4
-4
No files found.
doc/api/award_emoji.md
View file @
7681838a
...
...
@@ -4,18 +4,17 @@
An
[
awarded emoji
](
../user/award_emojis.md
)
tells a thousand words.
Emoji
s
can be awarded on the following (known as "awardables"):
Emoji can be awarded on the following (known as "awardables"):
-
[
Issues
](
../user/project/issues/index.md
)
-
[
Merge requests
](
../user/project/merge_requests/index.md
)
-
[
Snippets
](
../user/snippets.md
)
-
Notes
Emoji
s can also
[
be awarded
](
../user/award_emojis.html#award-emoji-for-comments
)
on comments
.
Emoji
can also
[
be awarded
](
../user/award_emojis.html#award-emoji-for-comments
)
on comments (also known as notes)
.
## Issues, merge requests, and snippets
See
[
Award Emoji on
Notes
](
#award-emoji-on-notes
)
for information on using these endpoints with note
s.
See
[
Award Emoji on
Comments
](
#award-emoji-on-comments
)
for information on using these endpoints with comment
s.
### List an awardable's award emoji
...
...
@@ -192,18 +191,17 @@ Parameters:
curl
--request
DELETE
--header
"PRIVATE-TOKEN: <your_access_token>"
https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/344
```
## Award Emoji on
Note
s
## Award Emoji on
Comment
s
Notes are a sub-resource of issues, merge requests, and snippets. The endpoints documented above
are available for notes as well.
Comments (also known as notes) are a sub-resource of issues, merge requests, and snippets.
NOTE:
**Note:**
The examples below describe working with award emoji on
note
s for an issue, but can be
easily adapted for
note
s on a merge request.
The examples below describe working with award emoji on
comment
s for an issue, but can be
easily adapted for
comment
s on a merge request.
### List a
note's award emojis
### List a
comment's award emoji
Get all award emoji
s for a note
.
Get all award emoji
for a comment (note)
.
```
text
GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji
...
...
@@ -215,7 +213,7 @@ Parameters:
|:------------|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------|
|
`id`
| integer/string | yes | ID or
[
URL-encoded path of the project
](
README.md#namespaced-path-encoding
)
owned by the authenticated user. |
|
`issue_iid`
| integer | yes | Internal ID of an issue. |
|
`note_id`
| integer | yes | ID of a
note.
|
|
`note_id`
| integer | yes | ID of a
comment (note).
|
Example request:
...
...
@@ -246,9 +244,9 @@ Example response:
]
```
### Get an award emoji for a
note
### Get an award emoji for a
comment
Get a single award emoji for a
note
.
Get a single award emoji for a
comment (note)
.
```
text
GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id
...
...
@@ -260,7 +258,7 @@ Parameters:
|:------------|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------|
|
`id`
| integer/string | yes | ID or
[
URL-encoded path of the project
](
README.md#namespaced-path-encoding
)
owned by the authenticated user. |
|
`issue_iid`
| integer | yes | Internal ID of an issue. |
|
`note_id`
| integer | yes | ID of a
note.
|
|
`note_id`
| integer | yes | ID of a
comment (note).
|
|
`award_id`
| integer | yes | ID of the award emoji. |
Example request:
...
...
@@ -290,9 +288,9 @@ Example response:
}
```
### Award a new emoji on a
note
### Award a new emoji on a
comment
Create an award emoji on the specified
note
.
Create an award emoji on the specified
comment (note)
.
```
text
POST /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji
...
...
@@ -304,7 +302,7 @@ Parameters:
|:------------|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------|
|
`id`
| integer/string | yes | ID or
[
URL-encoded path of the project
](
README.md#namespaced-path-encoding
)
owned by the authenticated user. |
|
`issue_iid`
| integer | yes | Internal ID of an issue. |
|
`note_id`
| integer | yes | ID of a
note.
|
|
`note_id`
| integer | yes | ID of a
comment (note).
|
|
`name`
| string | yes | Name of the emoji without colons. |
Example request:
...
...
@@ -334,7 +332,7 @@ Example response:
}
```
### Delete an award emoji from a
note
### Delete an award emoji from a
comment
Sometimes it's just not meant to be and you'll have to remove the award.
...
...
@@ -351,7 +349,7 @@ Parameters:
|:------------|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------|
|
`id`
| integer/string | yes | ID or
[
URL-encoded path of the project
](
README.md#namespaced-path-encoding
)
owned by the authenticated user. |
|
`issue_iid`
| integer | yes | Internal ID of an issue. |
|
`note_id`
| integer | yes | ID of a
note.
|
|
`note_id`
| integer | yes | ID of a
comment (note).
|
|
`award_id`
| integer | yes | ID of an award_emoji. |
Example request:
...
...
doc/user/award_emojis.md
View file @
7681838a
...
...
@@ -6,14 +6,14 @@
> improved award emoji performance overall.
When you're collaborating online, you get fewer opportunities for high-fives
and thumbs-ups. Emoji
s
can be awarded to
[
issues
](
project/issues/index.md
)
,
[
merge requests
](
project/merge_requests/index.md
)
,
and thumbs-ups. Emoji can be awarded to
[
issues
](
project/issues/index.md
)
,
[
merge requests
](
project/merge_requests/index.md
)
,
[
snippets
](
snippets.md
)
, and virtually everywhere where you can have a discussion.
![
Award emoji
](
img/award_emoji_select.png
)
Award emoji
s
make it much easier to give and receive feedback without a long
comment thread. Comments that are only emoji
s
will automatically become
award emoji
s
.
Award emoji make it much easier to give and receive feedback without a long
comment thread. Comments that are only emoji will automatically become
award emoji.
For information on the relevant API, see
[
Award Emoji API
](
../api/award_emoji.md
)
.
...
...
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