Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2025-11-11 16:05:44 +01:00
Code Issues Packages Projects Releases Activity

improve javadoc of ChangePasswordResource for the webservice documentation

Browse Source
This commit is contained in:
Sebastian Sdorra
2011-10-03 13:39:39 +02:00
parent 260f8680f0
commit 36e7fc41c7
1 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
scm-webapp/src/main/java/sonia/scm/api/rest/resources/ChangePasswordResource.java
View File

@@ -38,6 +38,7 @@ package sonia.scm.api.rest.resources;
import com.google.inject.Inject; import com.google.inject.Inject;
import com.google.inject.Provider; import com.google.inject.Provider;
import org.codehaus.enunciate.jaxrs.TypeHint;
import org.codehaus.enunciate.modules.jersey.SpringManagedLifecycle; import org.codehaus.enunciate.modules.jersey.SpringManagedLifecycle;
import org.slf4j.Logger; import org.slf4j.Logger;
@@ -100,11 +101,17 @@ public class ChangePasswordResource
//~--- methods -------------------------------------------------------------- //~--- methods --------------------------------------------------------------
/** /**
* Method description * Changes the password of the current user.<br />
* <br />
* Status codes:
* <ul>
* <li>200 success</li>
* <li>400 bad request, the old password is not correct</li>
* <li>500 internal server error</li>
* </ul>
* *
* * @param oldPassword old password of the current user
* @param oldPassword * @param newPassword new password for the current user
* @param newPassword
* *
* @return * @return
* *
@@ -112,6 +119,7 @@ public class ChangePasswordResource
* @throws UserException * @throws UserException
*/ */
@POST @POST
@TypeHint(RestActionResult.class)
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON }) @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
public Response changePassword(@FormParam("old-password") String oldPassword, public Response changePassword(@FormParam("old-password") String oldPassword,
@FormParam("new-password") String newPassword) @FormParam("new-password") String newPassword)