diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-12-04 15:09:39 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-12-04 15:09:39 +0300 |
commit | 8322f051740fba113c5c1f6fba96b9c943240746 (patch) | |
tree | bc695dfd5538f9378041f4a4fa6bd097ecf58954 /doc/api/issues.md | |
parent | f9fe7cda4bdbc477d8d76e5def4023f7d03bab46 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/issues.md')
-rw-r--r-- | doc/api/issues.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/api/issues.md b/doc/api/issues.md index 8d0ef0f53ed..243521bc517 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -1630,6 +1630,61 @@ NOTE: **Note:** The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value is only present for issues closed after GitLab 10.6 and if the user account that closed the issue still exists. +## Promote an issue to an epic **(PREMIUM)** + +Promotes an issue to an epic by adding a comment with the `/promote` +[quick action](../user/project/quick_actions.md). + +To learn more about promoting issues to epics, visit [Manage epics](../user/group/epics/manage_epics.md#promote-an-issue-to-an-epic). + +```plaintext +POST /projects/:id/issues/:issue_iid/notes +``` + +Supported attributes: + +| Attribute | Type | Required | Description | +| :---------- | :------------- | :------- | :---------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `issue_iid` | integer | yes | The internal ID of a project's issue | +| `body` | String | yes | The content of a note. Must contain `/promote` at the start of a new line. | + +Example request: + +```shell +curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/11/notes?body=Lets%20promote%20this%20to%20an%20epic%0A%0A%2Fpromote +``` + +Example response: + +```json +{ + "id":699, + "type":null, + "body":"Lets promote this to an epic", + "attachment":null, + "author": { + "id":1, + "name":"Alexandra Bashirian", + "username":"eileen.lowe", + "state":"active", + "avatar_url":"https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon", + "web_url":"https://gitlab.example.com/eileen.lowe" + }, + "created_at":"2020-12-03T12:27:17.844Z", + "updated_at":"2020-12-03T12:27:17.844Z", + "system":false, + "noteable_id":461, + "noteable_type":"Issue", + "resolvable":false, + "confidential":false, + "noteable_iid":33, + "commands_changes": { + "promote_to_epic":true + } +} +``` + ## Set a time estimate for an issue Sets an estimated time of work for this issue. |