summaryrefslogtreecommitdiff
path: root/doc/api/notes.md
blob: 24f86cca900a94f57b14fa91a221de0b15f49403 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
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
115
116
117
118
119
120
## List notes

### List project wall notes

Get a list of project wall notes.

```
GET /projects/:id/notes
```

```json
[
  {
    "id": 522,
    "body": "The solution is rather tricky",
    "author": {
      "id": 1,
      "email": "john@example.com",
      "name": "John Smith",
      "blocked": false,
      "created_at": "2012-05-23T08:00:58Z"
    },
    "created_at": "2012-11-27T19:16:44Z"
  }
]
```

Parameters:

+ `id` (required) - The ID or code name of a project

### List issue notes

Get a list of issue notes.

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

Parameters:

+ `id` (required) - The ID or code name of a project
+ `issue_id` (required) - The ID of an issue

### List snippet notes

Get a list of snippet notes.

```
GET /projects/:id/snippets/:snippet_id/notes
```

Parameters:

+ `id` (required) - The ID or code name of a project
+ `snippet_id` (required) - The ID of a snippet

## Single note

### Single issue note

Get an issue note.

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

Parameters:

+ `id` (required) - The ID or code name of a project
+ `issue_id` (required) - The ID of a project issue
+ `note_id` (required) - The ID of an issue note

### Single snippet note

Get a snippet note.

```
GET /projects/:id/issues/:snippet_id/:notes/:note_id
```

Parameters:

+ `id` (required) - The ID or code name of a project
+ `snippet_id` (required) - The ID of a project snippet
+ `note_id` (required) - The ID of an snippet note

## New note

### New issue note

Create a new issue note.

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

Parameters:

+ `id` (required) - The ID or code name of a project
+ `issue_id` (required) - The ID of an issue
+ `body` (required) - The content of a note

Will return created note with status `201 Created` on success, or `404 Not found` on fail.

### New snippet note

Create a new snippet note.

```
POST /projects/:id/snippets/:snippet_id/notes
```

Parameters:

+ `id` (required) - The ID or code name of a project
+ `snippet_id` (required) - The ID of an snippet
+ `body` (required) - The content of a note

Will return created note with status `201 Created` on success, or `404 Not found` on fail.