Update API documentation for resizing (#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 <ruben.bosch@cldin.eu>
This commit is contained in:
Ruben Bosch 2022-07-20 12:41:07 +02:00 committed by GitHub
parent d4460a8afc
commit 3bedddba4b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 4 additions and 4 deletions

View File

@ -60,7 +60,7 @@ public class ScaleSystemVMCmd extends BaseAsyncCmd {
@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")
private Long serviceOfferingId;
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value")
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value")
private Map<String, String> details;
/////////////////////////////////////////////////////

View File

@ -55,7 +55,7 @@ public class UpgradeSystemVMCmd extends BaseCmd {
@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")
private Long serviceOfferingId;
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value")
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value")
private Map<String, String> details;
/////////////////////////////////////////////////////

View File

@ -67,7 +67,7 @@ public class ScaleVMCmd extends BaseAsyncCmd implements UserCmd {
required=true, description="the ID of the service offering for the virtual machine")
private Long serviceOfferingId;
@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")
@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")
private Map<String, String> details;
@Parameter(name = ApiConstants.MIN_IOPS, type = CommandType.LONG, required = false, description = "New minimum number of IOPS for the custom disk offering", since = "4.17")

View File

@ -66,7 +66,7 @@ public class UpgradeVMCmd extends BaseCmd implements UserCmd {
required=true, description="the service offering ID to apply to the virtual machine")
protected Long serviceOfferingId;
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value")
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value")
private Map<String, String> details;
@Parameter(name = ApiConstants.MIN_IOPS, type = CommandType.LONG, required = false, description = "New minimum number of IOPS for the custom disk offering", since = "4.17")