diff --git a/src/main/java/org/gcube/portal/social/networking/ws/methods/v2/Notifications.java b/src/main/java/org/gcube/portal/social/networking/ws/methods/v2/Notifications.java index 33c4682..3a3176c 100644 --- a/src/main/java/org/gcube/portal/social/networking/ws/methods/v2/Notifications.java +++ b/src/main/java/org/gcube/portal/social/networking/ws/methods/v2/Notifications.java @@ -143,22 +143,28 @@ public class Notifications { return Response.status(status).entity(responseBean).build(); } - + + + /** + * @pathExample /is-user-disabled?username=john.smith + * @responseExample application/json { "success": true, "message": null "result": true } + */ @GET @Path("is-user-disabled/") - @Produces(MediaType.APPLICATION_JSON) /** * Return whether the notifications for this user are enabled or not * @param username the username you want to check * @return true if the notification for the user are disabled (Catalogue and Workspace ones) + * */ + @Produces(MediaType.APPLICATION_JSON) @StatusCodes ({ - @ResponseCode ( code = 200, condition = "Users with silenced notifications are reported in the 'result' field of the returned object"), + @ResponseCode ( code = 200, condition = "true if the notification for the username given as query param are disabled (Catalogue and Workspace ones), false otherwise"), @ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT) }) @AuthorizationControl(allowedRoles={INFRASTRUCTURE_MANAGER_ROLE}, exception=AuthException.class) public Response isUserDisabled( - @QueryParam("username") @NotNull(message="username cannot be null") @Size(min=2, message="username cannot be empty") + @QueryParam("username") @NotNull(message="username cannot be null") String username) throws ValidationException{ ResponseBean responseBean = new ResponseBean(); Status status = Status.OK; @@ -179,7 +185,7 @@ public class Notifications { /** * Set user notification enabled or disabled - * @param disable true if you want to disable the notifications for this user + * @param disable true if you want to disable the notifications for this user, false if you want to enable them * @return the result of the operation * @throws ValidationException */ @@ -193,9 +199,9 @@ public class Notifications { }) @AuthorizationControl(allowedRoles={INFRASTRUCTURE_MANAGER_ROLE}, exception=AuthException.class) public Response setUserNotifications( - @QueryParam("username") @NotNull(message="username cannot be null") @Size(min=2, message="username cannot be empty") + @NotNull(message="username cannot be null") String username, - @QueryParam("disable") @NotNull(message="must specify the disable parameter") + @NotNull(message="must specify the disable parameter") boolean disable) throws ValidationException{ Caller caller = AuthorizationProvider.instance.get();