From 0b3a0fb3edcea22bda2e36e8e763ec60379a5fa2 Mon Sep 17 00:00:00 2001 From: Jeremie Panzer Date: Thu, 2 May 2019 13:42:49 +0200 Subject: [PATCH] add missing required --- .../com/commafeed/frontend/resource/FeedREST.java | 11 +++++++---- .../com/commafeed/frontend/resource/ServerREST.java | 3 ++- .../com/commafeed/frontend/resource/UserREST.java | 10 ++++++---- 3 files changed, 15 insertions(+), 9 deletions(-) diff --git a/src/main/java/com/commafeed/frontend/resource/FeedREST.java b/src/main/java/com/commafeed/frontend/resource/FeedREST.java index 8efd8e42..c6701d1c 100644 --- a/src/main/java/com/commafeed/frontend/resource/FeedREST.java +++ b/src/main/java/com/commafeed/frontend/resource/FeedREST.java @@ -292,7 +292,8 @@ public class FeedREST { @UnitOfWork @ApiOperation(value = "Queue a feed for refresh", notes = "Manually add a feed to the refresh queue") @Timed - public Response queueForRefresh(@ApiParam(hidden = true) @SecurityCheck User user, @ApiParam(value = "Feed id") IDRequest req) { + public Response queueForRefresh(@ApiParam(hidden = true) @SecurityCheck User user, + @ApiParam(value = "Feed id", required = true) IDRequest req) { Preconditions.checkNotNull(req); Preconditions.checkNotNull(req.getId()); @@ -311,7 +312,8 @@ public class FeedREST { @UnitOfWork @ApiOperation(value = "Mark feed entries", notes = "Mark feed entries as read (unread is not supported)") @Timed - public Response markFeedEntries(@ApiParam(hidden = true) @SecurityCheck User user, @ApiParam(value = "Mark request") MarkRequest req) { + public Response markFeedEntries(@ApiParam(hidden = true) @SecurityCheck User user, + @ApiParam(value = "Mark request", required = true) MarkRequest req) { Preconditions.checkNotNull(req); Preconditions.checkNotNull(req.getId()); @@ -349,7 +351,7 @@ public class FeedREST { @ApiOperation(value = "Fetch a feed's icon", notes = "Fetch a feed's icon") @Timed public Response getFavicon(@ApiParam(hidden = true) @SecurityCheck User user, - @ApiParam(value = "subscription id") @PathParam("id") Long id) { + @ApiParam(value = "subscription id", required = true) @PathParam("id") Long id) { Preconditions.checkNotNull(id); FeedSubscription subscription = feedSubscriptionDAO.findById(user, id); @@ -514,7 +516,8 @@ public class FeedREST { @Consumes(MediaType.MULTIPART_FORM_DATA) @ApiOperation(value = "OPML import", notes = "Import an OPML file, posted as a FORM with the 'file' name") @Timed - public Response importOpml(@ApiParam(hidden = true) @SecurityCheck User user, @FormDataParam("file") InputStream input) { + public Response importOpml(@ApiParam(hidden = true) @SecurityCheck User user, + @ApiParam(value = "ompl file", required = true) @FormDataParam("file") InputStream input) { String publicUrl = config.getApplicationSettings().getPublicUrl(); if (StringUtils.isBlank(publicUrl)) { diff --git a/src/main/java/com/commafeed/frontend/resource/ServerREST.java b/src/main/java/com/commafeed/frontend/resource/ServerREST.java index 4fdefdd3..a4551f02 100644 --- a/src/main/java/com/commafeed/frontend/resource/ServerREST.java +++ b/src/main/java/com/commafeed/frontend/resource/ServerREST.java @@ -61,7 +61,8 @@ public class ServerREST { @ApiOperation(value = "proxy image") @Produces("image/png") @Timed - public Response get(@ApiParam(hidden = true) @SecurityCheck User user, @QueryParam("u") String url) { + public Response get(@ApiParam(hidden = true) @SecurityCheck User user, + @ApiParam(value = "image url", required = true) @QueryParam("u") String url) { if (!config.getApplicationSettings().getImageProxyEnabled()) { return Response.status(Status.FORBIDDEN).build(); } diff --git a/src/main/java/com/commafeed/frontend/resource/UserREST.java b/src/main/java/com/commafeed/frontend/resource/UserREST.java index 0499b3e4..fea40915 100644 --- a/src/main/java/com/commafeed/frontend/resource/UserREST.java +++ b/src/main/java/com/commafeed/frontend/resource/UserREST.java @@ -226,7 +226,8 @@ public class UserREST { @UnitOfWork @ApiOperation(value = "Register a new account") @Timed - public Response register(@Valid @ApiParam(required = true) RegistrationRequest req, @Context SessionHelper sessionHelper) { + public Response register(@Valid @ApiParam(required = true) RegistrationRequest req, + @Context @ApiParam(hidden = true) SessionHelper sessionHelper) { try { User registeredUser = userService.register(req.getName(), req.getPassword(), req.getEmail(), Arrays.asList(Role.USER)); userService.login(req.getName(), req.getPassword()); @@ -243,7 +244,7 @@ public class UserREST { @UnitOfWork @ApiOperation(value = "Login and create a session") @Timed - public Response login(@ApiParam(required = true) LoginRequest req, @Context SessionHelper sessionHelper) { + public Response login(@ApiParam(required = true) LoginRequest req, @ApiParam(hidden = true) @Context SessionHelper sessionHelper) { Optional user = userService.login(req.getName(), req.getPassword()); if (user.isPresent()) { sessionHelper.setLoggedInUser(user.get()); @@ -258,7 +259,7 @@ public class UserREST { @UnitOfWork @ApiOperation(value = "send a password reset email") @Timed - public Response sendPasswordReset(@Valid PasswordResetRequest req) { + public Response sendPasswordReset(@Valid @ApiParam(required = true) PasswordResetRequest req) { User user = userDAO.findByEmail(req.getEmail()); if (user == null) { return Response.status(Status.PRECONDITION_FAILED).entity("Email not found.").type(MediaType.TEXT_PLAIN).build(); @@ -294,7 +295,8 @@ public class UserREST { @UnitOfWork @Produces(MediaType.TEXT_HTML) @Timed - public Response passwordRecoveryCallback(@QueryParam("email") String email, @QueryParam("token") String token) { + public Response passwordRecoveryCallback(@ApiParam(required = true) @QueryParam("email") String email, + @ApiParam(required = true) @QueryParam("token") String token) { Preconditions.checkNotNull(email); Preconditions.checkNotNull(token);