mirror of
https://github.com/scm-manager/scm-manager.git
synced 2025-11-13 00:45:44 +01:00
Add missing documentation
This commit is contained in:
@@ -31,14 +31,25 @@ public class BranchCollectionResource {
|
|||||||
this.branchCollectionToDtoMapper = branchCollectionToDtoMapper;
|
this.branchCollectionToDtoMapper = branchCollectionToDtoMapper;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the branches for a repository.
|
||||||
|
*
|
||||||
|
* <strong>Note:</strong> This method requires "repository" privilege.
|
||||||
|
*
|
||||||
|
* @param namespace the namespace of the repository
|
||||||
|
* @param name the name of the repository
|
||||||
|
*
|
||||||
|
*/
|
||||||
@GET
|
@GET
|
||||||
@Path("")
|
@Path("")
|
||||||
@Produces(VndMediaType.BRANCH_COLLECTION)
|
@Produces(VndMediaType.BRANCH_COLLECTION)
|
||||||
@TypeHint(CollectionDto.class)
|
@TypeHint(CollectionDto.class)
|
||||||
@StatusCodes({
|
@StatusCodes({
|
||||||
@ResponseCode(code = 200, condition = "success"),
|
@ResponseCode(code = 200, condition = "success"),
|
||||||
|
@ResponseCode(code = 400, condition = "branches not supported for given repository"),
|
||||||
@ResponseCode(code = 401, condition = "not authenticated / invalid credentials"),
|
@ResponseCode(code = 401, condition = "not authenticated / invalid credentials"),
|
||||||
@ResponseCode(code = 403, condition = "not authorized, the current user does not have the \"group\" privilege"),
|
@ResponseCode(code = 403, condition = "not authorized, the current user does not have the \"group\" privilege"),
|
||||||
|
@ResponseCode(code = 404, condition = "not found, no repository found for the given namespace and name"),
|
||||||
@ResponseCode(code = 500, condition = "internal server error")
|
@ResponseCode(code = 500, condition = "internal server error")
|
||||||
})
|
})
|
||||||
public Response getAll(@PathParam("namespace") String namespace, @PathParam("name") String name) throws IOException, RepositoryException {
|
public Response getAll(@PathParam("namespace") String namespace, @PathParam("name") String name) throws IOException, RepositoryException {
|
||||||
|
|||||||
@@ -31,15 +31,26 @@ public class BranchResource {
|
|||||||
this.branchToDtoMapper = branchToDtoMapper;
|
this.branchToDtoMapper = branchToDtoMapper;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a branch for a repository.
|
||||||
|
*
|
||||||
|
* <strong>Note:</strong> This method requires "repository" privilege.
|
||||||
|
*
|
||||||
|
* @param namespace the namespace of the repository
|
||||||
|
* @param name the name of the repository
|
||||||
|
* @param branchName the name of the branch
|
||||||
|
*
|
||||||
|
*/
|
||||||
@GET
|
@GET
|
||||||
@Path("")
|
@Path("")
|
||||||
@Produces(VndMediaType.BRANCH)
|
@Produces(VndMediaType.BRANCH)
|
||||||
@TypeHint(BranchDto.class)
|
@TypeHint(BranchDto.class)
|
||||||
@StatusCodes({
|
@StatusCodes({
|
||||||
@ResponseCode(code = 200, condition = "success"),
|
@ResponseCode(code = 200, condition = "success"),
|
||||||
|
@ResponseCode(code = 400, condition = "branches not supported for given repository"),
|
||||||
@ResponseCode(code = 401, condition = "not authenticated / invalid credentials"),
|
@ResponseCode(code = 401, condition = "not authenticated / invalid credentials"),
|
||||||
@ResponseCode(code = 403, condition = "not authorized, the current user has no privileges to read the branch"),
|
@ResponseCode(code = 403, condition = "not authorized, the current user has no privileges to read the branch"),
|
||||||
@ResponseCode(code = 404, condition = "not found, no branch with the specified name for the repository available"),
|
@ResponseCode(code = 404, condition = "not found, no branch with the specified name for the repository available or repository not found"),
|
||||||
@ResponseCode(code = 500, condition = "internal server error")
|
@ResponseCode(code = 500, condition = "internal server error")
|
||||||
})
|
})
|
||||||
public Response get(@PathParam("namespace") String namespace, @PathParam("name") String name, @PathParam("branch") String branchName) throws IOException, RepositoryException {
|
public Response get(@PathParam("namespace") String namespace, @PathParam("name") String name, @PathParam("branch") String branchName) throws IOException, RepositoryException {
|
||||||
|
|||||||
Reference in New Issue
Block a user