diff options
| author | Evan Read <eread@gitlab.com> | 2019-01-15 14:04:41 +1000 |
|---|---|---|
| committer | Evan Read <eread@gitlab.com> | 2019-01-15 14:04:41 +1000 |
| commit | a843fccfe79173baf67621a10cb08506259c6fe6 (patch) | |
| tree | 09d24d512bcb71d291a2066c2f0567efd33462a7 /doc | |
| parent | 9ca5909d1f12aa3ea2d340ae6cc01005e5b47d64 (diff) | |
| download | gitlab-ce-a843fccfe79173baf67621a10cb08506259c6fe6.tar.gz | |
Continue addressing review feedback
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/award_emoji.md | 84 | ||||
| -rw-r--r-- | doc/user/award_emojis.md | 5 |
2 files changed, 44 insertions, 45 deletions
diff --git a/doc/api/award_emoji.md b/doc/api/award_emoji.md index 0b0aa8e2a8f..67f53e79bcd 100644 --- a/doc/api/award_emoji.md +++ b/doc/api/award_emoji.md @@ -28,10 +28,10 @@ GET /projects/:id/snippets/:snippet_id/award_emoji Parameters: -| Attribute | Type | Required | Description | -|:---------------|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | -| `awardable_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. | +| 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. | Example request: @@ -90,11 +90,11 @@ GET /projects/:id/snippets/:snippet_id/award_emoji/:award_id Parameters: -| Attribute | Type | Required | Description | -|:---------------|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | -| `awardable_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. | -| `award_id` | integer | yes | ID of the award emoji. | +| 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. | +| `award_id` | integer | yes | ID of the award emoji. | Example request: @@ -135,11 +135,11 @@ POST /projects/:id/snippets/:snippet_id/award_emoji Parameters: -| Attribute | Type | Required | Description | -|:---------------|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | -| `awardable_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. | -| `name` | string | yes | Name of the emoji without colons. | +| 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. | +| `name` | string | yes | Name of the emoji without colons. | ```sh curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji?name=blowfish @@ -181,11 +181,11 @@ DELETE /projects/:id/snippets/:snippet_id/award_emoji/:award_id Parameters: -| Attribute | Type | Required | Description | -|:---------------|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | -| `awardable_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. | -| `award_id` | integer | yes | ID of an award emoji. | +| 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. | +| `award_id` | integer | yes | ID of an award emoji. | ```sh curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/344 @@ -209,11 +209,11 @@ GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji Parameters: -| Attribute | Type | Required | Description | -|:------------|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------| -| `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 comment (note). | +| Attribute | Type | Required | Description | +|:------------|:---------------|:---------|:-----------------------------------------------------------------------------| +| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | +| `issue_iid` | integer | yes | Internal ID of an issue. | +| `note_id` | integer | yes | ID of a comment (note). | Example request: @@ -254,12 +254,12 @@ GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id Parameters: -| Attribute | Type | Required | Description | -|:------------|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------| -| `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 comment (note). | -| `award_id` | integer | yes | ID of the award emoji. | +| Attribute | Type | Required | Description | +|:------------|:---------------|:---------|:-----------------------------------------------------------------------------| +| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | +| `issue_iid` | integer | yes | Internal ID of an issue. | +| `note_id` | integer | yes | ID of a comment (note). | +| `award_id` | integer | yes | ID of the award emoji. | Example request: @@ -298,12 +298,12 @@ POST /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji Parameters: -| Attribute | Type | Required | Description | -|:------------|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------| -| `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 comment (note). | -| `name` | string | yes | Name of the emoji without colons. | +| Attribute | Type | Required | Description | +|:------------|:---------------|:---------|:-----------------------------------------------------------------------------| +| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | +| `issue_iid` | integer | yes | Internal ID of an issue. | +| `note_id` | integer | yes | ID of a comment (note). | +| `name` | string | yes | Name of the emoji without colons. | Example request: @@ -345,12 +345,12 @@ DELETE /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id Parameters: -| Attribute | Type | Required | Description | -|:------------|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------| -| `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 comment (note). | -| `award_id` | integer | yes | ID of an award_emoji. | +| Attribute | Type | Required | Description | +|:------------|:---------------|:---------|:-----------------------------------------------------------------------------| +| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | +| `issue_iid` | integer | yes | Internal ID of an issue. | +| `note_id` | integer | yes | ID of a comment (note). | +| `award_id` | integer | yes | ID of an award_emoji. | Example request: diff --git a/doc/user/award_emojis.md b/doc/user/award_emojis.md index 56135abb4e5..e4fd08a582c 100644 --- a/doc/user/award_emojis.md +++ b/doc/user/award_emojis.md @@ -7,13 +7,12 @@ When you're collaborating online, you get fewer opportunities for high-fives 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. +[snippets](snippets.md), and anywhere you can have a discussion.  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. +comment thread. For information on the relevant API, see [Award Emoji API](../api/award_emoji.md). |