[cloudstack] branch main updated: Enhance Documentation for changeServiceForVirtualMachine and scaleVirtualMachine (#5101)

[dahn]

This is an automated email from the ASF dual-hosted git repository.

dahn pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudstack.git


The following commit(s) were added to refs/heads/main by this push:
     new 1c36ea9  Enhance Documentation for changeServiceForVirtualMachine and 
scaleVirtualMachine (#5101)
1c36ea9 is described below

commit 1c36ea9b4f21edfb865ce2f5b846cf0d437a25f3
Author: Gabriel Beims Bräscher <gabr...@apache.org>
AuthorDate: Tue Jun 15 18:25:20 2021 -0300

    Enhance Documentation for changeServiceForVirtualMachine and 
scaleVirtualMachine (#5101)
---
 .../org/apache/cloudstack/api/command/admin/vm/ScaleVMCmdByAdmin.java | 4 ++--
 .../apache/cloudstack/api/command/admin/vm/UpgradeVMCmdByAdmin.java   | 3 ++-
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git 
a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ScaleVMCmdByAdmin.java
 
b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ScaleVMCmdByAdmin.java
index 869b45b..144663f 100644
--- 
a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ScaleVMCmdByAdmin.java
+++ 
b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ScaleVMCmdByAdmin.java
@@ -25,6 +25,6 @@ import org.apache.cloudstack.api.response.SuccessResponse;
 import com.cloud.vm.VirtualMachine;
 
 
-@APICommand(name = "scaleVirtualMachine", description = "Scales the virtual 
machine to a new service offering.", responseObject = SuccessResponse.class, 
responseView = ResponseView.Full, entityType = {VirtualMachine.class},
+@APICommand(name = "scaleVirtualMachine", description = "Scales the virtual 
machine to a new service offering. This command also takes into account the 
Volume and it may resize the root disk size according to the service 
offering.", responseObject = SuccessResponse.class, responseView = 
ResponseView.Full, entityType = {VirtualMachine.class},
         requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
-public class ScaleVMCmdByAdmin extends ScaleVMCmd implements AdminCmd {}
\ No newline at end of file
+public class ScaleVMCmdByAdmin extends ScaleVMCmd implements AdminCmd {}
diff --git 
a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UpgradeVMCmdByAdmin.java
 
b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UpgradeVMCmdByAdmin.java
index 7291fe9..9db9907 100644
--- 
a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UpgradeVMCmdByAdmin.java
+++ 
b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UpgradeVMCmdByAdmin.java
@@ -26,6 +26,7 @@ import com.cloud.vm.VirtualMachine;
 
 @APICommand(name = "changeServiceForVirtualMachine", 
responseObject=UserVmResponse.class, description="Changes the service offering 
for a virtual machine. " +
                                             "The virtual machine must be in a 
\"Stopped\" state for " +
-        "this command to take effect.", responseView = ResponseView.Full, 
entityType = {VirtualMachine.class},
+        "this command to take effect. Note that it only changes the VM's 
compute offering and it does not update the root volume offering. "
+        + "If the Service Offering has a root disk size the volume will be 
resized only if using API command 'scaleVirtualMachine'.", responseView = 
ResponseView.Full, entityType = {VirtualMachine.class},
         requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
 public class UpgradeVMCmdByAdmin extends UpgradeVMCmd implements AdminCmd {}