Skip to content

Commit 3bedddb

Browse files
authored
Update API documentation for resizing (apache#6556)
The correct parameter is `cpuspeed` and not `cpu`. This led me to some confusion when resizing a VM attached to an offering allowing custom values. Co-authored-by: Ruben Bosch <[email protected]>
1 parent d4460a8 commit 3bedddb

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/ScaleSystemVMCmd.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public class ScaleSystemVMCmd extends BaseAsyncCmd {
6060
@Parameter(name = ApiConstants.SERVICE_OFFERING_ID, type = CommandType.UUID, entityType = ServiceOfferingResponse.class, required = true, description = "the service offering ID to apply to the system vm")
6161
private Long serviceOfferingId;
6262

63-
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value")
63+
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value")
6464
private Map<String, String> details;
6565

6666
/////////////////////////////////////////////////////

api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/UpgradeSystemVMCmd.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public class UpgradeSystemVMCmd extends BaseCmd {
5555
@Parameter(name = ApiConstants.SERVICE_OFFERING_ID, type = CommandType.UUID, entityType = ServiceOfferingResponse.class, required = true, description = "the service offering ID to apply to the system vm")
5656
private Long serviceOfferingId;
5757

58-
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value")
58+
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value")
5959
private Map<String, String> details;
6060

6161
/////////////////////////////////////////////////////

api/src/main/java/org/apache/cloudstack/api/command/user/vm/ScaleVMCmd.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ public class ScaleVMCmd extends BaseAsyncCmd implements UserCmd {
6767
required=true, description="the ID of the service offering for the virtual machine")
6868
private Long serviceOfferingId;
6969

70-
@Parameter(name = ApiConstants.DETAILS, type = BaseCmd.CommandType.MAP, description = "name value pairs of custom parameters for cpu,memory and cpunumber. example details[i].name=value")
70+
@Parameter(name = ApiConstants.DETAILS, type = BaseCmd.CommandType.MAP, description = "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value")
7171
private Map<String, String> details;
7272

7373
@Parameter(name = ApiConstants.MIN_IOPS, type = CommandType.LONG, required = false, description = "New minimum number of IOPS for the custom disk offering", since = "4.17")

api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpgradeVMCmd.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public class UpgradeVMCmd extends BaseCmd implements UserCmd {
6666
required=true, description="the service offering ID to apply to the virtual machine")
6767
protected Long serviceOfferingId;
6868

69-
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value")
69+
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value")
7070
private Map<String, String> details;
7171

7272
@Parameter(name = ApiConstants.MIN_IOPS, type = CommandType.LONG, required = false, description = "New minimum number of IOPS for the custom disk offering", since = "4.17")

0 commit comments

Comments
 (0)