JAMES-2349 Fix user quota endpoints documentation
Project: http://git-wip-us.apache.org/repos/asf/james-project/repo Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/a25b4d09 Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/a25b4d09 Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/a25b4d09 Branch: refs/heads/master Commit: a25b4d091b76a7592a827a00f416ed41fef9db68 Parents: 9ceb7a0 Author: Antoine Duprat <[email protected]> Authored: Wed Mar 14 10:18:16 2018 +0100 Committer: benwa <[email protected]> Committed: Thu Mar 15 16:02:02 2018 +0700 ---------------------------------------------------------------------- .../james/webadmin/routes/UserQuotaRoutes.java | 24 +++++++++++--------- 1 file changed, 13 insertions(+), 11 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/james-project/blob/a25b4d09/server/protocols/webadmin/webadmin-mailbox/src/main/java/org/apache/james/webadmin/routes/UserQuotaRoutes.java ---------------------------------------------------------------------- diff --git a/server/protocols/webadmin/webadmin-mailbox/src/main/java/org/apache/james/webadmin/routes/UserQuotaRoutes.java b/server/protocols/webadmin/webadmin-mailbox/src/main/java/org/apache/james/webadmin/routes/UserQuotaRoutes.java index cd0882f..81d6803 100644 --- a/server/protocols/webadmin/webadmin-mailbox/src/main/java/org/apache/james/webadmin/routes/UserQuotaRoutes.java +++ b/server/protocols/webadmin/webadmin-mailbox/src/main/java/org/apache/james/webadmin/routes/UserQuotaRoutes.java @@ -40,6 +40,7 @@ import org.apache.james.user.api.UsersRepository; import org.apache.james.user.api.UsersRepositoryException; import org.apache.james.webadmin.Routes; import org.apache.james.webadmin.dto.QuotaDTO; +import org.apache.james.webadmin.dto.QuotaDetailsDTO; import org.apache.james.webadmin.service.UserQuotaService; import org.apache.james.webadmin.utils.ErrorResponder; import org.apache.james.webadmin.utils.ErrorResponder.ErrorType; @@ -107,7 +108,7 @@ public class UserQuotaRoutes implements Routes { @ApiResponses(value = { @ApiResponse(code = HttpStatus.NO_CONTENT_204, message = "OK. The value has been updated."), @ApiResponse(code = HttpStatus.BAD_REQUEST_400, message = "The body is not a positive integer or not unlimited value (-1)."), - @ApiResponse(code = HttpStatus.NOT_FOUND_404, message = "The user does not exist."), + @ApiResponse(code = HttpStatus.NOT_FOUND_404, message = "The user name does not exist."), @ApiResponse(code = HttpStatus.CONFLICT_409, message = "The requested restriction can't be enforced right now."), @ApiResponse(code = HttpStatus.INTERNAL_SERVER_ERROR_500, message = "Internal server error - Something went bad on the server side.") }) @@ -127,8 +128,8 @@ public class UserQuotaRoutes implements Routes { notes = "If there is no limitation for count and/or size, the returned value will be -1" ) @ApiResponses(value = { - @ApiResponse(code = HttpStatus.OK_200, message = "OK", response = QuotaDTO.class), - @ApiResponse(code = HttpStatus.NOT_FOUND_404, message = "The user does not exist."), + @ApiResponse(code = HttpStatus.OK_200, message = "OK", response = QuotaDetailsDTO.class), + @ApiResponse(code = HttpStatus.NOT_FOUND_404, message = "The user name does not exist."), @ApiResponse(code = HttpStatus.INTERNAL_SERVER_ERROR_500, message = "Internal server error - Something went bad on the server side.") }) public void defineGetQuota() { @@ -143,7 +144,7 @@ public class UserQuotaRoutes implements Routes { @ApiOperation(value = "Removing per user mail size limitation by updating to unlimited value") @ApiResponses(value = { @ApiResponse(code = HttpStatus.NO_CONTENT_204, message = "The value is updated to unlimited value."), - @ApiResponse(code = HttpStatus.NOT_FOUND_404, message = "The user does not exist."), + @ApiResponse(code = HttpStatus.NOT_FOUND_404, message = "The user name does not exist."), @ApiResponse(code = HttpStatus.INTERNAL_SERVER_ERROR_500, message = "Internal server error - Something went bad on the server side.") }) public void defineDeleteQuotaSize() { @@ -163,8 +164,8 @@ public class UserQuotaRoutes implements Routes { }) @ApiResponses(value = { @ApiResponse(code = HttpStatus.NO_CONTENT_204, message = "OK. The value has been updated."), - @ApiResponse(code = HttpStatus.BAD_REQUEST_400, message = "The body is not a positive integer."), - @ApiResponse(code = HttpStatus.NOT_FOUND_404, message = "The user does not exist."), + @ApiResponse(code = HttpStatus.BAD_REQUEST_400, message = "The body is not a positive integer nor -1."), + @ApiResponse(code = HttpStatus.NOT_FOUND_404, message = "The user name does not exist."), @ApiResponse(code = HttpStatus.CONFLICT_409, message = "The requested restriction can't be enforced right now."), @ApiResponse(code = HttpStatus.INTERNAL_SERVER_ERROR_500, message = "Internal server error - Something went bad on the server side.") }) @@ -184,7 +185,7 @@ public class UserQuotaRoutes implements Routes { @ApiResponses(value = { @ApiResponse(code = HttpStatus.OK_200, message = "OK", response = Long.class), @ApiResponse(code = HttpStatus.NO_CONTENT_204, message = "No value defined"), - @ApiResponse(code = HttpStatus.NOT_FOUND_404, message = "The user does not exist."), + @ApiResponse(code = HttpStatus.NOT_FOUND_404, message = "The user name does not exist."), @ApiResponse(code = HttpStatus.INTERNAL_SERVER_ERROR_500, message = "Internal server error - Something went bad on the server side.") }) public void defineGetQuotaSize() { @@ -204,7 +205,7 @@ public class UserQuotaRoutes implements Routes { @ApiOperation(value = "Removing per user mail count limitation by updating to unlimited value") @ApiResponses(value = { @ApiResponse(code = HttpStatus.NO_CONTENT_204, message = "The value is updated to unlimited value."), - @ApiResponse(code = HttpStatus.NOT_FOUND_404, message = "The user does not exist."), + @ApiResponse(code = HttpStatus.NOT_FOUND_404, message = "The user name does not exist."), @ApiResponse(code = HttpStatus.INTERNAL_SERVER_ERROR_500, message = "Internal server error - Something went bad on the server side.") }) public void defineDeleteQuotaCount() { @@ -224,8 +225,8 @@ public class UserQuotaRoutes implements Routes { }) @ApiResponses(value = { @ApiResponse(code = HttpStatus.NO_CONTENT_204, message = "OK. The value has been updated."), - @ApiResponse(code = HttpStatus.BAD_REQUEST_400, message = "The body is not a positive integer."), - @ApiResponse(code = HttpStatus.NOT_FOUND_404, message = "The user does not exist."), + @ApiResponse(code = HttpStatus.BAD_REQUEST_400, message = "The body is not a positive integer nor -1."), + @ApiResponse(code = HttpStatus.NOT_FOUND_404, message = "The user name does not exist."), @ApiResponse(code = HttpStatus.CONFLICT_409, message = "The requested restriction can't be enforced right now."), @ApiResponse(code = HttpStatus.INTERNAL_SERVER_ERROR_500, message = "Internal server error - Something went bad on the server side.") }) @@ -244,7 +245,8 @@ public class UserQuotaRoutes implements Routes { @ApiOperation(value = "Reading per user mail count limitation") @ApiResponses(value = { @ApiResponse(code = HttpStatus.OK_200, message = "OK", response = Long.class), - @ApiResponse(code = HttpStatus.NOT_FOUND_404, message = "The user does not exist."), + @ApiResponse(code = HttpStatus.NO_CONTENT_204, message = "No value defined"), + @ApiResponse(code = HttpStatus.NOT_FOUND_404, message = "The user name does not exist."), @ApiResponse(code = HttpStatus.INTERNAL_SERVER_ERROR_500, message = "Internal server error - Something went bad on the server side.") }) public void defineGetQuotaCount() { --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
