summaryrefslogtreecommitdiff
path: root/doc/api/README.md
diff options
context:
space:
mode:
authorSebastian Ziebell <sebastian.ziebell@asquera.de>2013-03-07 14:51:56 +0100
committerSebastian Ziebell <sebastian.ziebell@asquera.de>2013-03-07 14:51:56 +0100
commit3374027e3a4e4eb040e59294a9ced9d7886a71e2 (patch)
tree4587984396a32047a6337e7810a39633ba683545 /doc/api/README.md
parent39114d259c6e4bd5bb60b18f561d06cc24e8c852 (diff)
parent9c2a6e201388e7e30987a8679ddfa65b9422a38c (diff)
downloadgitlab-ce-3374027e3a4e4eb040e59294a9ced9d7886a71e2.tar.gz
Merge branch 'master' into fixes/api, code clean up and tests fixed
Conflicts: doc/api/projects.md spec/requests/api/projects_spec.rb
Diffstat (limited to 'doc/api/README.md')
-rw-r--r--doc/api/README.md13
1 files changed, 5 insertions, 8 deletions
diff --git a/doc/api/README.md b/doc/api/README.md
index 2699434d00b..f6c4e41b6cd 100644
--- a/doc/api/README.md
+++ b/doc/api/README.md
@@ -31,13 +31,10 @@ The API uses JSON to serialize data. You don't need to specify `.json` at the en
## Status codes
-API requests return different status codes according to
-
-The API is designed to provide status codes according to the context and how the request
-is handled. For example if a `GET` request is successful a status code `200 Ok`
-is returned. The API is designed to be RESTful.
-
-The following list gives an overview of how the API functions are designed.
+The API is designed to return different status codes according to context and action. In this way
+if a request results in an error the caller is able to get insight into what went wrong, e.g.
+status code `400 Bad Request` is returned if a required attribute is missing from the request.
+The following list gives an overview of how the API functions generally behave.
API request types:
@@ -58,7 +55,7 @@ Return values:
* `403 Forbidden` - The request is not allowed, e.g. the user is not allowed to delete a project
* `404 Not Found` - A resource could not be accessed, e.g. an ID for a resource could not be found
* `405 Method Not Allowed` - The request is not supported
-* `409 Conflict` - A conflicting resource already exists, a project with same name already exists
+* `409 Conflict` - A conflicting resource already exists, e.g. creating a project with a name that already exists
* `500 Server Error` - While handling the request something went wrong on the server side