[GitHub] [cloudstack] weizhouapache commented on a diff in pull request #7876: Api command descriptions

["weizhouapache (via GitHub)" <gi...@apache.org>]

weizhouapache commented on code in PR #7876:
URL: https://github.com/apache/cloudstack/pull/7876#discussion_r1296157976


##########
api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkCmd.java:
##########
@@ -118,7 +118,8 @@ public class CreateNetworkCmd extends BaseCmd implements UserCmd {
     private Long projectId;
 
     @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "domain ID of the account owning a network. " +
-            "If no account is provided then network will be assigned to the caller account and domain")
+            "If the account or acltype is not specified, the network will be automatically assigned to the caller account and domain." +
+            "To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in your api call.")

Review Comment:
   your -> the ?



##########
api/src/main/java/org/apache/cloudstack/api/command/user/volume/UploadVolumeCmd.java:
##########
@@ -78,7 +78,7 @@ public class UploadVolumeCmd extends BaseAsyncCmd implements UserCmd {
     @Parameter(name = ApiConstants.DOMAIN_ID,
                type = CommandType.UUID,
                entityType = DomainResponse.class,
-               description = "an optional domainId. If the account parameter is used, domainId must also be used.")
+               description = "an optional domainId. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.")

Review Comment:
   volume , not virtual machine 



##########
api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkCmd.java:
##########
@@ -118,7 +118,8 @@ public class CreateNetworkCmd extends BaseCmd implements UserCmd {
     private Long projectId;
 
     @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "domain ID of the account owning a network. " +
-            "If no account is provided then network will be assigned to the caller account and domain")
+            "If the account or acltype is not specified, the network will be automatically assigned to the caller account and domain." +

Review Comment:
   if account is not specified, but acltype is Domain, the network will be created for the specified domain.



##########
api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotCmd.java:
##########
@@ -62,7 +62,7 @@ public class CreateSnapshotCmd extends BaseAsyncCreateCmd {
     @Parameter(name = ApiConstants.DOMAIN_ID,
                type = CommandType.UUID,
                entityType = DomainResponse.class,
-            description = "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume.")
+            description = "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then virtual machine will be assigned to the caller account and domain.")

Review Comment:
   snapshot



##########
api/src/main/java/org/apache/cloudstack/api/command/user/volume/CreateVolumeCmd.java:
##########
@@ -70,7 +70,8 @@ public class CreateVolumeCmd extends BaseAsyncCreateCustomIdCmd implements UserC
                type = CommandType.UUID,
                entityType = DomainResponse.class,
                description = "the domain ID associated with the disk offering. If used with the account parameter"
-                   + " returns the disk volume associated with the account for the specified domain.")
+                   + " returns the disk volume associated with the account for the specified domain." +
+                       "If account is NOT provided then virtual machine will be assigned to the caller account and domain.")

Review Comment:
   volume , not virtual machine 



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org