diff --git a/components/application-mgt/org.wso2.carbon.device.application.mgt.api/src/main/java/org/wso2/carbon/device/application/mgt/api/services/CommentManagementAPI.java b/components/application-mgt/org.wso2.carbon.device.application.mgt.api/src/main/java/org/wso2/carbon/device/application/mgt/api/services/CommentManagementAPI.java new file mode 100644 index 00000000000..ac80295ad05 --- /dev/null +++ b/components/application-mgt/org.wso2.carbon.device.application.mgt.api/src/main/java/org/wso2/carbon/device/application/mgt/api/services/CommentManagementAPI.java @@ -0,0 +1,399 @@ +package org.wso2.carbon.device.application.mgt.api.services; + +import io.swagger.annotations.ApiParam; +import io.swagger.annotations.Api; +import io.swagger.annotations.Info; +import io.swagger.annotations.SwaggerDefinition; +import io.swagger.annotations.Extension; +import io.swagger.annotations.ExtensionProperty; +import io.swagger.annotations.Tag; +import io.swagger.annotations.ApiOperation; +import io.swagger.annotations.ApiResponse; +import io.swagger.annotations.ApiResponses; +import org.wso2.carbon.apimgt.annotations.api.Scope; +import org.wso2.carbon.apimgt.annotations.api.Scopes; +import org.wso2.carbon.device.application.mgt.api.beans.ErrorResponse; +import org.wso2.carbon.device.application.mgt.common.Comment; + +import javax.validation.Valid; +import javax.ws.rs.Path; +import javax.ws.rs.Consumes; +import javax.ws.rs.PUT; +import javax.ws.rs.GET; +import javax.ws.rs.PathParam; +import javax.ws.rs.QueryParam; +import javax.ws.rs.Produces; +import javax.ws.rs.POST; +import javax.ws.rs.DELETE; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import java.sql.SQLException; +import java.util.List; + + /** + * APIs to handle comment management related tasks. + */ +@SwaggerDefinition( + info = @Info( + version = "1.0.0", + title = "Store Management Service", + extensions = { + @Extension(properties = { + @ExtensionProperty(name = "name", value = "CommentManagementService"), + @ExtensionProperty(name = "context", value = "/api/application-mgt/v1.0/comments"), + }) + } + ), + tags = { + @Tag(name = "store_management", description = "Comment Management related " + + "APIs") + } +) +@Scopes( + scopes = { + @Scope( + name = "Get Comments Details", + description = "Get comments details", + key = "perm:comment:get", + permissions = {"/device-mgt/comment/get"} + ), + @Scope( + name = "Add a Comment", + description = "Add a comment", + key = "perm:comment:add", + permissions = {"/device-mgt/comment/add"} + ), + @Scope( + name = "Update a Comment", + description = "Update a Comment", + key = "perm:comment:update", + permissions = {"/device-mgt/comment/update"} + ), + + @Scope( + name = "Delete a Comment", + description = "Delete a comment", + key = "perm:comment:delete", + permissions = {"/device-mgt/comment/delete"} + ), + } +) + +@Path("/comments") +@Api(value = "Comments Management", description = "This API carries all comments management related operations " + + "such as get all the comments, add comment, etc.") +@Produces(MediaType.APPLICATION_JSON) + +public interface CommentManagementAPI { + String SCOPE = "scope"; + + @GET + @Path("/{uuid}") + @Produces(MediaType.APPLICATION_JSON) + @ApiOperation( + produces = MediaType.APPLICATION_JSON, + httpMethod = "GET", + value = "get comments", + notes = "Get all comments", + tags = "Store Management", + extensions = { + @Extension(properties = { + @ExtensionProperty(name = SCOPE, value = "perm:store:get") + }) + } + ) + + @ApiResponses( + value = { + @ApiResponse( + code = 200, + message = "OK. \n Successfully retrieved comments.", + response = List.class, + responseContainer = "List"), + @ApiResponse( + code = 404, + message = "Not Found. \n No activity found with the given ID.", + response = ErrorResponse.class), + @ApiResponse( + code = 500, + message = "Internal Server Error. \n Error occurred while getting the comment list.", + response = ErrorResponse.class) + }) + + Response getAllComments( + @ApiParam( + name="uuid", + value="uuid of the released version of application.", + required = true) + @PathParam("uuid") + String uuid, + @ApiParam( + name="offSet", + value="Starting comment number.", + required = false) + @QueryParam("offSet") + int offSet, + @ApiParam( + name="limit", + value = "Limit of paginated comments", + required = false) + @QueryParam("limit") + int limit); + + @POST + @Path("/{uuid}") + @Produces(MediaType.APPLICATION_JSON) + @Consumes(MediaType.APPLICATION_JSON) + @ApiOperation( + consumes = MediaType.APPLICATION_JSON, + produces = MediaType.APPLICATION_JSON, + httpMethod = "POST", + value = "Add a comment", + notes = "This will add a new comment", + tags = "Store Management", + extensions = { + @Extension(properties = { + @ExtensionProperty(name = SCOPE, value = "perm:store:add") + }) + } + ) + + @ApiResponses( + value = { + @ApiResponse( + code = 201, + message = "OK. \n Successfully add a comment.", + response = Comment.class), + @ApiResponse( + code = 400, + message = + "Bad Request. \n"), + @ApiResponse( + code = 500, + message = "Internal Server Error. \n Error occurred adding a comment.", + response = ErrorResponse.class) + }) + + Response addComments( + @ApiParam( + name = "comment", + value = "Comment details", + required = true) + Comment comment, + @ApiParam( + name="uuid", + value="uuid of the release version of the application", + required=true) + @PathParam("uuid") + String uuid); + + @PUT + @Path("/{apAppCommentId}") + @Produces(MediaType.APPLICATION_JSON) + @Consumes(MediaType.APPLICATION_JSON) + @ApiOperation( + consumes = MediaType.APPLICATION_JSON, + produces = MediaType.APPLICATION_JSON, + httpMethod = "PUT", + value = "Edit a comment", + notes = "This will edit the comment", + tags = "Store Management", + extensions = { + @Extension(properties = { + @ExtensionProperty(name = SCOPE, value = "perm:store:edit") + }) + } + ) + @ApiResponses( + value = { + @ApiResponse( + code = 201, + message = "OK. \n Successfully updated comment.", + response = Comment.class), + @ApiResponse( + code = 400, + message = "Bad Request. \n Invalid request or validation error."), + @ApiResponse( + code = 404, + message = "Not Found. \n No activity found with the given ID.", + response = ErrorResponse.class), + @ApiResponse( + code = 500, + message = "Internal Server Error. \n Error occurred while updating the new comment.", + response = ErrorResponse.class) + }) + Response updateComment( + @ApiParam( + name = "comment", + value = "The comment that need to be updated.", + required = true) + @Valid Comment comment, + @ApiParam( + name="apAppCommentId", + value = "comment id of the updating comment.", + required = true) + @QueryParam("apAppCommentId") + int apAppCommentId); + + @DELETE + @Path("/{apAppCommentId}") + @Produces(MediaType.APPLICATION_JSON) + @Consumes(MediaType.APPLICATION_JSON) + @ApiOperation( + consumes = MediaType.APPLICATION_JSON, + produces = MediaType.APPLICATION_JSON, + httpMethod = "DELETE", + value = "Remove comment", + notes = "Remove comment", + tags = "Store Management", + extensions = { + @Extension(properties = { + @ExtensionProperty(name = SCOPE, value = "perm:store:remove") + }) + } + ) + + @ApiResponses( + value = { + @ApiResponse( + code = 200, + message = "OK. \n Successfully deleted the comment"), + @ApiResponse( + code = 404, + message = "Not Found. \n No activity found with the given ID.", + response = ErrorResponse.class), + @ApiResponse( + code = 500, + message = "Internal Server Error. \n Error occurred while deleting the comment.", + response = ErrorResponse.class) + }) + + Response deleteComment( + @ApiParam( + name="apAppCommentId", + value="Id of the comment.", + required = true) + @PathParam("apAppCommentId") + int apAppCommentId); + + @GET + @Path("/{uuid}/{stars}") + @Produces(MediaType.APPLICATION_JSON) + @ApiOperation( + produces = MediaType.APPLICATION_JSON, + httpMethod = "GET", + value = "get stars", + notes = "Get all stars", + tags = "Store Management", + extensions = { + @Extension(properties = { + @ExtensionProperty(name = SCOPE, value = "perm:stars:get") + }) + } + ) + + @ApiResponses( + value = { + @ApiResponse( + code = 200, + message = "OK. \n Successfully retrieved stars.", + response = List.class, + responseContainer = "List"), + @ApiResponse( + code = 500, + message = "Internal Server Error. \n Error occurred while getting the stars", + response = ErrorResponse.class) + }) + + Response getStars( + @ApiParam( + name = "uuid", + value = "uuid of the application release", + required = true) + @PathParam("uuid") + String uuid); + + @GET + @Path("/{uuid}/{stars}") + @Produces(MediaType.APPLICATION_JSON) + @ApiOperation( + produces = MediaType.APPLICATION_JSON, + httpMethod = "GET", + value = "get rated users", + notes = "Get all users", + tags = "Store Management", + extensions = { + @Extension(properties = { + @ExtensionProperty(name = SCOPE, value = "perm:user:get") + }) + } + ) + + @ApiResponses( + value = { + @ApiResponse( + code = 200, + message = "OK. \n Successfully retrieved user.", + response = List.class, + responseContainer = "List"), + @ApiResponse( + code = 500, + message = "Internal Server Error. \n Error occurred while getting the comment list.", + response = ErrorResponse.class) + }) + + Response getRatedUser( + @ApiParam( + name = "uuid", + value = "uuid of the application release", + required = true) + @PathParam("uuid") + String uuid); + + @POST + @Path("/uuid/{uuid}") + @Produces(MediaType.APPLICATION_JSON) + @Consumes(MediaType.APPLICATION_JSON) + @ApiOperation( + consumes = MediaType.APPLICATION_JSON, + produces = MediaType.APPLICATION_JSON, + httpMethod = "POST", + value = "Add a star value", + notes = "This will add star value", + tags = "Store Management", + extensions = { + @Extension(properties = { + @ExtensionProperty(name = SCOPE, value = "perm:stars:add") + }) + } + ) + + @ApiResponses( + value = { + @ApiResponse( + code = 201, + message = "OK. \n Successfully rated to the application.", + response = Comment.class), + @ApiResponse( + code = 304, + message = "Not Modified. \n " + + "Empty body because the client already has the latest rating of the requested resource."), + @ApiResponse( + code = 500, + message = "Internal Server Error. \n Error occurred rating for the application.", + response = ErrorResponse.class) + }) + + Response updateStars( + @ApiParam( + name = "stars", + value = "ratings for the application", + required = true) + int stars, + @ApiParam( + name="uuid", + value="uuid of the release version of the application", + required=true) + @PathParam("uuid") + String uuid) throws SQLException; +}