diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-05-15 21:10:04 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-05-15 21:10:04 +0300 |
commit | 5ff1f808adf841bca979cb2fac6bdfa9c449d028 (patch) | |
tree | c95cfbbcb400684b2bc89fee4fc7b614315ba909 /doc/api | |
parent | f8a5275c45ed2276daf843764113476749e680d2 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/api_resources.md | 2 | ||||
-rw-r--r-- | doc/api/award_emoji.md | 60 | ||||
-rw-r--r-- | doc/api/graphql/getting_started.md | 4 | ||||
-rw-r--r-- | doc/api/import.md | 5 | ||||
-rw-r--r-- | doc/api/notes.md | 6 |
5 files changed, 41 insertions, 36 deletions
diff --git a/doc/api/api_resources.md b/doc/api/api_resources.md index bc4521c9857..4a70786b6ee 100644 --- a/doc/api/api_resources.md +++ b/doc/api/api_resources.md @@ -26,7 +26,6 @@ The following API resources are available in the project context: | [Access requests](access_requests.md) | `/projects/:id/access_requests` (also available for groups) | | [Access tokens](project_access_tokens.md) | `/projects/:id/access_tokens` (also available for groups) | | [Agents](cluster_agents.md) | `/projects/:id/cluster_agents` | -| [Award emoji](award_emoji.md) | `/projects/:id/issues/.../award_emoji`, `/projects/:id/merge_requests/.../award_emoji`, `/projects/:id/snippets/.../award_emoji` | | [Branches](branches.md) | `/projects/:id/repository/branches/`, `/projects/:id/repository/merged_branches` | | [Commits](commits.md) | `/projects/:id/repository/commits`, `/projects/:id/statuses` | | [Container Registry](container_registry.md) | `/projects/:id/registry/repositories` | @@ -41,6 +40,7 @@ The following API resources are available in the project context: | [Deployments](deployments.md) | `/projects/:id/deployments` | | [Discussions](discussions.md) (threaded comments) | `/projects/:id/issues/.../discussions`, `/projects/:id/snippets/.../discussions`, `/projects/:id/merge_requests/.../discussions`, `/projects/:id/commits/.../discussions` (also available for groups) | | [Draft Notes](draft_notes.md) (comments) | `/projects/:id/merge_requests/.../draft_notes` +| [Emoji reactions](award_emoji.md) | `/projects/:id/issues/.../award_emoji`, `/projects/:id/merge_requests/.../award_emoji`, `/projects/:id/snippets/.../award_emoji` | | [Environments](environments.md) | `/projects/:id/environments` | | [Error Tracking](error_tracking.md) | `/projects/:id/error_tracking/settings` | | [Events](events.md) | `/projects/:id/events` (also available for users and standalone) | diff --git a/doc/api/award_emoji.md b/doc/api/award_emoji.md index a669c6d00c3..a22c61b3391 100644 --- a/doc/api/award_emoji.md +++ b/doc/api/award_emoji.md @@ -4,28 +4,30 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Award emojis API **(FREE)** +# Emoji reactions API **(FREE)** -An [awarded emoji](../user/award_emojis.md) tells a thousand words. +> [Renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/409884) from "award emojis" to "emoji reactions" in GitLab 16.0. -We call GitLab objects on which you can award an emoji "awardables". You can award emojis on the following: +An [emoji reaction](../user/award_emojis.md) tells a thousand words. + +We call GitLab objects on which you can react with an emoji "awardables". +You can react with emojis on the following: - [Epics](../user/group/epics/index.md) ([API](epics.md)). **(PREMIUM)** - [Issues](../user/project/issues/index.md) ([API](issues.md)). - [Merge requests](../user/project/merge_requests/index.md) ([API](merge_requests.md)). - [Snippets](../user/snippets.md) ([API](snippets.md)). - -Emojis can also [be awarded](../user/award_emojis.md#award-emojis-for-comments) on comments (also known as notes). See also [Notes API](notes.md). +- [Comments](../user/award_emojis.md#emoji-reactions-for-comments) ([API](notes.md)). ## Issues, merge requests, and snippets -See [Award emojis on comments](#award-emojis-on-comments) for information on using these endpoints with comments. +For information on using these endpoints with comments, see [Add reactions to comments](#add-reactions-to-comments). -### List an awardable's award emojis +### List an awardable's emoji reactions > [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/335068) in GitLab 15.1 to allow unauthenticated access to public awardables. -Get a list of all award emojis for a specified awardable. This endpoint can +Get a list of all emoji reactions for a specified awardable. This endpoint can be accessed without authentication if the awardable is publicly accessible. ```plaintext @@ -86,11 +88,11 @@ Example response: ] ``` -### Get single award emoji +### Get single emoji reaction > [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/335068) in GitLab 15.1 to allow unauthenticated access to public awardables. -Get a single award emoji from an issue, snippet, or merge request. This endpoint can +Get a single emoji reaction from an issue, snippet, or merge request. This endpoint can be accessed without authentication if the awardable is publicly accessible. ```plaintext @@ -105,7 +107,7 @@ Parameters: |:---------------|:---------------|:---------|:-----------------------------------------------------------------------------| | `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | | `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. | +| `award_id` | integer | yes | ID of the emoji reaction. | Example request: @@ -134,9 +136,9 @@ Example response: } ``` -### Award a new emoji +### Add a new emoji reaction -Create an award emoji on the specified awardable. +Add an emoji reaction on the specified awardable. ```plaintext POST /projects/:id/issues/:issue_iid/award_emoji @@ -177,11 +179,11 @@ Example Response: } ``` -### Delete an award emoji +### Delete an emoji reaction -Sometimes it's just not meant to be and you need to remove the award. +Sometimes it's just not meant to be and you need to remove your reaction. -Only an administrator or the author of the award can delete an award emoji. +Only an administrator or the author of the reaction can delete an emoji reaction. ```plaintext DELETE /projects/:id/issues/:issue_iid/award_emoji/:award_id @@ -195,26 +197,26 @@ Parameters: |:---------------|:---------------|:---------|:-----------------------------------------------------------------------------| | `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | | `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. | +| `award_id` | integer | yes | ID of an emoji reaction. | ```shell curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/344" ``` -## Award emojis on comments +## Add reactions to comments Comments (also known as notes) are a sub-resource of issues, merge requests, and snippets. NOTE: -The examples below describe working with award emojis on an issue's comments, but can be +The examples below describe working with emoji reactions on an issue's comments, but can be adapted to comments on merge requests and snippets. Therefore, you have to replace `issue_iid` either with `merge_request_iid` or with the `snippet_id`. -### List a comment's award emojis +### List a comment's emoji reactions > [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/335068) in GitLab 15.1 to allow unauthenticated access to public comments. -Get all award emojis for a comment (note). This endpoint can +Get all emoji reactions for a comment (note). This endpoint can be accessed without authentication if the comment is publicly accessible. ```plaintext @@ -258,11 +260,11 @@ Example response: ] ``` -### Get an award emoji for a comment +### Get an emoji reaction for a comment > [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/335068) in GitLab 15.1 to allow unauthenticated access to public comments. -Get a single award emoji for a comment (note). This endpoint can +Get a single emoji reaction for a comment (note). This endpoint can be accessed without authentication if the comment is publicly accessible. ```plaintext @@ -276,7 +278,7 @@ Parameters: | `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.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. | +| `award_id` | integer | yes | ID of the emoji reaction. | Example request: @@ -307,7 +309,7 @@ Example response: ### Award a new emoji on a comment -Create an award emoji on the specified comment (note). +Create an emoji reaction on the specified comment (note). ```plaintext POST /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji @@ -349,11 +351,11 @@ Example response: } ``` -### Delete an award emoji from a comment +### Delete an emoji reaction from a comment -Sometimes it's just not meant to be and you need to remove the award. +Sometimes it's just not meant to be and you need to remove the reaction. -Only an administrator or the author of the award can delete an award emoji. +Only an administrator or the author of the reaction can delete an emoji reaction. ```plaintext DELETE /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id @@ -366,7 +368,7 @@ Parameters: | `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.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. | +| `award_id` | integer | yes | ID of an emoji reaction. | Example request: diff --git a/doc/api/graphql/getting_started.md b/doc/api/graphql/getting_started.md index e5f58c7efa8..237c0cc6934 100644 --- a/doc/api/graphql/getting_started.md +++ b/doc/api/graphql/getting_started.md @@ -183,7 +183,7 @@ Mutations generally use InputTypes and variables, neither of which appear here. Mutations have: -- Inputs. For example, arguments, such as which emoji you'd like to award, +- Inputs. For example, arguments, such as which emoji reaction you'd like to add, and to which object. - Return statements. That is, what you'd like to get back when it's successful. - Errors. Always ask for what went wrong, just in case. @@ -299,7 +299,7 @@ mutation DisableCI_JOB_TOKENscope { inboundJobTokenScopeEnabled jobTokenScopeEnabled } - errors + errors } } ``` diff --git a/doc/api/import.md b/doc/api/import.md index 7f25e9236c3..be70868cca5 100644 --- a/doc/api/import.md +++ b/doc/api/import.md @@ -12,6 +12,7 @@ Use the Import API to import repositories from GitHub or Bitbucket Server. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/381902) in GitLab 15.8, GitLab no longer automatically creates namespaces or groups if the namespace or group name specified in `target_namespace` doesn't exist. GitLab also no longer falls back to using the user's personal namespace if the namespace or group name is taken or `target_namespace` is blank. > - Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. +> - `collaborators_import` key in `optional_stages` was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/398154) in GitLab 16.0. Import your projects from GitHub to GitLab using the API. @@ -48,7 +49,8 @@ curl --request POST \ "optional_stages": { "single_endpoint_issue_events_import": true, "single_endpoint_notes_import": true, - "attachments_import": true + "attachments_import": true, + "collaborators_import": true } }' ``` @@ -58,6 +60,7 @@ The following keys are available for `optional_stages`: - `single_endpoint_issue_events_import`, for issue and pull request events import. - `single_endpoint_notes_import`, for an alternative and more thorough comments import. - `attachments_import`, for Markdown attachments import. +- `collaborators_import`, for importing direct repository collaborators who are not outside collaborators. For more information, see [Select additional items to import](../user/project/import/github.md#select-additional-items-to-import). diff --git a/doc/api/notes.md b/doc/api/notes.md index bdcbbdf9728..41b4ab7fd9a 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -272,7 +272,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a ### Create new snippet note Creates a new note for a single snippet. Snippet notes are user comments on snippets. -If you create a note where the body only contains an Award Emoji, GitLab returns this object. +If you create a note where the body only contains an emoji reaction, GitLab returns this object. ```plaintext POST /projects/:id/snippets/:snippet_id/notes @@ -408,7 +408,7 @@ lines in a merge request. For other approaches with more granular control, see and [Create a new thread in the merge request diff](discussions.md#create-a-new-thread-in-the-merge-request-diff) in the Discussions API. -If you create a note where the body only contains an award emoji, GitLab returns this object. +If you create a note where the body only contains an emoji reaction, GitLab returns this object. ```plaintext POST /projects/:id/merge_requests/:merge_request_iid/notes @@ -542,7 +542,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a ### Create new epic note Creates a new note for a single epic. Epic notes are comments users can post to an epic. -If you create a note where the body only contains an Award Emoji, GitLab returns this object. +If you create a note where the body only contains an emoji reaction, GitLab returns this object. ```plaintext POST /groups/:id/epics/:epic_id/notes |