diff options
| author | Sebastian Ziebell <sebastian.ziebell@asquera.de> | 2013-02-06 16:41:36 +0100 |
|---|---|---|
| committer | Sebastian Ziebell <sebastian.ziebell@asquera.de> | 2013-02-06 17:11:00 +0100 |
| commit | a534c9b72d54729122a9ccfe4f43ce5bdaa9bed2 (patch) | |
| tree | c3981b21ab9918f3ca985a1832b0db8c7fb28b7b /doc/api/notes.md | |
| parent | bb24275f8d0e726aec347c8be7f199346e90793d (diff) | |
| download | gitlab-ce-a534c9b72d54729122a9ccfe4f43ce5bdaa9bed2.tar.gz | |
A few fixes in documentation to notes, updates infos on status codes
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.
Diffstat (limited to 'doc/api/notes.md')
| -rw-r--r-- | doc/api/notes.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/api/notes.md b/doc/api/notes.md index bb33efb8c25..30480d56561 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -76,7 +76,7 @@ Parameters: Get an issue note. ``` -GET /projects/:id/issues/:issue_id/:notes/:note_id +GET /projects/:id/issues/:issue_id/notes/:note_id ``` Parameters: @@ -90,7 +90,7 @@ Parameters: Get a snippet note. ``` -GET /projects/:id/issues/:snippet_id/:notes/:note_id +GET /projects/:id/issues/:snippet_id/notes/:note_id ``` Parameters: @@ -114,7 +114,7 @@ Parameters: + `id` (required) - The ID of a project + `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 @@ -131,7 +131,7 @@ Parameters: + `issue_id` (required) - The ID of an issue + `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 @@ -147,4 +147,4 @@ Parameters: + `snippet_id` (required) - The ID of an snippet + `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. |