diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/AbstractManagerResource.java b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/AbstractManagerResource.java index 47bb7ed551..7c82bddc87 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/AbstractManagerResource.java +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/AbstractManagerResource.java @@ -124,14 +124,14 @@ public abstract class AbstractManagerResource //~--- methods -------------------------------------------------------------- /** - * Method description + * Creates a new user.
+ * This method requires admin privileges.
+ *
+ * Status codes: + * * - * - * - * @param uriInfo - * @param user + * @param uriInfo current uri informations + * @param user the user to be created * * @return */ @@ -130,10 +135,17 @@ public class UserResource extends AbstractManagerResource } /** - * Method description + * Deletes a user.
+ * This method requires admin privileges.
+ *
+ * Status codes: + * * - * - * @param name + * @param name the name of the user to delete. * * @return */ @@ -146,12 +158,19 @@ public class UserResource extends AbstractManagerResource } /** - * Method description + * Modifies the given user.
+ * This method requires admin privileges.
+ *
+ * Status codes: + *
    + *
  • 201 update successful
  • + *
  • 403 forbidden, the current user has no admin privileges
  • + *
  • 500 internal server error
  • + *
* - * - * @param uriInfo - * @param name - * @param user + * @param uriInfo current uri informations + * @param name name of the user to be modified + * @param user user object to modify * * @return */ @@ -168,13 +187,21 @@ public class UserResource extends AbstractManagerResource //~--- get methods ---------------------------------------------------------- /** - * Method description + * Returns a user.
+ * This method requires admin privileges.
+ *
+ * Status codes: + *
    + *
  • 200 get successful
  • + *
  • 403 forbidden, the current user has no admin privileges
  • + *
  • 404 not found, no user with the specified id/name available
  • + *
  • 500 internal server error
  • + *
* + * @param request the current request + * @param id the id/name of the user * - * @param request - * @param id - * - * @return + * @return the {@link User} with the specified id */ @GET @Path("{id}") @@ -198,14 +225,21 @@ public class UserResource extends AbstractManagerResource } /** - * Method description - * - * - * @param request - * @param start - * @param limit - * @param sortby - * @param desc + * Returns all users.
+ * This method requires admin privileges.
+ *
+ * Status codes: + *
    + *
  • 200 get successful
  • + *
  • 403 forbidden, the current user has no admin privileges
  • + *
  • 500 internal server error
  • + *
+ * + * @param request the current request + * @param start the start value for paging + * @param limit the limit value for paging + * @param sortby sort parameter + * @param desc sort direction desc or aesc * * @return */