Skip to content

Commit d296f54

Browse files
authored
Api: update command domainId/account descriptions (#7876)
1 parent f7345e8 commit d296f54

File tree

13 files changed

+16
-13
lines changed

13 files changed

+16
-13
lines changed

api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkCmd.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,9 @@ public class CreateNetworkCmd extends BaseCmd implements UserCmd {
118118
private Long projectId;
119119

120120
@Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "domain ID of the account owning a network. " +
121-
"If no account is provided then network will be assigned to the caller account and domain")
121+
"If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. " +
122+
"To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. " +
123+
"If account is not specified, but acltype is Domain, the network will be created for the specified domain.")
122124
private Long domainId;
123125

124126
@Parameter(name = ApiConstants.SUBDOMAIN_ACCESS,

api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotCmd.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public class CreateSnapshotCmd extends BaseAsyncCreateCmd {
6262
@Parameter(name = ApiConstants.DOMAIN_ID,
6363
type = CommandType.UUID,
6464
entityType = DomainResponse.class,
65-
description = "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume.")
65+
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 snapshot will be assigned to the caller account and domain.")
6666
private Long domainId;
6767

6868
@Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.UUID, entityType = VolumeResponse.class, required = true, description = "The ID of the disk volume")

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd implements SecurityG
109109
@Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account for the virtual machine. Must be used with domainId.")
110110
private String accountName;
111111

112-
@Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.")
112+
@Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "an optional domainId for the virtual machine. 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.")
113113
private Long domainId;
114114

115115
//Network information

api/src/main/java/org/apache/cloudstack/api/command/user/volume/CreateVolumeCmd.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,8 @@ public class CreateVolumeCmd extends BaseAsyncCreateCustomIdCmd implements UserC
7070
type = CommandType.UUID,
7171
entityType = DomainResponse.class,
7272
description = "the domain ID associated with the disk offering. If used with the account parameter"
73-
+ " returns the disk volume associated with the account for the specified domain.")
73+
+ " returns the disk volume associated with the account for the specified domain." +
74+
"If account is NOT provided then the volume will be assigned to the caller account and domain.")
7475
private Long domainId;
7576

7677
@Parameter(name = ApiConstants.DISK_OFFERING_ID,

api/src/main/java/org/apache/cloudstack/api/command/user/volume/UploadVolumeCmd.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ public class UploadVolumeCmd extends BaseAsyncCmd implements UserCmd {
7878
@Parameter(name = ApiConstants.DOMAIN_ID,
7979
type = CommandType.UUID,
8080
entityType = DomainResponse.class,
81-
description = "an optional domainId. If the account parameter is used, domainId must also be used.")
81+
description = "an optional domainId. If the account parameter is used, domainId must also be used. If account is NOT provided then volume will be assigned to the caller account and domain.")
8282
private Long domainId;
8383

8484
@Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional accountName. Must be used with domainId.")

api/src/main/java/org/apache/cloudstack/api/response/UserVmResponse.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ public class UserVmResponse extends BaseResponseWithTagInformation implements Co
103103
private String group;
104104

105105
@SerializedName(ApiConstants.ZONE_ID)
106-
@Param(description = "the ID of the availablility zone for the virtual machine")
106+
@Param(description = "the ID of the availability zone for the virtual machine")
107107
private String zoneId;
108108

109109
@SerializedName(ApiConstants.ZONE_NAME)

plugins/api/rate-limit/src/main/java/org/apache/cloudstack/api/command/admin/ratelimit/ResetApiLimitCmd.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public class ResetApiLimitCmd extends BaseCmd {
5353
/////////////////////////////////////////////////////
5454

5555
@ACL
56-
@Parameter(name = ApiConstants.ACCOUNT, type = CommandType.UUID, entityType = AccountResponse.class, description = "the ID of the acount whose limit to be reset")
56+
@Parameter(name = ApiConstants.ACCOUNT, type = CommandType.UUID, entityType = AccountResponse.class, description = "the ID of the account whose limit to be reset")
5757
private Long accountId;
5858

5959
/////////////////////////////////////////////////////

plugins/network-elements/tungsten/src/main/java/org/apache/cloudstack/network/tungsten/api/command/ListTungstenFabricTagCmd.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public class ListTungstenFabricTagCmd extends BaseListCmd {
6161
@Parameter(name = ApiConstants.VM_UUID, type = CommandType.STRING, description = "the uuid of Tungsten-Fabric vm")
6262
private String vmUuid;
6363

64-
@Parameter(name = ApiConstants.NIC_UUID, type = CommandType.STRING, description = "tthe uuid of Tungsten-Fabric nic")
64+
@Parameter(name = ApiConstants.NIC_UUID, type = CommandType.STRING, description = "the uuid of Tungsten-Fabric nic")
6565
private String nicUuid;
6666

6767
@Parameter(name = ApiConstants.POLICY_UUID, type = CommandType.STRING, description = "the uuid of Tungsten-Fabric policy")

plugins/storage/volume/cloudbyte/src/main/java/org/apache/cloudstack/storage/datastore/util/ListElastistorVolumeResponse.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public class ListElastistorVolumeResponse extends BaseResponse {
4848
private String compression;
4949

5050
@SerializedName("sync")
51-
@Param(description = "syncronization")
51+
@Param(description = "synchronization")
5252
private String sync;
5353

5454
public String getGraceAllowed() {

plugins/user-authenticators/ldap/src/main/java/org/apache/cloudstack/api/response/LdapConfigurationResponse.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public class LdapConfigurationResponse extends BaseResponse {
3232
private String hostname;
3333

3434
@SerializedName(ApiConstants.PORT)
35-
@Param(description = "port teh ldap server is running on")
35+
@Param(description = "port the ldap server is running on")
3636
private int port;
3737

3838
@SerializedName(ApiConstants.DOMAIN_ID)

0 commit comments

Comments
 (0)