summaryrefslogtreecommitdiff
path: root/doc/api/notes.md
diff options
context:
space:
mode:
authorSebastian Ziebell <sebastian.ziebell@asquera.de>2013-03-07 00:15:57 +0100
committerSebastian Ziebell <sebastian.ziebell@asquera.de>2013-03-07 00:15:57 +0100
commit39114d259c6e4bd5bb60b18f561d06cc24e8c852 (patch)
tree24bd635f0ab1b763cfb537b0d203945d1565d295 /doc/api/notes.md
parentb5ef6d226864d3ea132d2c6e97b74b51f2b64a6f (diff)
downloadgitlab-ce-39114d259c6e4bd5bb60b18f561d06cc24e8c852.tar.gz
API: documentation contains infos to status codes in README file.
All the info to return codes from the API functions are available in the `README.md` file as suggested.
Diffstat (limited to 'doc/api/notes.md')
-rw-r--r--doc/api/notes.md78
1 files changed, 0 insertions, 78 deletions
diff --git a/doc/api/notes.md b/doc/api/notes.md
index 6a6a99aa4f4..4b57f636a01 100644
--- a/doc/api/notes.md
+++ b/doc/api/notes.md
@@ -30,11 +30,6 @@ Parameters:
+ `id` (required) - The ID of a project
-Return values:
-
-+ `200 Ok` on success and a list of notes
-+ `401 Unauthorized` if user is not authorized to access this page
-
### Get single wall note
@@ -49,12 +44,6 @@ Parameters:
+ `id` (required) - The ID of a project
+ `note_id` (required) - The ID of a wall note
-Return values:
-
-+ `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
@@ -69,14 +58,6 @@ 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
@@ -93,12 +74,6 @@ Parameters:
+ `id` (required) - The ID of a project
+ `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
-
### Get single issue note
@@ -114,12 +89,6 @@ Parameters:
+ `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
-
### Create new issue note
@@ -135,14 +104,6 @@ Parameters:
+ `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
-
-
## Snippets
@@ -159,12 +120,6 @@ 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
-
### Get single snippet note
@@ -180,12 +135,6 @@ Parameters:
+ `snippet_id` (required) - The ID of a project snippet
+ `note_id` (required) - The ID of an snippet note
-Return values:
-
-+ `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
-
### Create new snippet note
@@ -201,14 +150,6 @@ Parameters:
+ `snippet_id` (required) - The ID of an snippet
+ `body` (required) - The content of a note
-Return values:
-
-+ `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
-
-
## Merge Requests
@@ -225,12 +166,6 @@ Parameters:
+ `id` (required) - The ID of a project
+ `merge_request_id` (required) - The ID of a project merge request
-Return values:
-
-+ `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
-
### Get single merge request note
@@ -246,12 +181,6 @@ Parameters:
+ `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
@@ -267,10 +196,3 @@ Parameters:
+ `merge_request_id` (required) - The ID of a merge request
+ `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
-