gitlabhq/doc/api/notes.md

277 lines
5.8 KiB
Markdown
Raw Normal View History

## Wall
2012-11-29 21:32:05 +01:00
### 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,
"username": "john_smith",
2012-11-29 21:32:05 +01:00
"email": "john@example.com",
"name": "John Smith",
"blocked": false,
"created_at": "2012-05-23T08:00:58Z"
},
"created_at": "2012-11-27T19:16:44Z"
2012-11-29 21:32:05 +01:00
}
]
```
Parameters:
+ `id` (required) - The ID of a project
2012-11-29 21:32:05 +01:00
Return values:
2013-01-31 07:46:59 +01:00
+ `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.
2013-01-31 07:46:59 +01:00
```
GET /projects/:id/notes/:note_id
2013-01-31 07:46:59 +01:00
```
Parameters:
+ `id` (required) - The ID of a project
+ `note_id` (required) - The ID of a wall note
2013-01-31 07:46:59 +01:00
Return values:
2012-11-29 21:32:05 +01:00
+ `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.
2012-11-29 21:32:05 +01:00
```
GET /projects/:id/issues/:issue_id/notes
```
Parameters:
+ `id` (required) - The ID of a project
2012-11-29 21:32:05 +01:00
+ `issue_id` (required) - The ID of an issue
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
2012-11-29 21:32:05 +01:00
### Get single issue note
Returns a single note for a specific project issue
2012-11-29 21:32:05 +01:00
```
GET /projects/:id/issues/:issue_id/notes/:note_id
2012-11-29 21:32:05 +01:00
```
Parameters:
+ `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
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
2012-11-29 21:32:05 +01:00
### Create new issue note
2012-12-01 11:20:45 +01:00
Creates a new note to a single project issue.
2012-12-01 11:20:45 +01:00
```
POST /projects/:id/issues/:issue_id/notes
2012-12-01 11:20:45 +01:00
```
Parameters:
+ `id` (required) - The ID of a project
+ `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
2012-12-01 11:20:45 +01:00
2012-11-29 21:32:05 +01:00
## 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 21:32:05 +01:00
```
GET /projects/:id/snippets/:snippet_id/notes
2012-11-29 21:32:05 +01:00
```
Parameters:
+ `id` (required) - The ID of a project
+ `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
2012-11-29 21:32:05 +01:00
### Get single snippet note
2012-11-29 21:32:05 +01:00
Returns a single note for a given snippet.
2012-11-29 21:32:05 +01:00
```
GET /projects/:id/snippets/:snippet_id/notes/:note_id
2012-11-29 21:32:05 +01:00
```
Parameters:
+ `id` (required) - The ID of a project
2012-11-29 21:32:05 +01:00
+ `snippet_id` (required) - The ID of a project snippet
+ `note_id` (required) - The ID of an snippet note
Return values:
2012-11-29 21:32:05 +01:00
+ `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
2012-11-30 00:52:56 +01:00
### Create new snippet note
Creates a new note for a single snippet. Snippet notes are comments users can post to a snippet.
2012-11-30 00:52:56 +01:00
```
POST /projects/:id/snippets/:snippet_id/notes
2012-11-30 00:52:56 +01:00
```
Parameters:
+ `id` (required) - The ID of a project
+ `snippet_id` (required) - The ID of an snippet
2012-11-30 00:52:56 +01:00
+ `body` (required) - The content of a note
Return values:
2012-11-30 00:52:56 +01:00
+ `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
2012-11-30 00:52:56 +01:00
2012-11-29 21:32:05 +01:00
## Merge Requests
### List all merge request notes
Gets a list of all notes for a single merge request.
2012-11-29 21:32:05 +01:00
```
GET /projects/:id/merge_requests/:merge_request_id/notes
2012-11-29 21:32:05 +01:00
```
Parameters:
+ `id` (required) - The ID of a project
+ `merge_request_id` (required) - The ID of a project merge request
Return values:
2012-11-29 21:32:05 +01:00
+ `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
2012-11-29 21:32:05 +01:00
### Get single merge request note
Returns a single note for a given merge request.
2012-11-29 21:32:05 +01:00
```
GET /projects/:id/merge_requests/:merge_request_id/notes/:note_id
2012-11-29 21:32:05 +01:00
```
Parameters:
+ `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
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
2012-11-29 21:32:05 +01:00
+ `body` (required) - The content of a note
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