Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-09-07 15:08:27 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2020-09-07 15:08:27 +0300
commita8653790086d284cecffdc35892bb422cd6c9a7b (patch)
tree8d1f4dc69026a42a47b1026eef2566c7461a52fe /doc/api/issues.md
parent444f662b8d8cbe47a8f3fa1db6ed926d64f3def3 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/issues.md')
-rw-r--r--doc/api/issues.md175
1 files changed, 12 insertions, 163 deletions
diff --git a/doc/api/issues.md b/doc/api/issues.md
index 2a0d66a8b3e..b1ab5c96fcb 100644
--- a/doc/api/issues.md
+++ b/doc/api/issues.md
@@ -680,164 +680,7 @@ Example response:
}
```
-Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
-the `weight` parameter:
-
-```json
-{
- "project_id" : 4,
- "description" : "Omnis vero earum sunt corporis dolor et placeat.",
- "weight": null,
- ...
-}
-```
-
-Users on GitLab [Ultimate](https://about.gitlab.com/pricing/) will additionally see
-the `epic` property:
-
-```javascript
-{
- "project_id" : 4,
- "description" : "Omnis vero earum sunt corporis dolor et placeat.",
- "epic": {
- "epic_iid" : 5, //deprecated, use `iid` of the `epic` attribute
- "epic": {
- "id" : 42,
- "iid" : 5,
- "title": "My epic epic",
- "url" : "/groups/h5bp/-/epics/5",
- "group_id": 8
- },
- // ...
-}
-```
-
-**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
-
-**Note**: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
-
-**Note**: The `epic_iid` attribute is deprecated and [will be removed in version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157).
-Please use `iid` of the `epic` attribute instead.
-
-## Single Issue
-
-Only for administrators. Get a single issue.
-
-The preferred way to do this is by using [personal access tokens](../user/profile/personal_access_tokens.md).
-
-```plaintext
-GET /issues/:id
-```
-
-| Attribute | Type | Required | Description |
-|-------------|---------|----------|--------------------------------------|
-| `id` | integer | yes | The ID of the issue |
-
-```shell
-curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/issues/41"
-```
-
-Example response:
-
-```json
-{
- "id" : 1,
- "milestone" : {
- "due_date" : null,
- "project_id" : 4,
- "state" : "closed",
- "description" : "Rerum est voluptatem provident consequuntur molestias similique ipsum dolor.",
- "iid" : 3,
- "id" : 11,
- "title" : "v3.0",
- "created_at" : "2016-01-04T15:31:39.788Z",
- "updated_at" : "2016-01-04T15:31:39.788Z",
- "closed_at" : "2016-01-05T15:31:46.176Z"
- },
- "author" : {
- "state" : "active",
- "web_url" : "https://gitlab.example.com/root",
- "avatar_url" : null,
- "username" : "root",
- "id" : 1,
- "name" : "Administrator"
- },
- "description" : "Omnis vero earum sunt corporis dolor et placeat.",
- "state" : "closed",
- "iid" : 1,
- "assignees" : [{
- "avatar_url" : null,
- "web_url" : "https://gitlab.example.com/lennie",
- "state" : "active",
- "username" : "lennie",
- "id" : 9,
- "name" : "Dr. Luella Kovacek"
- }],
- "assignee" : {
- "avatar_url" : null,
- "web_url" : "https://gitlab.example.com/lennie",
- "state" : "active",
- "username" : "lennie",
- "id" : 9,
- "name" : "Dr. Luella Kovacek"
- },
- "labels" : [],
- "upvotes": 4,
- "downvotes": 0,
- "merge_requests_count": 0,
- "title" : "Ut commodi ullam eos dolores perferendis nihil sunt.",
- "updated_at" : "2016-01-04T15:31:46.176Z",
- "created_at" : "2016-01-04T15:31:46.176Z",
- "closed_at" : null,
- "closed_by" : null,
- "subscribed": false,
- "user_notes_count": 1,
- "due_date": null,
- "web_url": "http://example.com/my-group/my-project/issues/1",
- "references": {
- "short": "#1",
- "relative": "#1",
- "full": "my-group/my-project#1"
- },
- "time_stats": {
- "time_estimate": 0,
- "total_time_spent": 0,
- "human_time_estimate": null,
- "human_total_time_spent": null
- },
- "confidential": false,
- "discussion_locked": false,
- "_links": {
- "self": "http://example.com/api/v4/projects/1/issues/2",
- "notes": "http://example.com/api/v4/projects/1/issues/2/notes",
- "award_emoji": "http://example.com/api/v4/projects/1/issues/2/award_emoji",
- "project": "http://example.com/api/v4/projects/1"
- },
- "task_completion_status":{
- "count":0,
- "completed_count":0
- },
- "weight": null,
- "has_tasks": false,
- "_links": {
- "self": "http://gitlab.dummy:3000/api/v4/projects/1/issues/1",
- "notes": "http://gitlab.dummy:3000/api/v4/projects/1/issues/1/notes",
- "award_emoji": "http://gitlab.dummy:3000/api/v4/projects/1/issues/1/award_emoji",
- "project": "http://gitlab.dummy:3000/api/v4/projects/1"
- },
- "references": {
- "short": "#1",
- "relative": "#1",
- "full": "gitlab-org/gitlab-test#1"
- },
- "subscribed": true,
- "moved_to_id": null,
- "epic_iid": null,
- "epic": null
-}
-```
-
-Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
+Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) can also see
the `weight` parameter:
```json
@@ -849,7 +692,7 @@ the `weight` parameter:
}
```
-Users on GitLab [Ultimate](https://about.gitlab.com/pricing/) will additionally see
+Users on GitLab [Ultimate](https://about.gitlab.com/pricing/) can also see
the `epic` property:
```javascript
@@ -869,14 +712,20 @@ the `epic` property:
}
```
-**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
+NOTE: **Note:**
+The `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform
+to the GitLab EE API.
-**Note**: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
+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.
-**Note**: The `epic_iid` attribute is deprecated and [will be removed in version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157).
+NOTE: **Note:**
+The `epic_iid` attribute is deprecated, and [will be removed in version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157).
Please use `iid` of the `epic` attribute instead.
-## Single Project Issue
+## Single project issue
Get a single project issue.