diff options
author | Sebastian Ziebell <sebastian.ziebell@asquera.de> | 2013-03-07 00:15:57 +0100 |
---|---|---|
committer | Sebastian Ziebell <sebastian.ziebell@asquera.de> | 2013-03-07 00:15:57 +0100 |
commit | 39114d259c6e4bd5bb60b18f561d06cc24e8c852 (patch) | |
tree | 24bd635f0ab1b763cfb537b0d203945d1565d295 /doc/api/issues.md | |
parent | b5ef6d226864d3ea132d2c6e97b74b51f2b64a6f (diff) | |
download | gitlab-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/issues.md')
-rw-r--r-- | doc/api/issues.md | 35 |
1 files changed, 0 insertions, 35 deletions
diff --git a/doc/api/issues.md b/doc/api/issues.md index 025c6e50bb3..a8ae7401b39 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -69,13 +69,6 @@ GET /issues ] ``` -Return values: - -+ `200 Ok` on success and the list of issues -+ `401 Unauthorized` if user is not authenticated -+ `404 Not Found` if something fails - - ## List project issues @@ -90,12 +83,6 @@ Parameters: + `id` (required) - The ID of a project -Return values: - -+ `200 Ok` on success and the list of project issues -+ `401 Unauthorized` if user is not authenticated -+ `404 Not Found` if project ID not found - ## Single issue @@ -150,12 +137,6 @@ Parameters: } ``` -Return values: - -+ `200 Ok` on success and the list of project issues -+ `401 Unauthorized` if user is not authenticated -+ `404 Not Found` if project ID or issue ID not found - ## New issue @@ -174,13 +155,6 @@ Parameters: + `milestone_id` (optional) - The ID of a milestone to assign issue + `labels` (optional) - Comma-separated label names for an issue -Return values: - -+ `201 Created` on success and the newly created project issue -+ `400 Bad Request` if the required attribute title is not given -+ `401 Unauthorized` if user is not authenticated -+ `404 Not Found` if project ID not found - ## Edit issue @@ -201,12 +175,6 @@ Parameters: + `labels` (optional) - Comma-separated label names for an issue + `closed` (optional) - The state of an issue (0 = false, 1 = true) -Return values: - -+ `200 Ok` on success and the update project issue -+ `401 Unauthorized` if user is not authenticated -+ `404 Not Found` if project ID or issue ID not found - ## Delete existing issue (**Deprecated**) @@ -223,6 +191,3 @@ Parameters: + `id` (required) - The project ID + `issue_id` (required) - The ID of the issue -Return values: - -+ `405 Method Not Allowed` is always returned, because the function is deprecated |