Added version info to command and response parameters introduced in 4.4. Renamed newly introduced parameter StoragePoolReponse.overProvisionFactor to comply with coding conventions.

kc284 · Alena Prokharchyk · commit 2adb9af898e7 · 2014-03-21T11:45:50.000-07:00
Signed-off-by: Alena Prokharchyk &lt;alena.prokharchyk@citrix.com&gt;
diff --git a/api/src/org/apache/cloudstack/api/command/admin/offering/CreateServiceOfferingCmd.java b/api/src/org/apache/cloudstack/api/command/admin/offering/CreateServiceOfferingCmd.java
@@ -118,19 +118,20 @@ public class CreateServiceOfferingCmd extends BaseCmd {
     @Parameter(name = ApiConstants.IOPS_WRITE_RATE, type = CommandType.LONG, required = false, description = "io requests write rate of the disk offering")
     private Long iopsWriteRate;
 
-    @Parameter(name = ApiConstants.CUSTOMIZED_IOPS, type = CommandType.BOOLEAN, required = false, description = "whether compute offering iops is custom or not")
+    @Parameter(name = ApiConstants.CUSTOMIZED_IOPS, type = CommandType.BOOLEAN, required = false, description = "whether compute offering iops is custom or not", since = "4.4")
     private Boolean customizedIops;
 
-    @Parameter(name = ApiConstants.MIN_IOPS, type = CommandType.LONG, required = false, description = "min iops of the compute offering")
+    @Parameter(name = ApiConstants.MIN_IOPS, type = CommandType.LONG, required = false, description = "min iops of the compute offering", since = "4.4")
     private Long minIops;
 
-    @Parameter(name = ApiConstants.MAX_IOPS, type = CommandType.LONG, required = false, description = "max iops of the compute offering")
+    @Parameter(name = ApiConstants.MAX_IOPS, type = CommandType.LONG, required = false, description = "max iops of the compute offering", since = "4.4")
     private Long maxIops;
 
     @Parameter(name = ApiConstants.HYPERVISOR_SNAPSHOT_RESERVE,
             type = CommandType.INTEGER,
             required = false,
-            description = "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)")
+            description = "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)",
+            since = "4.4")
     private Integer hypervisorSnapshotReserve;
 
     /////////////////////////////////////////////////////
diff --git a/api/src/org/apache/cloudstack/api/command/admin/vpc/CreateVPCOfferingCmd.java b/api/src/org/apache/cloudstack/api/command/admin/vpc/CreateVPCOfferingCmd.java
@@ -66,7 +66,7 @@ public class CreateVPCOfferingCmd extends BaseAsyncCreateCmd {
         + "If not specified, the provider for the service will be mapped to the default provider on the physical network")
     private Map<String, String> serviceProviderList;
 
-    @Parameter(name = ApiConstants.SERVICE_CAPABILITY_LIST, type = CommandType.MAP, description = "desired service capabilities as part of vpc offering")
+    @Parameter(name = ApiConstants.SERVICE_CAPABILITY_LIST, type = CommandType.MAP, description = "desired service capabilities as part of vpc offering", since = "4.4")
     private Map serviceCapabilitystList;
 
     @Parameter(name = ApiConstants.SERVICE_OFFERING_ID,
diff --git a/api/src/org/apache/cloudstack/api/command/user/autoscale/ListAutoScaleVmProfilesCmd.java b/api/src/org/apache/cloudstack/api/command/user/autoscale/ListAutoScaleVmProfilesCmd.java
@@ -51,7 +51,7 @@ public class ListAutoScaleVmProfilesCmd extends BaseListProjectAndAccountResourc
     @Parameter(name = ApiConstants.TEMPLATE_ID, type = CommandType.UUID, entityType = TemplateResponse.class, description = "the templateid of the autoscale vm profile")
     private Long templateId;
 
-    @Parameter(name = ApiConstants.SERVICE_OFFERING_ID, type = CommandType.UUID, entityType = ServiceOfferingResponse.class, description = "list profiles by service offering id")
+    @Parameter(name = ApiConstants.SERVICE_OFFERING_ID, type = CommandType.UUID, entityType = ServiceOfferingResponse.class, description = "list profiles by service offering id", since = "4.4")
     private Long serviceOffId;
 
     @Parameter(name = ApiConstants.OTHER_DEPLOY_PARAMS, type = CommandType.STRING, description = "the otherdeployparameters of the autoscale vm profile")
diff --git a/api/src/org/apache/cloudstack/api/command/user/firewall/UpdatePortForwardingRuleCmd.java b/api/src/org/apache/cloudstack/api/command/user/firewall/UpdatePortForwardingRuleCmd.java
@@ -46,7 +46,7 @@ public class UpdatePortForwardingRuleCmd extends BaseAsyncCustomIdCmd {
     /////////////////////////////////////////////////////
     //////////////// API parameters /////////////////////
     /////////////////////////////////////////////////////
-    @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "the ID of the port forwarding rule")
+    @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "the ID of the port forwarding rule", since = "4.4")
     private Long id;
 
     @Parameter(name = ApiConstants.PRIVATE_IP, type = CommandType.STRING, description = "the private IP address of the port forwarding rule")
diff --git a/api/src/org/apache/cloudstack/api/command/user/loadbalancer/AssignToLoadBalancerRuleCmd.java b/api/src/org/apache/cloudstack/api/command/user/loadbalancer/AssignToLoadBalancerRuleCmd.java
@@ -70,7 +70,10 @@ public class AssignToLoadBalancerRuleCmd extends BaseAsyncCmd {
                description = "the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)")
     private List<Long> virtualMachineIds;
 
-    @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID_IP, type = CommandType.MAP, description = "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75")
+    @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID_IP,
+            type = CommandType.MAP,
+            description = "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75",
+            since = "4.4")
     private Map vmIdIpMap;
 
     /////////////////////////////////////////////////////
diff --git a/api/src/org/apache/cloudstack/api/command/user/vm/DeployVMCmd.java b/api/src/org/apache/cloudstack/api/command/user/vm/DeployVMCmd.java
@@ -121,7 +121,10 @@ public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd {
     @Parameter(name = ApiConstants.SIZE, type = CommandType.LONG, description = "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId")
     private Long size;
 
-    @Parameter(name = ApiConstants.ROOT_DISK_SIZE, type = CommandType.LONG, description = "Optional field to resize root disk on deploy. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided")
+    @Parameter(name = ApiConstants.ROOT_DISK_SIZE,
+            type = CommandType.LONG,
+            description = "Optional field to resize root disk on deploy. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided",
+            since = "4.4")
     private Long rootdisksize;
 
     @Parameter(name = ApiConstants.GROUP, type = CommandType.STRING, description = "an optional group for the virtual machine")
diff --git a/api/src/org/apache/cloudstack/api/command/user/volume/ListVolumesCmd.java b/api/src/org/apache/cloudstack/api/command/user/volume/ListVolumesCmd.java
@@ -76,7 +76,11 @@ public class ListVolumesCmd extends BaseListTaggedResourcesCmd {
                authorized = {RoleType.Admin})
     private Long storageId;
 
-    @Parameter(name = ApiConstants.DISK_OFFERING_ID, type = CommandType.UUID, entityType = DiskOfferingResponse.class, description = "list volumes by disk offering")
+    @Parameter(name = ApiConstants.DISK_OFFERING_ID,
+            type = CommandType.UUID,
+            entityType = DiskOfferingResponse.class,
+            description = "list volumes by disk offering",
+            since = "4.4")
     private Long diskOfferingId;
 
     @Parameter(name = ApiConstants.DISPLAY_VOLUME, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
diff --git a/api/src/org/apache/cloudstack/api/command/user/volume/UpdateVolumeCmd.java b/api/src/org/apache/cloudstack/api/command/user/volume/UpdateVolumeCmd.java
@@ -54,7 +54,10 @@ public class UpdateVolumeCmd extends BaseAsyncCustomIdCmd {
     @Parameter(name = ApiConstants.PATH, type = CommandType.STRING, description = "The path of the volume")
     private String path;
 
-    @Parameter(name = ApiConstants.CHAIN_INFO, type = CommandType.STRING, description = "The chain info of the volume")
+    @Parameter(name = ApiConstants.CHAIN_INFO,
+            type = CommandType.STRING,
+            description = "The chain info of the volume",
+            since = "4.4")
     private String chainInfo;
 
     @Parameter(name = ApiConstants.STORAGE_ID,
diff --git a/api/src/org/apache/cloudstack/api/response/AccountResponse.java b/api/src/org/apache/cloudstack/api/response/AccountResponse.java
@@ -240,7 +240,7 @@ public class AccountResponse extends BaseResponse implements ResourceLimitAndCou
     private Boolean isDefault;
 
     @SerializedName(ApiConstants.IAM_GROUPS)
-    @Param(description = "the list of acl groups that account belongs to")
+    @Param(description = "the list of acl groups that account belongs to", since = "4.4")
     private List<String> groups;
 
     @Override
diff --git a/api/src/org/apache/cloudstack/api/response/DiskOfferingResponse.java b/api/src/org/apache/cloudstack/api/response/DiskOfferingResponse.java
@@ -74,7 +74,7 @@ public class DiskOfferingResponse extends BaseResponse {
     private Long maxIops;
 
     @SerializedName(ApiConstants.HYPERVISOR_SNAPSHOT_RESERVE)
-    @Param(description = "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)")
+    @Param(description = "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", since = "4.4")
     private Integer hypervisorSnapshotReserve;
 
     @SerializedName(ApiConstants.TAGS)
@@ -102,7 +102,7 @@ public class DiskOfferingResponse extends BaseResponse {
     private Long iopsWriteRate;
 
     @SerializedName("cacheMode")
-    @Param(description = "the cache mode to use for this disk offering. none, writeback or writethrough")
+    @Param(description = "the cache mode to use for this disk offering. none, writeback or writethrough", since = "4.4")
     private String cacheMode;
 
     @SerializedName("displayoffering")
diff --git a/api/src/org/apache/cloudstack/api/response/HostResponse.java b/api/src/org/apache/cloudstack/api/response/HostResponse.java
@@ -137,7 +137,7 @@ public class HostResponse extends BaseResponse {
     private Long memoryUsed;
 
     @SerializedName(ApiConstants.GPUGROUP)
-    @Param(description = "GPU cards present in the host", responseObject = GpuResponse.class)
+    @Param(description = "GPU cards present in the host", responseObject = GpuResponse.class, since = "4.4")
     private List<GpuResponse> gpuGroup;
 
     @SerializedName("disksizetotal")
diff --git a/api/src/org/apache/cloudstack/api/response/NetworkOfferingResponse.java b/api/src/org/apache/cloudstack/api/response/NetworkOfferingResponse.java
@@ -117,7 +117,7 @@ public class NetworkOfferingResponse extends BaseResponse {
     private Integer concurrentConnections;
 
     @SerializedName(ApiConstants.SUPPORTS_STRECHED_L2_SUBNET)
-    @Param(description = "true if network offering supports network that span multiple zones")
+    @Param(description = "true if network offering supports network that span multiple zones", since = "4.4")
     private Boolean supportsStrechedL2Subnet;
 
     public void setId(String id) {
diff --git a/api/src/org/apache/cloudstack/api/response/NetworkResponse.java b/api/src/org/apache/cloudstack/api/response/NetworkResponse.java
@@ -218,11 +218,11 @@ public class NetworkResponse extends BaseResponse implements ControlledEntityRes
     private String aclId;
 
     @SerializedName(ApiConstants.STRECHED_L2_SUBNET)
-    @Param(description = "true if network can span multiple zones")
+    @Param(description = "true if network can span multiple zones", since = "4.4")
     private Boolean strechedL2Subnet;
 
     @SerializedName(ApiConstants.NETWORK_SPANNED_ZONES)
-    @Param(description = "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans")
+    @Param(description = "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", since = "4.4")
     private Set<String> networkSpannedZones;
 
     public Boolean getDisplayNetwork() {
diff --git a/api/src/org/apache/cloudstack/api/response/ServiceOfferingResponse.java b/api/src/org/apache/cloudstack/api/response/ServiceOfferingResponse.java
@@ -107,19 +107,19 @@ public class ServiceOfferingResponse extends BaseResponse {
     private Integer networkRate;
 
     @SerializedName("iscustomizediops")
-    @Param(description = "true if disk offering uses custom iops, false otherwise")
+    @Param(description = "true if disk offering uses custom iops, false otherwise", since = "4.4")
     private Boolean customizedIops;
 
     @SerializedName(ApiConstants.MIN_IOPS)
-    @Param(description = "the min iops of the disk offering")
+    @Param(description = "the min iops of the disk offering", since = "4.4")
     private Long minIops;
 
     @SerializedName(ApiConstants.MAX_IOPS)
-    @Param(description = "the max iops of the disk offering")
+    @Param(description = "the max iops of the disk offering", since = "4.4")
     private Long maxIops;
 
     @SerializedName(ApiConstants.HYPERVISOR_SNAPSHOT_RESERVE)
-    @Param(description = "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)")
+    @Param(description = "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", since = "4.4")
     private Integer hypervisorSnapshotReserve;
 
     @SerializedName("diskBytesReadRate")
diff --git a/api/src/org/apache/cloudstack/api/response/StoragePoolResponse.java b/api/src/org/apache/cloudstack/api/response/StoragePoolResponse.java
@@ -108,8 +108,8 @@ public class StoragePoolResponse extends BaseResponse {
     private String scope;
 
     @SerializedName("overprovisionfactor")
-    @Param(description = "the overprovisionfactor for the storage pool")
-    private String overprovisionfactor;
+    @Param(description = "the overprovisionfactor for the storage pool", since = "4.4")
+    private String overProvisionFactor;
 
     @SerializedName(ApiConstants.HYPERVISOR)
     @Param(description = "the hypervisor type of the storage pool")
@@ -307,6 +307,6 @@ public void setSuitableForMigration(Boolean suitableForMigration) {
     }
 
     public void setOverProvisionFactor(String overProvisionFactor) {
-        this.overprovisionfactor = overProvisionFactor;
+        this.overProvisionFactor = overProvisionFactor;
     }
 }
diff --git a/api/src/org/apache/cloudstack/api/response/UserVmResponse.java b/api/src/org/apache/cloudstack/api/response/UserVmResponse.java
@@ -141,11 +141,11 @@ public class UserVmResponse extends BaseResponse implements ControlledEntityResp
     private String serviceOfferingName;
 
     @SerializedName(ApiConstants.DISK_OFFERING_ID)
-    @Param(description = "the ID of the disk offering of the virtual machine")
+    @Param(description = "the ID of the disk offering of the virtual machine", since = "4.4")
     private String diskOfferingId;
 
     @SerializedName("diskofferingname")
-    @Param(description = "the name of the disk offering of the virtual machine")
+    @Param(description = "the name of the disk offering of the virtual machine", since = "4.4")
     private String diskOfferingName;
 
     @SerializedName("forvirtualnetwork")
@@ -165,7 +165,7 @@ public class UserVmResponse extends BaseResponse implements ControlledEntityResp
     private Integer memory;
 
     @SerializedName(ApiConstants.VGPU)
-    @Param(description = "the vgpu type used by the virtual machine")
+    @Param(description = "the vgpu type used by the virtual machine", since = "4.4")
     private String vgpu;
 
     @SerializedName("cpuused")
diff --git a/api/src/org/apache/cloudstack/api/response/VpcOfferingResponse.java b/api/src/org/apache/cloudstack/api/response/VpcOfferingResponse.java
@@ -60,11 +60,11 @@ public class VpcOfferingResponse extends BaseResponse {
     private List<ServiceResponse> services;
 
     @SerializedName(ApiConstants.DISTRIBUTED_VPC_ROUTER)
-    @Param(description = " indicates if the vpc offering supports distributed router for one-hop forwarding")
+    @Param(description = " indicates if the vpc offering supports distributed router for one-hop forwarding", since = "4.4")
     private Boolean supportsDistributedRouter;
 
     @SerializedName((ApiConstants.SUPPORTS_REGION_LEVEL_VPC))
-    @Param(description = " indicated if the offering can support region level vpc")
+    @Param(description = " indicated if the offering can support region level vpc", since = "4.4")
     private Boolean supportsRegionLevelVpc;
 
     public void setId(String id) {
diff --git a/api/src/org/apache/cloudstack/api/response/VpcResponse.java b/api/src/org/apache/cloudstack/api/response/VpcResponse.java
@@ -112,11 +112,11 @@ public class VpcResponse extends BaseResponse implements ControlledEntityRespons
     private Boolean forDisplay;
 
     @SerializedName(ApiConstants.DISTRIBUTED_VPC_ROUTER)
-    @Param(description = "is VPC uses distributed router for one hop forwarding and host based network ACL's")
+    @Param(description = "is VPC uses distributed router for one hop forwarding and host based network ACL's", since = "4.4")
     private boolean usesDistributedRouter;
 
     @SerializedName((ApiConstants.REGION_LEVEL_VPC))
-    @Param(description = "true if VPC is region level")
+    @Param(description = "true if VPC is region level", since = "4.4")
     private Boolean regionLevelVpc;
 
     public void setId(String id) {
