deac/gitlabhq
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
gitlabhq/doc/api/notes.md

199 lines
3.5 KiB
Markdown
Raw Normal View History

API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
## Wall
add docs for notes API
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,
Add username to User and UserBasic entities in API and in examples in doc.
2012-12-10 23:46:31 +01:00
"username": "john_smith",
add docs for notes API
2012-11-29 21:32:05 +01:00
"email": "john@example.com",
"name": "John Smith",
"blocked": false,
"created_at": "2012-05-23T08:00:58Z"
},
API: don't expose 'updated_at' for notes
2012-11-29 23:41:24 +01:00
"created_at": "2012-11-27T19:16:44Z"
add docs for notes API
2012-11-29 21:32:05 +01:00
}
]
```
Parameters:
Remove all references tp the project code parameter from the API
2012-12-21 18:47:04 +01:00
+ `id` (required) - The ID of a project
add docs for notes API
2012-11-29 21:32:05 +01:00
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
### Get single wall note
Returns a single wall note.
missing doc for api
2013-01-31 07:46:59 +01:00
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
GET /projects/:id/notes/:note_id
missing doc for api
2013-01-31 07:46:59 +01:00
```
Parameters:
+ `id` (required) - The ID of a project
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
+ `note_id` (required) - The ID of a wall note
missing doc for api
2013-01-31 07:46:59 +01:00
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
### 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
## Issues
### List project issue notes
Gets a list of all notes for a single issue.
add docs for notes API
2012-11-29 21:32:05 +01:00
```
GET /projects/:id/issues/:issue_id/notes
```
Parameters:
Remove all references tp the project code parameter from the API
2012-12-21 18:47:04 +01:00
+ `id` (required) - The ID of a project
add docs for notes API
2012-11-29 21:32:05 +01:00
+ `issue_id` (required) - The ID of an issue
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
### Get single issue note
Returns a single note for a specific project issue
add docs for notes API
2012-11-29 21:32:05 +01:00
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
GET /projects/:id/issues/:issue_id/notes/:note_id
add docs for notes API
2012-11-29 21:32:05 +01:00
```
Parameters:
Remove all references tp the project code parameter from the API
2012-12-21 18:47:04 +01:00
+ `id` (required) - The ID of a project
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
+ `issue_id` (required) - The ID of a project issue
+ `note_id` (required) - The ID of an issue note
add docs for notes API
2012-11-29 21:32:05 +01:00
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
### Create new issue note
API: get a single wall note
2012-12-01 11:20:45 +01:00
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
Creates a new note to a single project issue.
API: get a single wall note
2012-12-01 11:20:45 +01:00
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
POST /projects/:id/issues/:issue_id/notes
API: get a single wall note
2012-12-01 11:20:45 +01:00
```
Parameters:
Remove all references tp the project code parameter from the API
2012-12-21 18:47:04 +01:00
+ `id` (required) - The ID of a project
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
+ `issue_id` (required) - The ID of an issue
+ `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.
add docs for notes API
2012-11-29 21:32:05 +01:00
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
GET /projects/:id/snippets/:snippet_id/notes
add docs for notes API
2012-11-29 21:32:05 +01:00
```
Parameters:
Remove all references tp the project code parameter from the API
2012-12-21 18:47:04 +01:00
+ `id` (required) - The ID of a project
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
+ `snippet_id` (required) - The ID of a project snippet
add docs for notes API
2012-11-29 21:32:05 +01:00
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
### Get single snippet note
add docs for notes API
2012-11-29 21:32:05 +01:00
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
Returns a single note for a given snippet.
add docs for notes API
2012-11-29 21:32:05 +01:00
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
GET /projects/:id/snippets/:snippet_id/notes/:note_id
add docs for notes API
2012-11-29 21:32:05 +01:00
```
Parameters:
Remove all references tp the project code parameter from the API
2012-12-21 18:47:04 +01:00
+ `id` (required) - The ID of a project
add docs for notes API
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
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
### Create new snippet note
Creates a new note for a single snippet. Snippet notes are comments users can post to a snippet.
API: ability to create a wall note
2012-11-30 00:52:56 +01:00
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
POST /projects/:id/snippets/:snippet_id/notes
API: ability to create a wall note
2012-11-30 00:52:56 +01:00
```
Parameters:
Remove all references tp the project code parameter from the API
2012-12-21 18:47:04 +01:00
+ `id` (required) - The ID of a project
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
+ `snippet_id` (required) - The ID of an snippet
API: ability to create a wall note
2012-11-30 00:52:56 +01:00
+ `body` (required) - The content of a note
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
## Merge Requests
### List all merge request notes
Gets a list of all notes for a single merge request.
add docs for notes API
2012-11-29 21:32:05 +01:00
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
GET /projects/:id/merge_requests/:merge_request_id/notes
add docs for notes API
2012-11-29 21:32:05 +01:00
```
Parameters:
Remove all references tp the project code parameter from the API
2012-12-21 18:47:04 +01:00
+ `id` (required) - The ID of a project
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
+ `merge_request_id` (required) - The ID of a project merge request
add docs for notes API
2012-11-29 21:32:05 +01:00
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
### Get single merge request note
Returns a single note for a given merge request.
add docs for notes API
2012-11-29 21:32:05 +01:00
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
GET /projects/:id/merge_requests/:merge_request_id/notes/:note_id
add docs for notes API
2012-11-29 21:32:05 +01:00
```
Parameters:
Remove all references tp the project code parameter from the API
2012-12-21 18:47:04 +01:00
+ `id` (required) - The ID of a project
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 22:17:05 +01:00
+ `merge_request_id` (required) - The ID of a project merge request
+ `note_id` (required) - The ID of a merge request note
### 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
add docs for notes API
2012-11-29 21:32:05 +01:00
+ `body` (required) - The content of a note
Reference in a new issue Copy permalink