notes.md 5.79 KB
Newer Older
1
## Wall
Nihad Abbasov's avatar
Nihad Abbasov committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

### 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,
18
      "username": "john_smith",
Nihad Abbasov's avatar
Nihad Abbasov committed
19 20 21 22 23
      "email": "john@example.com",
      "name": "John Smith",
      "blocked": false,
      "created_at": "2012-05-23T08:00:58Z"
    },
24
    "created_at": "2012-11-27T19:16:44Z"
Nihad Abbasov's avatar
Nihad Abbasov committed
25 26 27 28 29 30
  }
]
```

Parameters:

31
+ `id` (required) - The ID of a project
Nihad Abbasov's avatar
Nihad Abbasov committed
32

33
Return values:
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
34

35 36 37 38 39 40 41
+ `200 Ok` on success and a list of notes
+ `401 Unauthorized` if user is not authorized to access this page


### Get single wall note

Returns a single wall note.
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
42 43

```
44
GET /projects/:id/notes/:note_id
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
45 46 47 48 49
```

Parameters:

+ `id` (required) - The ID of a project
50
+ `note_id` (required) - The ID of a wall note
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
51

52
Return values:
Nihad Abbasov's avatar
Nihad Abbasov committed
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
+ `200 Ok` on success and the wall note (see example at `GET /projects/:id/notes`)
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if note ID not found


### Create new wall note

Creates a new wall note.

```
POST /projects/:id/notes
```

Parameters:

+ `id` (required) - The ID of a project
+ `body` (required) - The content of a note

Return values:

+ `201 Created` on success and the new wall note
+ `400 Bad Request` if attribute body is not given
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if something else fails



## Issues

### List project issue notes

Gets a list of all notes for a single issue.
Nihad Abbasov's avatar
Nihad Abbasov committed
86 87 88 89 90 91 92

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

Parameters:

93
+ `id` (required) - The ID of a project
Nihad Abbasov's avatar
Nihad Abbasov committed
94 95
+ `issue_id` (required) - The ID of an issue

96 97 98 99 100
Return values:

+ `200 Ok` on success and a list of notes for a single issue
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if project ID or issue ID not found
Nihad Abbasov's avatar
Nihad Abbasov committed
101

102 103 104 105

### Get single issue note

Returns a single note for a specific project issue
Nihad Abbasov's avatar
Nihad Abbasov committed
106 107

```
108
GET /projects/:id/issues/:issue_id/notes/:note_id
Nihad Abbasov's avatar
Nihad Abbasov committed
109 110 111 112
```

Parameters:

113
+ `id` (required) - The ID of a project
114 115 116 117 118 119 120 121
+ `issue_id` (required) - The ID of a project issue
+ `note_id` (required) - The ID of an issue note

Return values:

+ `200 Ok` on success and the single issue note
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if project ID, issue ID or note ID is not found
Nihad Abbasov's avatar
Nihad Abbasov committed
122 123


124
### Create new issue note
Nihad Abbasov's avatar
Nihad Abbasov committed
125

126
Creates a new note to a single project issue.
Nihad Abbasov's avatar
Nihad Abbasov committed
127 128

```
129
POST /projects/:id/issues/:issue_id/notes
Nihad Abbasov's avatar
Nihad Abbasov committed
130 131 132 133
```

Parameters:

134
+ `id` (required) - The ID of a project
135 136 137 138 139 140 141 142 143
+ `issue_id` (required) - The ID of an issue
+ `body` (required) - The content of a note

Return values:

+ `201 Created` on succes and the created note
+ `400 Bad Request` if the required attribute body is not given
+ `401 Unauthorized` if the user is not authenticated
+ `404 Not Found` if the project ID or the issue ID not found
Nihad Abbasov's avatar
Nihad Abbasov committed
144

Nihad Abbasov's avatar
Nihad Abbasov committed
145

146 147 148 149 150 151

## 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
152 153

```
154
GET /projects/:id/snippets/:snippet_id/notes
Nihad Abbasov's avatar
Nihad Abbasov committed
155 156 157 158
```

Parameters:

159
+ `id` (required) - The ID of a project
160 161 162 163 164 165 166 167
+ `snippet_id` (required) - The ID of a project snippet

Return values:

+ `200 Ok` on success and a list of notes for a single snippet
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if project ID or issue ID not found

Nihad Abbasov's avatar
Nihad Abbasov committed
168

169
### Get single snippet note
Nihad Abbasov's avatar
Nihad Abbasov committed
170

171
Returns a single note for a given snippet.
Nihad Abbasov's avatar
Nihad Abbasov committed
172 173

```
174
GET /projects/:id/snippets/:snippet_id/notes/:note_id
Nihad Abbasov's avatar
Nihad Abbasov committed
175 176 177 178
```

Parameters:

179
+ `id` (required) - The ID of a project
Nihad Abbasov's avatar
Nihad Abbasov committed
180 181 182
+ `snippet_id` (required) - The ID of a project snippet
+ `note_id` (required) - The ID of an snippet note

183
Return values:
Nihad Abbasov's avatar
Nihad Abbasov committed
184

185 186 187
+ `200 Ok` on success and the single snippet note
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if project ID, snippet ID or note ID is not found
188

189 190 191 192

### Create new snippet note

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

```
195
POST /projects/:id/snippets/:snippet_id/notes
196 197 198 199
```

Parameters:

200
+ `id` (required) - The ID of a project
201
+ `snippet_id` (required) - The ID of an snippet
202 203
+ `body` (required) - The content of a note

204
Return values:
205

206 207 208 209
+ `201 Created` on success and the new snippet note
+ `400 Bad Request` if the required attribute body not given
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if project ID or snippet ID not found
210

Nihad Abbasov's avatar
Nihad Abbasov committed
211

212 213 214 215 216 217

## 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
218 219

```
220
GET /projects/:id/merge_requests/:merge_request_id/notes
Nihad Abbasov's avatar
Nihad Abbasov committed
221 222 223 224
```

Parameters:

225
+ `id` (required) - The ID of a project
226 227 228
+ `merge_request_id` (required) - The ID of a project merge request

Return values:
Nihad Abbasov's avatar
Nihad Abbasov committed
229

230 231 232
+ `200 Ok` on success and a list of notes for a single merge request
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if project ID or merge request ID not found
Nihad Abbasov's avatar
Nihad Abbasov committed
233 234


235 236 237
### Get single merge request note

Returns a single note for a given merge request.
Nihad Abbasov's avatar
Nihad Abbasov committed
238 239

```
240
GET /projects/:id/merge_requests/:merge_request_id/notes/:note_id
Nihad Abbasov's avatar
Nihad Abbasov committed
241 242 243 244
```

Parameters:

245
+ `id` (required) - The ID of a project
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
+ `merge_request_id` (required) - The ID of a project merge request
+ `note_id` (required) - The ID of a merge request note

Return values:

+ `200 Ok` on success and the single merge request note
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if project ID, merge request ID or note ID is not found


### Create new merge request note

Creates a new note for a single merge request.

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

Parameters:

+ `id` (required) - The ID of a project
+ `merge_request_id` (required) - The ID of a merge request
Nihad Abbasov's avatar
Nihad Abbasov committed
268 269
+ `body` (required) - The content of a note

270 271 272 273 274 275 276
Return values:

+ `201 Created` on success and the new merge request note
+ `400 Bad Request` if the required attribute body not given
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if project ID or merge request ID not found