Add swagger annotations to ApplicationRelease bean

merge-requests/4/head
lasanthaDLPDS 6 years ago
parent f9ec82e4dc
commit 34fe427852

@ -18,107 +18,91 @@
*/ */
package org.wso2.carbon.device.application.mgt.common; package org.wso2.carbon.device.application.mgt.common;
import org.wso2.carbon.device.application.mgt.common.jaxrs.Exclude; import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.sql.Timestamp; @ApiModel(value = "ApplicationRelease", description = "This class holds the details when releasing an Application to application store")
/**
* This class holds the details when releasing an Application to application store.
*/
public class ApplicationRelease { public class ApplicationRelease {
@Exclude @ApiModelProperty(name = "id",
value = "ID of the application release")
private int id; private int id;
/** @ApiModelProperty(name = "version",
* Version of the application release value = "Version of the application release")
*/
private String version; private String version;
/** @ApiModelProperty(name = "uuid",
* UUID of the application release value = "UUID of the application release")
*/
private String uuid; private String uuid;
/** @ApiModelProperty(name = "appStoredLoc",
* Application storing location value = "Application storing location")
*/
private String appStoredLoc; private String appStoredLoc;
/** @ApiModelProperty(name = "bannerLoc",
* Banner file storing location value = "Banner file storing location")
*/
private String bannerLoc; private String bannerLoc;
/** @ApiModelProperty(name = "screenshotLoc1",
* Screenshot storing location value = "Screenshot storing location")
*/
private String screenshotLoc1; private String screenshotLoc1;
/** @ApiModelProperty(name = "screenshotLoc2",
* Screenshot storing location value = "Screenshot storing location")
*/
private String screenshotLoc2; private String screenshotLoc2;
/** @ApiModelProperty(name = "screenshotLoc3",
* Screenshot storing location value = "Screenshot storing location")
*/
private String screenshotLoc3; private String screenshotLoc3;
/** @ApiModelProperty(name = "iconLoc",
* Application release creator value = "icon file storing location")
*/ private String iconLoc;
@ApiModelProperty(name = "applicationCreator",
value = "Application release creator")
private String applicationCreator; private String applicationCreator;
/** @ApiModelProperty(name = "releaseType",
* Release type of the application release value = "Release type of the application release",
* e.g: alpha, beta etc required = true,
*/ example = "alpha, beta etc")
private String releaseType; private String releaseType;
/** @ApiModelProperty(name = "price",
* Price of the application release value = "Price of the application release",
*/ required = true)
private Double price; private Double price;
/** @ApiModelProperty(name = "appHashValue",
* icon file storing location value = "Hash value of the application release")
*/
private String iconLoc;
/**
* Hash value of the application release
*/
private String appHashValue; private String appHashValue;
/** @ApiModelProperty(name = "isSharedWithAllTenants",
* If application release is shared with all tenants it is eqal to 1 otherwise 0 value = "If application release is shared with all tenants it is eqal to 1 otherwise 0",
*/ required = true)
private int isSharedWithAllTenants; private int isSharedWithAllTenants;
/** @ApiModelProperty(name = "metaData",
* MEta data of the application release value = "Meta data of the application release",
*/ required = true)
private String metaData; private String metaData;
/** @ApiModelProperty(name = "ratedUsers",
* Number of users who has rated the application release value = "Number of users who has rated the application release")
*/
private int ratedUsers; private int ratedUsers;
/** @ApiModelProperty(name = "rating",
* Rating value of the application release value = "Rating value of the application release")
*/
private Double rating; private Double rating;
/** @ApiModelProperty(name = "url",
* URL which is used for WEB-CLIP value = "URL which is used for WEB-CLIP")
*/
private String url; private String url;
/** @ApiModelProperty(name = "lifecycleState",
* Latest Lifecycle state of the application release value = "Latest Lifecycle state of the application release")
*/
private LifecycleState lifecycleState; private LifecycleState lifecycleState;
public int getRatedUsers() { public int getRatedUsers() {

Loading…
Cancel
Save