Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Ziebell <sebastian.ziebell@asquera.de>2013-03-07 03:15:57 +0400
committerSebastian Ziebell <sebastian.ziebell@asquera.de>2013-03-07 03:15:57 +0400
commit39114d259c6e4bd5bb60b18f561d06cc24e8c852 (patch)
tree24bd635f0ab1b763cfb537b0d203945d1565d295 /doc/api/snippets.md
parentb5ef6d226864d3ea132d2c6e97b74b51f2b64a6f (diff)
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/snippets.md')
-rw-r--r--doc/api/snippets.md36
1 files changed, 0 insertions, 36 deletions
diff --git a/doc/api/snippets.md b/doc/api/snippets.md
index 61dbb5e454b..4becc928b1f 100644
--- a/doc/api/snippets.md
+++ b/doc/api/snippets.md
@@ -10,11 +10,6 @@ Parameters:
+ `id` (required) - The ID of a project
-Return values:
-
-+ `200 Ok` on success and a list of project snippets
-+ `401 Unauthorized` if user is not authenticated
-
## Single snippet
@@ -48,12 +43,6 @@ Parameters:
}
```
-Return values:
-
-+ `200 Ok` on success and the project snippet
-+ `401 Unauthorized` if user is not authenticated
-+ `404 Not Found` if snippet ID not found
-
## Create new snippet
@@ -71,13 +60,6 @@ Parameters:
+ `lifetime` (optional) - The expiration date of a snippet
+ `code` (required) - The content of a snippet
-Return values:
-
-+ `201 Created` if snippet was successfully created and the snippet as JSON payload
-+ `400 Bad Request` if one of the required attributes is not given
-+ `401 Unauthorized` if user is not authenticated
-+ `404 Not Found` if project ID not found
-
## Edit snippet
@@ -96,12 +78,6 @@ Parameters:
+ `lifetime` (optional) - The expiration date of a snippet
+ `code` (optional) - The content of a snippet
-Return values:
-
-+ `200 Ok` on success and the updated project snippet
-+ `401 Unauthorized` if user is not authenticated
-+ `404 Not Found` if project ID not found
-
## Delete snippet
@@ -117,12 +93,6 @@ Parameters:
+ `id` (required) - The ID of a project
+ `snippet_id` (required) - The ID of a project's snippet
-Return values:
-
-+ `200 Ok` on success and if the snippet was deleted its content
-+ `401 Unauthorized` if user is not authenticated
-+ `404 Not Found` if project ID not found
-
## Snippet content
@@ -136,9 +106,3 @@ Parameters:
+ `id` (required) - The ID of a project
+ `snippet_id` (required) - The ID of a project's snippet
-
-Return values:
-
-+ `200 Ok` on success and the raw snippet
-+ `401 Unauthorized` if user is not authenticated
-+ `404 Not Found` if project ID or snippet ID is not found \ No newline at end of file