notes.md 5.04 KB
Newer Older
Marin Jankovski's avatar
Marin Jankovski committed
1 2
# Notes

3
Notes are comments on snippets, issues or merge requests.
4 5 6 7 8 9

## Issues

### List project issue notes

Gets a list of all notes for a single issue.
Nihad Abbasov's avatar
Nihad Abbasov committed
10 11 12 13 14 15 16

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

Parameters:

Ciro Santilli's avatar
Ciro Santilli committed
17 18
- `id` (required) - The ID of a project
- `issue_id` (required) - The ID of an issue
Nihad Abbasov's avatar
Nihad Abbasov committed
19

20 21 22
```json
[
  {
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
23
    "id": 302,
24
    "body": "Status changed to closed",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
25 26 27 28 29 30 31 32
    "attachment": null,
    "author": {
      "id": 1,
      "username": "pipin",
      "email": "admin@example.com",
      "name": "Pip",
      "state": "active",
      "created_at": "2013-09-30T13:46:01Z"
33
    },
34 35 36 37
    "created_at": "2013-10-02T09:22:45Z",
    "system": true,
    "upvote": false,
    "downvote": false
38 39
  },
  {
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
40 41 42 43 44 45 46 47 48 49
    "id": 305,
    "body": "Text of the comment\r\n",
    "attachment": null,
    "author": {
      "id": 1,
      "username": "pipin",
      "email": "admin@example.com",
      "name": "Pip",
      "state": "active",
      "created_at": "2013-09-30T13:46:01Z"
50
    },
51 52 53 54
    "created_at": "2013-10-02T09:56:03Z",
    "system": false,
    "upvote": false,
    "downvote": false
55 56 57
  }
]
```
58 59 60 61

### Get single issue note

Returns a single note for a specific project issue
Nihad Abbasov's avatar
Nihad Abbasov committed
62 63

```
64
GET /projects/:id/issues/:issue_id/notes/:note_id
Nihad Abbasov's avatar
Nihad Abbasov committed
65 66 67 68
```

Parameters:

Ciro Santilli's avatar
Ciro Santilli committed
69 70 71
- `id` (required) - The ID of a project
- `issue_id` (required) - The ID of a project issue
- `note_id` (required) - The ID of an issue note
Nihad Abbasov's avatar
Nihad Abbasov committed
72

73
### Create new issue note
Nihad Abbasov's avatar
Nihad Abbasov committed
74

75
Creates a new note to a single project issue.
Nihad Abbasov's avatar
Nihad Abbasov committed
76 77

```
78
POST /projects/:id/issues/:issue_id/notes
Nihad Abbasov's avatar
Nihad Abbasov committed
79 80 81 82
```

Parameters:

Ciro Santilli's avatar
Ciro Santilli committed
83 84 85
- `id` (required) - The ID of a project
- `issue_id` (required) - The ID of an issue
- `body` (required) - The content of a note
86

87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
### Modify existing issue note

Modify existing note of an issue.

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

Parameters:

- `id` (required) - The ID of a project
- `issue_id` (required) - The ID of an issue
- `note_id` (required) - The ID of a note
- `body` (required) - The content of a note

102 103 104 105 106
## Snippets

### List all snippet notes

Gets a list of all notes for a single snippet. Snippet notes are comments users can post to a snippet.
Nihad Abbasov's avatar
Nihad Abbasov committed
107 108

```
109
GET /projects/:id/snippets/:snippet_id/notes
Nihad Abbasov's avatar
Nihad Abbasov committed
110 111 112 113
```

Parameters:

Ciro Santilli's avatar
Ciro Santilli committed
114 115
- `id` (required) - The ID of a project
- `snippet_id` (required) - The ID of a project snippet
Nihad Abbasov's avatar
Nihad Abbasov committed
116

117
### Get single snippet note
Nihad Abbasov's avatar
Nihad Abbasov committed
118

119
Returns a single note for a given snippet.
Nihad Abbasov's avatar
Nihad Abbasov committed
120 121

```
122
GET /projects/:id/snippets/:snippet_id/notes/:note_id
Nihad Abbasov's avatar
Nihad Abbasov committed
123 124 125 126
```

Parameters:

Ciro Santilli's avatar
Ciro Santilli committed
127 128 129
- `id` (required) - The ID of a project
- `snippet_id` (required) - The ID of a project snippet
- `note_id` (required) - The ID of an snippet note
Nihad Abbasov's avatar
Nihad Abbasov committed
130

131 132
```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
133 134 135 136 137 138 139 140 141 142
  "id": 52,
  "title": "Snippet",
  "file_name": "snippet.rb",
  "author": {
    "id": 1,
    "username": "pipin",
    "email": "admin@example.com",
    "name": "Pip",
    "state": "active",
    "created_at": "2013-09-30T13:46:01Z"
143
  },
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
144 145 146
  "expires_at": null,
  "updated_at": "2013-10-02T07:34:20Z",
  "created_at": "2013-10-02T07:34:20Z"
147 148
}
```
149 150 151 152

### Create new snippet note

Creates a new note for a single snippet. Snippet notes are comments users can post to a snippet.
153 154

```
155
POST /projects/:id/snippets/:snippet_id/notes
156 157 158 159
```

Parameters:

Ciro Santilli's avatar
Ciro Santilli committed
160
- `id` (required) - The ID of a project
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
- `snippet_id` (required) - The ID of a snippet
- `body` (required) - The content of a note

### Modify existing snippet note

Modify existing note of a snippet.

```
PUT /projects/:id/snippets/:snippet_id/notes/:note_id
```

Parameters:

- `id` (required) - The ID of a project
- `snippet_id` (required) - The ID of a snippet
- `note_id` (required) - The ID of a note
Ciro Santilli's avatar
Ciro Santilli committed
177
- `body` (required) - The content of a note
178 179 180 181 182 183

## Merge Requests

### List all merge request notes

Gets a list of all notes for a single merge request.
Nihad Abbasov's avatar
Nihad Abbasov committed
184 185

```
186
GET /projects/:id/merge_requests/:merge_request_id/notes
Nihad Abbasov's avatar
Nihad Abbasov committed
187 188 189 190
```

Parameters:

Ciro Santilli's avatar
Ciro Santilli committed
191 192
- `id` (required) - The ID of a project
- `merge_request_id` (required) - The ID of a project merge request
Nihad Abbasov's avatar
Nihad Abbasov committed
193

194 195 196
### Get single merge request note

Returns a single note for a given merge request.
Nihad Abbasov's avatar
Nihad Abbasov committed
197 198

```
199
GET /projects/:id/merge_requests/:merge_request_id/notes/:note_id
Nihad Abbasov's avatar
Nihad Abbasov committed
200 201 202 203
```

Parameters:

Ciro Santilli's avatar
Ciro Santilli committed
204 205 206
- `id` (required) - The ID of a project
- `merge_request_id` (required) - The ID of a project merge request
- `note_id` (required) - The ID of a merge request note
207

208 209
```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
210 211 212 213 214 215 216 217 218 219
  "id": 301,
  "body": "Comment for MR",
  "attachment": null,
  "author": {
    "id": 1,
    "username": "pipin",
    "email": "admin@example.com",
    "name": "Pip",
    "state": "active",
    "created_at": "2013-09-30T13:46:01Z"
220
  },
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
221
  "created_at": "2013-10-02T08:57:14Z"
222 223
}
```
224 225 226 227 228 229 230 231 232 233 234

### Create new merge request note

Creates a new note for a single merge request.

```
POST /projects/:id/merge_requests/:merge_request_id/notes
```

Parameters:

Ciro Santilli's avatar
Ciro Santilli committed
235 236 237
- `id` (required) - The ID of a project
- `merge_request_id` (required) - The ID of a merge request
- `body` (required) - The content of a note
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252

### Modify existing merge request note

Modify existing note of a merge request.

```
PUT /projects/:id/merge_requests/:merge_request_id/notes/:note_id
```

Parameters:

- `id` (required) - The ID of a project
- `merge_request_id` (required) - The ID of a merge request
- `note_id` (required) - The ID of a note
- `body` (required) - The content of a note