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.
This commit is contained in:
Sebastian Ziebell 2013-03-07 00:15:57 +01:00
parent b5ef6d2268
commit 39114d259c
11 changed files with 36 additions and 475 deletions

View file

@ -39,12 +39,6 @@ Parameters:
]
```
Return values:
+ `200 Ok`on success and a list of repository branches for the project
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if project with ID not found
## Get single repository branch
@ -86,13 +80,6 @@ Parameters:
}
```
Return values:
+ `200 Ok` on success and the repository branch
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if the project ID or branch not found
## Protect repository branch
@ -135,13 +122,6 @@ Parameters:
}
```
Return values:
+ `200 Ok` on success and the updated repository branch
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if the the project ID or branch not found
## Unprotect repository branch
@ -184,13 +164,6 @@ Parameters:
}
```
Return values:
+ `200 Ok` on success and the updated repository branch
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if the project ID or the branch not found
## List project repository tags
@ -231,12 +204,6 @@ Parameters:
]
```
Return values:
+ `200 Ok` on success and the list of repository tags
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if the project ID not found
## List repository commits
@ -274,12 +241,6 @@ Parameters:
]
```
Return values:
+ `200 Ok` on success and a list of commits
+ `401 Unauthorized` if the user is not authenticated
+ `404 Not Found` if the project ID not found
## Raw blob content
@ -294,11 +255,3 @@ Parameters:
+ `id` (required) - The ID of a project
+ `sha` (required) - The commit or branch name
+ `filepath` (required) - The path the file
Return values:
+ `200 Ok` on success and the raw content of the file
+ `400 Bad Request` if required attribute filepath is not given
+ `401 Unauthorized` if user is not authenticated
+ `404 Not Found` if project ID or sha commit or branch name not found