BigW Consortium Gitlab

issues.md 21.8 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
26 27
GET /issues?milestone=1.0.0
GET /issues?milestone=1.0.0&state=opened
Nihad Abbasov committed
28 29
```

30 31 32
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `state`   | string  | no    | Return all issues or just those that are `opened` or `closed`|
33
| `labels`  | string  | no    | Comma-separated list of label names, issues with any of the labels will be returned |
34
| `milestone` | string| no    | The milestone title |
35 36 37 38
| `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
39
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/issues
40
```
41

42
Example response:
43

Nihad Abbasov committed
44 45
```json
[
46 47 48 49 50 51
   {
      "state" : "opened",
      "description" : "Ratione dolores corrupti mollitia soluta quia.",
      "author" : {
         "state" : "active",
         "id" : 18,
52
         "web_url" : "https://gitlab.example.com/eileen.lowe",
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
         "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",
73
         "web_url" : "https://gitlab.example.com/root",
74 75 76 77 78 79 80 81
         "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,
82
      "labels" : [],
83
      "subscribed" : false,
84
      "user_notes_count": 1,
85
      "due_date": "2016-07-22",
86 87
      "web_url": "http://example.com/example/example/issues/6",
      "confidential": false
88
   }
Nihad Abbasov committed
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 115 116 117
## 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
118
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/groups/4/issues
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
```

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",
140
         "web_url" : "https://gitlab.example.com/root",
141 142 143 144 145 146 147 148 149 150
         "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,
151
         "web_url" : "https://gitlab.example.com/lennie",
152 153 154 155 156 157 158 159 160 161 162
         "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,
163
      "user_notes_count": 1,
164
      "due_date": null,
165 166
      "web_url": "http://example.com/example/example/issues/1",
      "confidential": false
167 168 169 170
   }
]
```

Nihad Abbasov committed
171 172
## List project issues

173
Get a list of a project's issues.
Nihad Abbasov committed
174 175 176

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

187 188 189 190 191
| 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`|
192
| `labels`  | string  | no    | Comma-separated list of label names, issues with any of the labels will be returned |
193 194 195 196 197 198
| `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
199
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/4/issues
200 201 202
```

Example response:
Nihad Abbasov committed
203

204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
```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",
221
         "web_url" : "https://gitlab.example.com/root",
222 223 224 225 226 227 228 229 230 231
         "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,
232
         "web_url" : "https://gitlab.example.com/lennie",
233 234 235 236 237 238 239 240 241
         "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",
242
      "created_at" : "2016-01-04T15:31:46.176Z",
243
      "subscribed" : false,
244
      "user_notes_count": 1,
245
      "due_date": "2016-07-22",
246 247
      "web_url": "http://example.com/example/example/issues/1",
      "confidential": false
248 249 250
   }
]
```
251

Nihad Abbasov committed
252 253
## Single issue

254
Get a single project issue.
Nihad Abbasov committed
255 256 257 258 259

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

260 261 262 263
| 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
264

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

Example response:
Nihad Abbasov committed
270 271 272

```json
{
273 274 275 276 277 278 279 280 281 282 283 284 285 286
   "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",
287
      "web_url" : "https://gitlab.example.com/root",
288 289 290 291 292 293 294 295 296 297
      "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,
298
      "web_url" : "https://gitlab.example.com/lennie",
299 300 301 302 303 304 305 306 307
      "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",
308
   "created_at" : "2016-01-04T15:31:46.176Z",
309
   "subscribed": false,
310
   "user_notes_count": 1,
311
   "due_date": null,
312 313
   "web_url": "http://example.com/example/example/issues/1",
   "confidential": false
Nihad Abbasov committed
314 315 316 317 318
}
```

## New issue

319
Creates a new project issue.
Nihad Abbasov committed
320 321 322 323 324

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

325 326 327 328 329
| 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  |
330
| `confidential`  | boolean | no  | Set an issue to be confidential. Default is `false`.  |
331 332 333
| `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  |
334
| `created_at`    | string  | no  | Date time string, ISO 8601 formatted, e.g. `2016-03-11T03:45:40Z` (requires admin or project owner rights) |
335
| `due_date`      | string  | no  | Date time string in the format YEAR-MONTH-DAY, e.g. `2016-03-11` |
336
| `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. |
337 338

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

342
Example response:
Nihad Abbasov committed
343

344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
```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",
360
      "web_url" : "https://gitlab.example.com/eileen.lowe",
361 362 363 364 365
      "id" : 18,
      "username" : "eileen.lowe"
   },
   "description" : null,
   "updated_at" : "2016-01-07T12:44:33.959Z",
366
   "milestone" : null,
367
   "subscribed" : true,
368
   "user_notes_count": 0,
369
   "due_date": null,
370 371
   "web_url": "http://example.com/example/example/issues/14",
   "confidential": false
372 373
}
```
374

Nihad Abbasov committed
375 376
## Edit issue

377 378 379
Updates an existing project issue. This call is also used to mark an issue as
closed.

Nihad Abbasov committed
380 381 382 383
```
PUT /projects/:id/issues/:issue_id
```

384 385 386 387 388 389
| 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  |
390
| `confidential`  | boolean | no  | Updates an issue to be confidential |
391 392 393 394
| `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 |
395
| `updated_at`    | string  | no  | Date time string, ISO 8601 formatted, e.g. `2016-03-11T03:45:40Z` (requires admin or project owner rights) |
396
| `due_date`      | string  | no  | Date time string in the format YEAR-MONTH-DAY, e.g. `2016-03-11` |
397 398

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

402
Example response:
403

404 405 406 407 408 409 410 411 412
```json
{
   "created_at" : "2016-01-07T12:46:01.410Z",
   "author" : {
      "name" : "Alexandra Bashirian",
      "avatar_url" : null,
      "username" : "eileen.lowe",
      "id" : 18,
      "state" : "active",
413
      "web_url" : "https://gitlab.example.com/eileen.lowe"
414 415 416 417 418 419 420 421 422 423 424 425
   },
   "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,
426
   "milestone" : null,
427
   "subscribed" : true,
428
   "user_notes_count": 0,
429
   "due_date": "2016-07-22",
430 431
   "web_url": "http://example.com/example/example/issues/15",
   "confidential": false
432 433
}
```
434

435
## Delete an issue
436

437
Only for admins and project owners. Soft deletes the issue in question.
438 439 440 441 442

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

443 444 445 446 447 448
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`            | integer | yes | The ID of a project |
| `issue_id`      | integer | yes | The ID of a project's issue |

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

452 453
## Move an issue

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

458 459 460
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.

461 462 463 464 465 466 467 468
```
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 |
469
| `to_project_id` | integer | yes | The ID of the new project |
470 471

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

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",
495
    "web_url": "https://gitlab.example.com/axel.block"
496 497 498 499 500 501 502
  },
  "author": {
    "name": "Kris Steuber",
    "username": "solon.cremin",
    "id": 10,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/7a190fecbaa68212a4b68aeb6e3acd10?s=80&d=identicon",
503
    "web_url": "https://gitlab.example.com/solon.cremin"
504
  },
505
  "due_date": null,
506 507
  "web_url": "http://example.com/example/example/issues/11",
  "confidential": false
508 509 510
}
```

511 512
## Subscribe to an issue

513
Subscribes the authenticated user to an issue to receive notifications.
514 515
If the user is already subscribed to the issue, the status code `304`
is returned.
516 517

```
518
POST /projects/:id/issues/:issue_id/subscription
519 520 521 522 523 524 525 526
```

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

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

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",
550
    "web_url": "https://gitlab.example.com/axel.block"
551 552 553 554 555 556 557
  },
  "author": {
    "name": "Kris Steuber",
    "username": "solon.cremin",
    "id": 10,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/7a190fecbaa68212a4b68aeb6e3acd10?s=80&d=identicon",
558
    "web_url": "https://gitlab.example.com/solon.cremin"
559
  },
560
  "due_date": null,
561 562
  "web_url": "http://example.com/example/example/issues/11",
  "confidential": false
563 564 565 566 567
}
```

## Unsubscribe from an issue

568
Unsubscribes the authenticated user from the issue to not receive notifications
569 570
from it. If the user is not subscribed to the issue, the
status code `304` is returned.
571 572

```
573
DELETE /projects/:id/issues/:issue_id/subscription
574 575 576 577 578 579 580 581
```

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

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

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",
605
    "web_url": "https://gitlab.example.com/keyon"
606 607 608 609 610 611 612
  },
  "author": {
    "name": "Vivian Hermann",
    "username": "orville",
    "id": 11,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/5224fd70153710e92fb8bcf79ac29d67?s=80&d=identicon",
613
    "web_url": "https://gitlab.example.com/orville"
614
  },
615
  "subscribed": false,
616
  "due_date": null,
617 618
  "web_url": "http://example.com/example/example/issues/12",
  "confidential": false
619 620 621
}
```

622 623
## Create a todo

624
Manually creates a todo for the current user on an issue. If
625 626 627 628 629 630 631 632 633 634 635 636 637
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
638
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/issues/93/todo
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
```

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",
659
    "web_url": "https://gitlab.example.com/root"
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 687 688 689
  },
  "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",
690
      "web_url": "https://gitlab.example.com/francisca"
691 692 693 694 695 696 697
    },
    "author": {
      "name": "Maxie Medhurst",
      "username": "craig_rutherford",
      "id": 12,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/a0d477b3ea21970ce6ffcbb817b0b435?s=80&d=identicon",
698
      "web_url": "https://gitlab.example.com/craig_rutherford"
699 700 701 702
    },
    "subscribed": true,
    "user_notes_count": 7,
    "upvotes": 0,
703 704
    "downvotes": 0,
    "due_date": null,
705 706
    "web_url": "http://example.com/example/example/issues/110",
    "confidential": false
707 708 709 710 711 712 713 714
  },
  "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"
}
```

715 716
## Comments on issues

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