BigW Consortium Gitlab

notes.md 5.25 KB
Newer Older
1 2
# Notes

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

## Issues

### List project issue notes

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

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

Parameters:

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

20 21 22
```json
[
  {
23
    "id": 302,
24
    "body": "Status changed to closed",
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
    "created_at": "2013-10-02T09:22:45Z",
35 36
    "system": true,
    "upvote": false,
37 38 39
    "downvote": false,
    "noteable_id": 377,
    "noteable_type": "Issue"
40 41
  },
  {
42 43 44 45 46 47 48 49 50 51
    "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"
52
    },
53
    "created_at": "2013-10-02T09:56:03Z",
54 55
    "system": true,
    "upvote": false,
56 57 58
    "downvote": false,
    "noteable_id": 121,
    "noteable_type": "Issue"
59 60 61
  }
]
```
62 63 64 65

### Get single issue note

Returns a single note for a specific project issue
Nihad Abbasov committed
66 67

```
68
GET /projects/:id/issues/:issue_id/notes/:note_id
Nihad Abbasov committed
69 70 71 72
```

Parameters:

Ciro Santilli committed
73 74 75
- `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 committed
76

77
### Create new issue note
78

79
Creates a new note to a single project issue.
80 81

```
82
POST /projects/:id/issues/:issue_id/notes
83 84 85 86
```

Parameters:

Ciro Santilli committed
87 88 89
- `id` (required) - The ID of a project
- `issue_id` (required) - The ID of an issue
- `body` (required) - The content of a note
90

91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
### 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

106 107 108 109 110
## 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 committed
111 112

```
113
GET /projects/:id/snippets/:snippet_id/notes
Nihad Abbasov committed
114 115 116 117
```

Parameters:

Ciro Santilli committed
118 119
- `id` (required) - The ID of a project
- `snippet_id` (required) - The ID of a project snippet
Nihad Abbasov committed
120

121
### Get single snippet note
Nihad Abbasov committed
122

123
Returns a single note for a given snippet.
Nihad Abbasov committed
124 125

```
126
GET /projects/:id/snippets/:snippet_id/notes/:note_id
Nihad Abbasov committed
127 128 129 130
```

Parameters:

Ciro Santilli committed
131 132 133
- `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 committed
134

135 136
```json
{
137 138 139 140 141 142 143 144 145 146
  "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"
147
  },
148
  "expires_at": null,
149 150
  "updated_at": "2013-10-02T07:34:20Z",
  "created_at": "2013-10-02T07:34:20Z"
151 152
}
```
153 154 155 156

### Create new snippet note

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

```
159
POST /projects/:id/snippets/:snippet_id/notes
160 161 162 163
```

Parameters:

Ciro Santilli committed
164
- `id` (required) - The ID of a project
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
- `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 committed
181
- `body` (required) - The content of a note
182 183 184 185 186 187

## Merge Requests

### List all merge request notes

Gets a list of all notes for a single merge request.
Nihad Abbasov committed
188 189

```
190
GET /projects/:id/merge_requests/:merge_request_id/notes
Nihad Abbasov committed
191 192 193 194
```

Parameters:

Ciro Santilli committed
195 196
- `id` (required) - The ID of a project
- `merge_request_id` (required) - The ID of a project merge request
Nihad Abbasov committed
197

198 199 200
### Get single merge request note

Returns a single note for a given merge request.
Nihad Abbasov committed
201 202

```
203
GET /projects/:id/merge_requests/:merge_request_id/notes/:note_id
Nihad Abbasov committed
204 205 206 207
```

Parameters:

Ciro Santilli committed
208 209 210
- `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
211

212 213
```json
{
214 215 216 217 218 219 220 221 222 223
  "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"
224
  },
225 226 227 228 229 230
  "created_at": "2013-10-02T08:57:14Z",
  "system": false,
  "upvote": false,
  "downvote": false,
  "noteable_id": 2,
  "noteable_type": "MergeRequest"
231 232
}
```
233 234 235 236 237 238 239 240 241 242 243

### 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 committed
244 245 246
- `id` (required) - The ID of a project
- `merge_request_id` (required) - The ID of a merge request
- `body` (required) - The content of a note
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261

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