deac/gitlabhq
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

A few fixes in documentation to notes, updates infos on status codes

Browse source 
A few fixes in the notes URI pattern (`notes` instead of `:notes`), also updated
the information to status codes. If `body` attribute is missing from a POST request
a status code 400 (Bad request) is returned. This reflects the code changes from
the previous commit.
This commit is contained in:
Sebastian Ziebell 2013-02-06 16:41:36 +01:00
parent bb24275f8d
commit a534c9b72d
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/api/notes.md
View file

@ -76,7 +76,7 @@ Parameters:
Get an issue note. Get an issue note.
``` ```
GET /projects/:id/issues/:issue_id/:notes/:note_id GET /projects/:id/issues/:issue_id/notes/:note_id
``` ```
Parameters: Parameters:
@ -90,7 +90,7 @@ Parameters:
Get a snippet note. Get a snippet note.
``` ```
GET /projects/:id/issues/:snippet_id/:notes/:note_id GET /projects/:id/issues/:snippet_id/notes/:note_id
``` ```
Parameters: Parameters:
@ -114,7 +114,7 @@ Parameters:
+ `id` (required) - The ID of a project + `id` (required) - The ID of a project
+ `body` (required) - The content of a note + `body` (required) - The content of a note
Will return created note with status `201 Created` on success, or `404 Not found` on fail. Will return created note with status `201 Created` on success, `400 Bad Request` if the body attribute is missing or `404 Not found` on fail.
### New issue note ### New issue note
@ -131,7 +131,7 @@ Parameters:
+ `issue_id` (required) - The ID of an issue + `issue_id` (required) - The ID of an issue
+ `body` (required) - The content of a note + `body` (required) - The content of a note
Will return created note with status `201 Created` on success, or `404 Not found` on fail. Will return created note with status `201 Created` on success, `400 Bad Request` if the body attribute is missing or `404 Not found` on fail.
### New snippet note ### New snippet note
@ -147,4 +147,4 @@ Parameters:
+ `snippet_id` (required) - The ID of an snippet + `snippet_id` (required) - The ID of an snippet
+ `body` (required) - The content of a note + `body` (required) - The content of a note
Will return created note with status `201 Created` on success, or `404 Not found` on fail. Will return created note with status `201 Created` on success, `400 Bad Request` if the body attribute is missing or `404 Not found` on fail.