BigW Consortium Gitlab

issues.md 21.7 KB
Newer Older
1 2
# Issues

3 4 5 6 7 8 9 10 11 12 13 14
Every API call to issues must be authenticated.

If a user is not a member of a project and the project is private, a `GET`
request on that project will result to a `404` status code.

## Issues pagination

By default, `GET` requests return 20 results at a time because the API results
are paginated.

Read more on [pagination](README.md#pagination).

Nihad Abbasov committed
15 16
## List issues

17
Get all issues created by the authenticated user.
Nihad Abbasov committed
18 19 20

```
GET /issues
21 22
GET /issues?state=opened
GET /issues?state=closed
23 24 25
GET /issues?labels=foo
GET /issues?labels=foo,bar
GET /issues?labels=foo,bar&state=opened
Nihad Abbasov committed
26 27
```

28 29 30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `state`   | string  | no    | Return all issues or just those that are `opened` or `closed`|
31
| `labels`  | string  | no    | Comma-separated list of label names, issues with any of the labels will be returned |
32 33 34 35
| `order_by`| string  | no    | Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at` |
| `sort`    | string  | no    | Return requests sorted in `asc` or `desc` order. Default is `desc`  |

```bash
36
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/issues
37
```
38

39
Example response:
40

Nihad Abbasov committed
41 42
```json
[
43 44 45 46 47 48
   {
      "state" : "opened",
      "description" : "Ratione dolores corrupti mollitia soluta quia.",
      "author" : {
         "state" : "active",
         "id" : 18,
49
         "web_url" : "https://gitlab.example.com/eileen.lowe",
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
         "name" : "Alexandra Bashirian",
         "avatar_url" : null,
         "username" : "eileen.lowe"
      },
      "milestone" : {
         "project_id" : 1,
         "description" : "Ducimus nam enim ex consequatur cumque ratione.",
         "state" : "closed",
         "due_date" : null,
         "iid" : 2,
         "created_at" : "2016-01-04T15:31:39.996Z",
         "title" : "v4.0",
         "id" : 17,
         "updated_at" : "2016-01-04T15:31:39.996Z"
      },
      "project_id" : 1,
      "assignee" : {
         "state" : "active",
         "id" : 1,
         "name" : "Administrator",
70
         "web_url" : "https://gitlab.example.com/root",
71 72 73 74 75 76 77 78
         "avatar_url" : null,
         "username" : "root"
      },
      "updated_at" : "2016-01-04T15:31:51.081Z",
      "id" : 76,
      "title" : "Consequatur vero maxime deserunt laboriosam est voluptas dolorem.",
      "created_at" : "2016-01-04T15:31:51.081Z",
      "iid" : 6,
79
      "labels" : [],
80
      "subscribed" : false,
81
      "user_notes_count": 1,
82
      "due_date": "2016-07-22",
83 84
      "web_url": "http://example.com/example/example/issues/6",
      "confidential": false
85
   }
Nihad Abbasov committed
86 87 88
]
```

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
## List group issues

Get a list of a group's issues.

```
GET /groups/:id/issues
GET /groups/:id/issues?state=opened
GET /groups/:id/issues?state=closed
GET /groups/:id/issues?labels=foo
GET /groups/:id/issues?labels=foo,bar
GET /groups/:id/issues?labels=foo,bar&state=opened
GET /groups/:id/issues?milestone=1.0.0
GET /groups/:id/issues?milestone=1.0.0&state=opened
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes   | The ID of a group |
| `state`   | string  | no    | Return all issues or just those that are `opened` or `closed`|
| `labels`  | string  | no    | Comma-separated list of label names, issues must have all labels to be returned |
| `milestone` | string| no    | The milestone title |
| `order_by`| string  | no    | Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at` |
| `sort`    | string  | no    | Return requests sorted in `asc` or `desc` order. Default is `desc`  |


```bash
115
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/groups/4/issues
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
```

Example response:

```json
[
   {
      "project_id" : 4,
      "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"
      },
      "author" : {
         "state" : "active",
137
         "web_url" : "https://gitlab.example.com/root",
138 139 140 141 142 143 144 145 146 147
         "avatar_url" : null,
         "username" : "root",
         "id" : 1,
         "name" : "Administrator"
      },
      "description" : "Omnis vero earum sunt corporis dolor et placeat.",
      "state" : "closed",
      "iid" : 1,
      "assignee" : {
         "avatar_url" : null,
148
         "web_url" : "https://gitlab.example.com/lennie",
149 150 151 152 153 154 155 156 157 158 159
         "state" : "active",
         "username" : "lennie",
         "id" : 9,
         "name" : "Dr. Luella Kovacek"
      },
      "labels" : [],
      "id" : 41,
      "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",
      "subscribed" : false,
160
      "user_notes_count": 1,
161
      "due_date": null,
162 163
      "web_url": "http://example.com/example/example/issues/1",
      "confidential": false
164 165 166 167
   }
]
```

Nihad Abbasov committed
168 169
## List project issues

170
Get a list of a project's issues.
Nihad Abbasov committed
171 172 173

```
GET /projects/:id/issues
174 175
GET /projects/:id/issues?state=opened
GET /projects/:id/issues?state=closed
176 177 178
GET /projects/:id/issues?labels=foo
GET /projects/:id/issues?labels=foo,bar
GET /projects/:id/issues?labels=foo,bar&state=opened
179 180
GET /projects/:id/issues?milestone=1.0.0
GET /projects/:id/issues?milestone=1.0.0&state=opened
181
GET /projects/:id/issues?iid=42
Nihad Abbasov committed
182 183
```

184 185 186 187 188
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes   | The ID of a project |
| `iid`     | integer | no    | Return the issue having the given `iid` |
| `state`   | string  | no    | Return all issues or just those that are `opened` or `closed`|
189
| `labels`  | string  | no    | Comma-separated list of label names, issues with any of the labels will be returned |
190 191 192 193 194 195
| `milestone` | string| no    | The milestone title |
| `order_by`| string  | no    | Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at` |
| `sort`    | string  | no    | Return requests sorted in `asc` or `desc` order. Default is `desc`  |


```bash
196
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/4/issues
197 198 199
```

Example response:
Nihad Abbasov committed
200

201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
```json
[
   {
      "project_id" : 4,
      "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"
      },
      "author" : {
         "state" : "active",
218
         "web_url" : "https://gitlab.example.com/root",
219 220 221 222 223 224 225 226 227 228
         "avatar_url" : null,
         "username" : "root",
         "id" : 1,
         "name" : "Administrator"
      },
      "description" : "Omnis vero earum sunt corporis dolor et placeat.",
      "state" : "closed",
      "iid" : 1,
      "assignee" : {
         "avatar_url" : null,
229
         "web_url" : "https://gitlab.example.com/lennie",
230 231 232 233 234 235 236 237 238
         "state" : "active",
         "username" : "lennie",
         "id" : 9,
         "name" : "Dr. Luella Kovacek"
      },
      "labels" : [],
      "id" : 41,
      "title" : "Ut commodi ullam eos dolores perferendis nihil sunt.",
      "updated_at" : "2016-01-04T15:31:46.176Z",
239
      "created_at" : "2016-01-04T15:31:46.176Z",
240
      "subscribed" : false,
241
      "user_notes_count": 1,
242
      "due_date": "2016-07-22",
243 244
      "web_url": "http://example.com/example/example/issues/1",
      "confidential": false
245 246 247
   }
]
```
248

Nihad Abbasov committed
249 250
## Single issue

251
Get a single project issue.
Nihad Abbasov committed
252 253 254 255 256

```
GET /projects/:id/issues/:issue_id
```

257 258 259 260
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes   | The ID of a project |
| `issue_id`| integer | yes   | The ID of a project's issue |
Nihad Abbasov committed
261

262
```bash
263
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/4/issues/41
264 265 266
```

Example response:
Nihad Abbasov committed
267 268 269

```json
{
270 271 272 273 274 275 276 277 278 279 280 281 282 283
   "project_id" : 4,
   "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"
   },
   "author" : {
      "state" : "active",
284
      "web_url" : "https://gitlab.example.com/root",
285 286 287 288 289 290 291 292 293 294
      "avatar_url" : null,
      "username" : "root",
      "id" : 1,
      "name" : "Administrator"
   },
   "description" : "Omnis vero earum sunt corporis dolor et placeat.",
   "state" : "closed",
   "iid" : 1,
   "assignee" : {
      "avatar_url" : null,
295
      "web_url" : "https://gitlab.example.com/lennie",
296 297 298 299 300 301 302 303 304
      "state" : "active",
      "username" : "lennie",
      "id" : 9,
      "name" : "Dr. Luella Kovacek"
   },
   "labels" : [],
   "id" : 41,
   "title" : "Ut commodi ullam eos dolores perferendis nihil sunt.",
   "updated_at" : "2016-01-04T15:31:46.176Z",
305
   "created_at" : "2016-01-04T15:31:46.176Z",
306
   "subscribed": false,
307
   "user_notes_count": 1,
308
   "due_date": null,
309 310
   "web_url": "http://example.com/example/example/issues/1",
   "confidential": false
Nihad Abbasov committed
311 312 313 314 315
}
```

## New issue

316
Creates a new project issue.
Nihad Abbasov committed
317 318 319 320 321

```
POST /projects/:id/issues
```

322 323 324 325 326
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`            | integer | yes | The ID of a project |
| `title`         | string  | yes | The title of an issue |
| `description`   | string  | no  | The description of an issue  |
327
| `confidential`  | boolean | no  | Set an issue to be confidential. Default is `false`.  |
328 329 330
| `assignee_id`   | integer | no  | The ID of a user to assign issue |
| `milestone_id`  | integer | no  | The ID of a milestone to assign issue |
| `labels`        | string  | no  | Comma-separated label names for an issue  |
331
| `created_at`    | string  | no  | Date time string, ISO 8601 formatted, e.g. `2016-03-11T03:45:40Z` (requires admin or project owner rights) |
332
| `due_date`      | string  | no  | Date time string in the format YEAR-MONTH-DAY, e.g. `2016-03-11` |
333
| `merge_request_for_resolving_discussions` | integer | no       | The IID of a merge request in which to resolve all issues. This will fill the issue with a default description and mark all discussions as resolved. When passing a description or title, these values will take precedence over the default values. |
334 335

```bash
336
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/4/issues?title=Issues%20with%20auth&labels=bug
337
```
Nihad Abbasov committed
338

339
Example response:
Nihad Abbasov committed
340

341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
```json
{
   "project_id" : 4,
   "id" : 84,
   "created_at" : "2016-01-07T12:44:33.959Z",
   "iid" : 14,
   "title" : "Issues with auth",
   "state" : "opened",
   "assignee" : null,
   "labels" : [
      "bug"
   ],
   "author" : {
      "name" : "Alexandra Bashirian",
      "avatar_url" : null,
      "state" : "active",
357
      "web_url" : "https://gitlab.example.com/eileen.lowe",
358 359 360 361 362
      "id" : 18,
      "username" : "eileen.lowe"
   },
   "description" : null,
   "updated_at" : "2016-01-07T12:44:33.959Z",
363
   "milestone" : null,
364
   "subscribed" : true,
365
   "user_notes_count": 0,
366
   "due_date": null,
367 368
   "web_url": "http://example.com/example/example/issues/14",
   "confidential": false
369 370
}
```
371

Nihad Abbasov committed
372 373
## Edit issue

374 375 376
Updates an existing project issue. This call is also used to mark an issue as
closed.

Nihad Abbasov committed
377 378 379 380
```
PUT /projects/:id/issues/:issue_id
```

381 382 383 384 385 386
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`            | integer | yes | The ID of a project |
| `issue_id`      | integer | yes | The ID of a project's issue |
| `title`         | string  | no  | The title of an issue |
| `description`   | string  | no  | The description of an issue  |
387
| `confidential`  | boolean | no  | Updates an issue to be confidential |
388 389 390 391
| `assignee_id`   | integer | no  | The ID of a user to assign the issue to |
| `milestone_id`  | integer | no  | The ID of a milestone to assign the issue to |
| `labels`        | string  | no  | Comma-separated label names for an issue  |
| `state_event`   | string  | no  | The state event of an issue. Set `close` to close the issue and `reopen` to reopen it |
392
| `updated_at`    | string  | no  | Date time string, ISO 8601 formatted, e.g. `2016-03-11T03:45:40Z` (requires admin or project owner rights) |
393
| `due_date`      | string  | no  | Date time string in the format YEAR-MONTH-DAY, e.g. `2016-03-11` |
394 395

```bash
396
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/4/issues/85?state_event=close
397
```
Nihad Abbasov committed
398

399
Example response:
400

401 402 403 404 405 406 407 408 409
```json
{
   "created_at" : "2016-01-07T12:46:01.410Z",
   "author" : {
      "name" : "Alexandra Bashirian",
      "avatar_url" : null,
      "username" : "eileen.lowe",
      "id" : 18,
      "state" : "active",
410
      "web_url" : "https://gitlab.example.com/eileen.lowe"
411 412 413 414 415 416 417 418 419 420 421 422
   },
   "state" : "closed",
   "title" : "Issues with auth",
   "project_id" : 4,
   "description" : null,
   "updated_at" : "2016-01-07T12:55:16.213Z",
   "iid" : 15,
   "labels" : [
      "bug"
   ],
   "id" : 85,
   "assignee" : null,
423
   "milestone" : null,
424
   "subscribed" : true,
425
   "user_notes_count": 0,
426
   "due_date": "2016-07-22",
427 428
   "web_url": "http://example.com/example/example/issues/15",
   "confidential": false
429 430
}
```
431

432
## Delete an issue
433

434
Only for admins and project owners. Soft deletes the issue in question.
435 436 437 438 439

```
DELETE /projects/:id/issues/:issue_id
```

440 441 442 443 444 445
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`            | integer | yes | The ID of a project |
| `issue_id`      | integer | yes | The ID of a project's issue |

```bash
446
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/4/issues/85
447 448
```

449 450
## Move an issue

451
Moves an issue to a different project. If the target project
452 453
equals the source project or the user has insufficient permissions to move an
issue, error `400` together with an explaining error message is returned.
454

455 456 457
If a given label and/or milestone with the same name also exists in the target
project, it will then be assigned to the issue that is being moved.

458 459 460 461 462 463 464 465
```
POST /projects/:id/issues/:issue_id/move
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID of a project |
| `issue_id` | integer | yes | The ID of a project's issue |
466
| `to_project_id` | integer | yes | The ID of the new project |
467 468

```bash
469
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/4/issues/85/move
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
```

Example response:

```json
{
  "id": 92,
  "iid": 11,
  "project_id": 5,
  "title": "Sit voluptas tempora quisquam aut doloribus et.",
  "description": "Repellat voluptas quibusdam voluptatem exercitationem.",
  "state": "opened",
  "created_at": "2016-04-05T21:41:45.652Z",
  "updated_at": "2016-04-07T12:20:17.596Z",
  "labels": [],
  "milestone": null,
  "assignee": {
    "name": "Miss Monserrate Beier",
    "username": "axel.block",
    "id": 12,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon",
492
    "web_url": "https://gitlab.example.com/axel.block"
493 494 495 496 497 498 499
  },
  "author": {
    "name": "Kris Steuber",
    "username": "solon.cremin",
    "id": 10,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/7a190fecbaa68212a4b68aeb6e3acd10?s=80&d=identicon",
500
    "web_url": "https://gitlab.example.com/solon.cremin"
501
  },
502
  "due_date": null,
503 504
  "web_url": "http://example.com/example/example/issues/11",
  "confidential": false
505 506 507
}
```

508 509
## Subscribe to an issue

510
Subscribes the authenticated user to an issue to receive notifications.
511 512
If the user is already subscribed to the issue, the status code `304`
is returned.
513 514

```
515
POST /projects/:id/issues/:issue_id/subscription
516 517 518 519 520 521 522 523
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID of a project |
| `issue_id` | integer | yes | The ID of a project's issue |

```bash
524
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/issues/93/subscription
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
```

Example response:

```json
{
  "id": 92,
  "iid": 11,
  "project_id": 5,
  "title": "Sit voluptas tempora quisquam aut doloribus et.",
  "description": "Repellat voluptas quibusdam voluptatem exercitationem.",
  "state": "opened",
  "created_at": "2016-04-05T21:41:45.652Z",
  "updated_at": "2016-04-07T12:20:17.596Z",
  "labels": [],
  "milestone": null,
  "assignee": {
    "name": "Miss Monserrate Beier",
    "username": "axel.block",
    "id": 12,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon",
547
    "web_url": "https://gitlab.example.com/axel.block"
548 549 550 551 552 553 554
  },
  "author": {
    "name": "Kris Steuber",
    "username": "solon.cremin",
    "id": 10,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/7a190fecbaa68212a4b68aeb6e3acd10?s=80&d=identicon",
555
    "web_url": "https://gitlab.example.com/solon.cremin"
556
  },
557
  "due_date": null,
558 559
  "web_url": "http://example.com/example/example/issues/11",
  "confidential": false
560 561 562 563 564
}
```

## Unsubscribe from an issue

565
Unsubscribes the authenticated user from the issue to not receive notifications
566 567
from it. If the user is not subscribed to the issue, the
status code `304` is returned.
568 569

```
570
DELETE /projects/:id/issues/:issue_id/subscription
571 572 573 574 575 576 577 578
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID of a project |
| `issue_id` | integer | yes | The ID of a project's issue |

```bash
579
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/issues/93/subscription
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
```

Example response:

```json
{
  "id": 93,
  "iid": 12,
  "project_id": 5,
  "title": "Incidunt et rerum ea expedita iure quibusdam.",
  "description": "Et cumque architecto sed aut ipsam.",
  "state": "opened",
  "created_at": "2016-04-05T21:41:45.217Z",
  "updated_at": "2016-04-07T13:02:37.905Z",
  "labels": [],
  "milestone": null,
  "assignee": {
    "name": "Edwardo Grady",
    "username": "keyon",
    "id": 21,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/3e6f06a86cf27fa8b56f3f74f7615987?s=80&d=identicon",
602
    "web_url": "https://gitlab.example.com/keyon"
603 604 605 606 607 608 609
  },
  "author": {
    "name": "Vivian Hermann",
    "username": "orville",
    "id": 11,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/5224fd70153710e92fb8bcf79ac29d67?s=80&d=identicon",
610
    "web_url": "https://gitlab.example.com/orville"
611
  },
612
  "subscribed": false,
613
  "due_date": null,
614 615
  "web_url": "http://example.com/example/example/issues/12",
  "confidential": false
616 617 618
}
```

619 620
## Create a todo

621
Manually creates a todo for the current user on an issue. If
622 623 624 625 626 627 628 629 630 631 632 633 634
there already exists a todo for the user on that issue, status code `304` is
returned.

```
POST /projects/:id/issues/:issue_id/todo
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID of a project |
| `issue_id` | integer | yes | The ID of a project's issue |

```bash
635
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/issues/93/todo
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
```

Example response:

```json
{
  "id": 112,
  "project": {
    "id": 5,
    "name": "Gitlab Ci",
    "name_with_namespace": "Gitlab Org / Gitlab Ci",
    "path": "gitlab-ci",
    "path_with_namespace": "gitlab-org/gitlab-ci"
  },
  "author": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
656
    "web_url": "https://gitlab.example.com/root"
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
  },
  "action_name": "marked",
  "target_type": "Issue",
  "target": {
    "id": 93,
    "iid": 10,
    "project_id": 5,
    "title": "Vel voluptas atque dicta mollitia adipisci qui at.",
    "description": "Tempora laboriosam sint magni sed voluptas similique.",
    "state": "closed",
    "created_at": "2016-06-17T07:47:39.486Z",
    "updated_at": "2016-07-01T11:09:13.998Z",
    "labels": [],
    "milestone": {
      "id": 26,
      "iid": 1,
      "project_id": 5,
      "title": "v0.0",
      "description": "Accusantium nostrum rerum quae quia quis nesciunt suscipit id.",
      "state": "closed",
      "created_at": "2016-06-17T07:47:33.832Z",
      "updated_at": "2016-06-17T07:47:33.832Z",
      "due_date": null
    },
    "assignee": {
      "name": "Jarret O'Keefe",
      "username": "francisca",
      "id": 14,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/a7fa515d53450023c83d62986d0658a8?s=80&d=identicon",
687
      "web_url": "https://gitlab.example.com/francisca"
688 689 690 691 692 693 694
    },
    "author": {
      "name": "Maxie Medhurst",
      "username": "craig_rutherford",
      "id": 12,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/a0d477b3ea21970ce6ffcbb817b0b435?s=80&d=identicon",
695
      "web_url": "https://gitlab.example.com/craig_rutherford"
696 697 698 699
    },
    "subscribed": true,
    "user_notes_count": 7,
    "upvotes": 0,
700 701
    "downvotes": 0,
    "due_date": null,
702 703
    "web_url": "http://example.com/example/example/issues/110",
    "confidential": false
704 705 706 707 708 709 710 711
  },
  "target_url": "https://gitlab.example.com/gitlab-org/gitlab-ci/issues/10",
  "body": "Vel voluptas atque dicta mollitia adipisci qui at.",
  "state": "pending",
  "created_at": "2016-07-01T11:09:13.992Z"
}
```

712 713
## Comments on issues

714
Comments are done via the [notes](notes.md) resource.