gitlab-org--gitlab-foss/doc/api/notes.md

253 lines
5 KiB
Markdown
Raw Normal View History

2014-05-27 08:12:15 -04:00
# Notes
Notes are comments on snippets, issues or merge requests.
## Issues
### List project issue notes
Gets a list of all notes for a single issue.
2012-11-29 15:32:05 -05:00
```
GET /projects/:id/issues/:issue_id/notes
```
Parameters:
2014-08-15 03:03:18 -04:00
- `id` (required) - The ID of a project
- `issue_id` (required) - The ID of an issue
2012-11-29 15:32:05 -05:00
```json
[
{
2014-04-05 02:36:47 -04:00
"id": 302,
"body": "Status changed to closed",
2014-04-05 02:36:47 -04:00
"attachment": null,
"author": {
"id": 1,
"username": "pipin",
"email": "admin@example.com",
"name": "Pip",
"state": "active",
"created_at": "2013-09-30T13:46:01Z"
},
"created_at": "2013-10-02T09:22:45Z",
"system": true,
"upvote": false,
"downvote": false
},
{
2014-04-05 02:36:47 -04:00
"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"
},
"created_at": "2013-10-02T09:56:03Z",
"system": false,
"upvote": false,
"downvote": false
}
]
```
### Get single issue note
Returns a single note for a specific project issue
2012-11-29 15:32:05 -05:00
```
GET /projects/:id/issues/:issue_id/notes/:note_id
2012-11-29 15:32:05 -05:00
```
Parameters:
2014-08-15 03:03:18 -04:00
- `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
2012-11-29 15:32:05 -05:00
### Create new issue note
2012-12-01 05:20:45 -05:00
Creates a new note to a single project issue.
2012-12-01 05:20:45 -05:00
```
POST /projects/:id/issues/:issue_id/notes
2012-12-01 05:20:45 -05:00
```
Parameters:
2014-08-15 03:03:18 -04:00
- `id` (required) - The ID of a project
- `issue_id` (required) - The ID of an issue
- `body` (required) - The content of a note
### 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
## 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.
2012-11-29 15:32:05 -05:00
```
GET /projects/:id/snippets/:snippet_id/notes
2012-11-29 15:32:05 -05:00
```
Parameters:
2014-08-15 03:03:18 -04:00
- `id` (required) - The ID of a project
- `snippet_id` (required) - The ID of a project snippet
2012-11-29 15:32:05 -05:00
### Get single snippet note
2012-11-29 15:32:05 -05:00
Returns a single note for a given snippet.
2012-11-29 15:32:05 -05:00
```
GET /projects/:id/snippets/:snippet_id/notes/:note_id
2012-11-29 15:32:05 -05:00
```
Parameters:
2014-08-15 03:03:18 -04:00
- `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
2012-11-29 15:32:05 -05:00
```json
{
2014-04-05 02:36:47 -04:00
"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"
},
2014-04-05 02:36:47 -04:00
"expires_at": null,
"updated_at": "2013-10-02T07:34:20Z",
"created_at": "2013-10-02T07:34:20Z"
}
```
### Create new snippet note
Creates a new note for a single snippet. Snippet notes are comments users can post to a snippet.
2012-11-29 18:52:56 -05:00
```
POST /projects/:id/snippets/:snippet_id/notes
2012-11-29 18:52:56 -05:00
```
Parameters:
2014-08-15 03:03:18 -04:00
- `id` (required) - The ID of a project
- `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
2014-08-15 03:03:18 -04:00
- `body` (required) - The content of a note
## Merge Requests
### List all merge request notes
Gets a list of all notes for a single merge request.
2012-11-29 15:32:05 -05:00
```
GET /projects/:id/merge_requests/:merge_request_id/notes
2012-11-29 15:32:05 -05:00
```
Parameters:
2014-08-15 03:03:18 -04:00
- `id` (required) - The ID of a project
- `merge_request_id` (required) - The ID of a project merge request
2012-11-29 15:32:05 -05:00
### Get single merge request note
Returns a single note for a given merge request.
2012-11-29 15:32:05 -05:00
```
GET /projects/:id/merge_requests/:merge_request_id/notes/:note_id
2012-11-29 15:32:05 -05:00
```
Parameters:
2014-08-15 03:03:18 -04:00
- `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
```json
{
2014-04-05 02:36:47 -04:00
"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"
},
2014-04-05 02:36:47 -04:00
"created_at": "2013-10-02T08:57:14Z"
}
```
### Create new merge request note
Creates a new note for a single merge request.
```
POST /projects/:id/merge_requests/:merge_request_id/notes
```
Parameters:
2014-08-15 03:03:18 -04:00
- `id` (required) - The ID of a project
- `merge_request_id` (required) - The ID of a merge request
- `body` (required) - The content of a note
### 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