mirror of
https://github.com/apache/cloudstack.git
synced 2025-10-26 08:42:29 +01:00
Api: update command domainId/account descriptions (#7876)
This commit is contained in:
parent
f7345e861f
commit
d296f54c7f
@ -118,7 +118,9 @@ public class CreateNetworkCmd extends BaseCmd implements UserCmd {
|
|||||||
private Long projectId;
|
private Long projectId;
|
||||||
|
|
||||||
@Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "domain ID of the account owning a network. " +
|
@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 is not specified, but the acltype is Account or 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 the api call. " +
|
||||||
|
"If account is not specified, but acltype is Domain, the network will be created for the specified domain.")
|
||||||
private Long domainId;
|
private Long domainId;
|
||||||
|
|
||||||
@Parameter(name = ApiConstants.SUBDOMAIN_ACCESS,
|
@Parameter(name = ApiConstants.SUBDOMAIN_ACCESS,
|
||||||
|
|||||||
@ -62,7 +62,7 @@ public class CreateSnapshotCmd extends BaseAsyncCreateCmd {
|
|||||||
@Parameter(name = ApiConstants.DOMAIN_ID,
|
@Parameter(name = ApiConstants.DOMAIN_ID,
|
||||||
type = CommandType.UUID,
|
type = CommandType.UUID,
|
||||||
entityType = DomainResponse.class,
|
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 snapshot will be assigned to the caller account and domain.")
|
||||||
private Long domainId;
|
private Long domainId;
|
||||||
|
|
||||||
@Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.UUID, entityType = VolumeResponse.class, required = true, description = "The ID of the disk volume")
|
@Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.UUID, entityType = VolumeResponse.class, required = true, description = "The ID of the disk volume")
|
||||||
|
|||||||
@ -109,7 +109,7 @@ public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd implements SecurityG
|
|||||||
@Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account for the virtual machine. Must be used with domainId.")
|
@Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account for the virtual machine. Must be used with domainId.")
|
||||||
private String accountName;
|
private String accountName;
|
||||||
|
|
||||||
@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.")
|
@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.")
|
||||||
private Long domainId;
|
private Long domainId;
|
||||||
|
|
||||||
//Network information
|
//Network information
|
||||||
|
|||||||
@ -70,7 +70,8 @@ public class CreateVolumeCmd extends BaseAsyncCreateCustomIdCmd implements UserC
|
|||||||
type = CommandType.UUID,
|
type = CommandType.UUID,
|
||||||
entityType = DomainResponse.class,
|
entityType = DomainResponse.class,
|
||||||
description = "the domain ID associated with the disk offering. If used with the account parameter"
|
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 the volume will be assigned to the caller account and domain.")
|
||||||
private Long domainId;
|
private Long domainId;
|
||||||
|
|
||||||
@Parameter(name = ApiConstants.DISK_OFFERING_ID,
|
@Parameter(name = ApiConstants.DISK_OFFERING_ID,
|
||||||
|
|||||||
@ -78,7 +78,7 @@ public class UploadVolumeCmd extends BaseAsyncCmd implements UserCmd {
|
|||||||
@Parameter(name = ApiConstants.DOMAIN_ID,
|
@Parameter(name = ApiConstants.DOMAIN_ID,
|
||||||
type = CommandType.UUID,
|
type = CommandType.UUID,
|
||||||
entityType = DomainResponse.class,
|
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 volume will be assigned to the caller account and domain.")
|
||||||
private Long domainId;
|
private Long domainId;
|
||||||
|
|
||||||
@Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional accountName. Must be used with domainId.")
|
@Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional accountName. Must be used with domainId.")
|
||||||
|
|||||||
@ -103,7 +103,7 @@ public class UserVmResponse extends BaseResponseWithTagInformation implements Co
|
|||||||
private String group;
|
private String group;
|
||||||
|
|
||||||
@SerializedName(ApiConstants.ZONE_ID)
|
@SerializedName(ApiConstants.ZONE_ID)
|
||||||
@Param(description = "the ID of the availablility zone for the virtual machine")
|
@Param(description = "the ID of the availability zone for the virtual machine")
|
||||||
private String zoneId;
|
private String zoneId;
|
||||||
|
|
||||||
@SerializedName(ApiConstants.ZONE_NAME)
|
@SerializedName(ApiConstants.ZONE_NAME)
|
||||||
|
|||||||
@ -53,7 +53,7 @@ public class ResetApiLimitCmd extends BaseCmd {
|
|||||||
/////////////////////////////////////////////////////
|
/////////////////////////////////////////////////////
|
||||||
|
|
||||||
@ACL
|
@ACL
|
||||||
@Parameter(name = ApiConstants.ACCOUNT, type = CommandType.UUID, entityType = AccountResponse.class, description = "the ID of the acount whose limit to be reset")
|
@Parameter(name = ApiConstants.ACCOUNT, type = CommandType.UUID, entityType = AccountResponse.class, description = "the ID of the account whose limit to be reset")
|
||||||
private Long accountId;
|
private Long accountId;
|
||||||
|
|
||||||
/////////////////////////////////////////////////////
|
/////////////////////////////////////////////////////
|
||||||
|
|||||||
@ -61,7 +61,7 @@ public class ListTungstenFabricTagCmd extends BaseListCmd {
|
|||||||
@Parameter(name = ApiConstants.VM_UUID, type = CommandType.STRING, description = "the uuid of Tungsten-Fabric vm")
|
@Parameter(name = ApiConstants.VM_UUID, type = CommandType.STRING, description = "the uuid of Tungsten-Fabric vm")
|
||||||
private String vmUuid;
|
private String vmUuid;
|
||||||
|
|
||||||
@Parameter(name = ApiConstants.NIC_UUID, type = CommandType.STRING, description = "tthe uuid of Tungsten-Fabric nic")
|
@Parameter(name = ApiConstants.NIC_UUID, type = CommandType.STRING, description = "the uuid of Tungsten-Fabric nic")
|
||||||
private String nicUuid;
|
private String nicUuid;
|
||||||
|
|
||||||
@Parameter(name = ApiConstants.POLICY_UUID, type = CommandType.STRING, description = "the uuid of Tungsten-Fabric policy")
|
@Parameter(name = ApiConstants.POLICY_UUID, type = CommandType.STRING, description = "the uuid of Tungsten-Fabric policy")
|
||||||
|
|||||||
@ -48,7 +48,7 @@ public class ListElastistorVolumeResponse extends BaseResponse {
|
|||||||
private String compression;
|
private String compression;
|
||||||
|
|
||||||
@SerializedName("sync")
|
@SerializedName("sync")
|
||||||
@Param(description = "syncronization")
|
@Param(description = "synchronization")
|
||||||
private String sync;
|
private String sync;
|
||||||
|
|
||||||
public String getGraceAllowed() {
|
public String getGraceAllowed() {
|
||||||
|
|||||||
@ -32,7 +32,7 @@ public class LdapConfigurationResponse extends BaseResponse {
|
|||||||
private String hostname;
|
private String hostname;
|
||||||
|
|
||||||
@SerializedName(ApiConstants.PORT)
|
@SerializedName(ApiConstants.PORT)
|
||||||
@Param(description = "port teh ldap server is running on")
|
@Param(description = "port the ldap server is running on")
|
||||||
private int port;
|
private int port;
|
||||||
|
|
||||||
@SerializedName(ApiConstants.DOMAIN_ID)
|
@SerializedName(ApiConstants.DOMAIN_ID)
|
||||||
|
|||||||
@ -34,7 +34,7 @@ public class LinkAccountToLdapResponse extends BaseResponse {
|
|||||||
private String ldapDomain;
|
private String ldapDomain;
|
||||||
|
|
||||||
@SerializedName(ApiConstants.TYPE)
|
@SerializedName(ApiConstants.TYPE)
|
||||||
@Param(description = "type of the name in LDAP which is linke to the domain")
|
@Param(description = "type of the name in LDAP which is linked to the domain")
|
||||||
private String type;
|
private String type;
|
||||||
|
|
||||||
@SerializedName(ApiConstants.ACCOUNT_TYPE)
|
@SerializedName(ApiConstants.ACCOUNT_TYPE)
|
||||||
|
|||||||
@ -39,7 +39,7 @@ public class LinkDomainToLdapResponse extends BaseResponse {
|
|||||||
private String ldapDomain;
|
private String ldapDomain;
|
||||||
|
|
||||||
@SerializedName(ApiConstants.TYPE)
|
@SerializedName(ApiConstants.TYPE)
|
||||||
@Param(description = "type of the name in LDAP which is linke to the domain")
|
@Param(description = "type of the name in LDAP which is linked to the domain")
|
||||||
private String type;
|
private String type;
|
||||||
|
|
||||||
@SerializedName(ApiConstants.ACCOUNT_TYPE)
|
@SerializedName(ApiConstants.ACCOUNT_TYPE)
|
||||||
|
|||||||
@ -62,7 +62,7 @@ public class DefaultLoginAPIAuthenticatorCmd extends BaseCmd implements APIAuthe
|
|||||||
@Parameter(name = ApiConstants.DOMAIN, type = CommandType.STRING, description = "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.")
|
@Parameter(name = ApiConstants.DOMAIN, type = CommandType.STRING, description = "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.")
|
||||||
private String domain;
|
private String domain;
|
||||||
|
|
||||||
@Parameter(name = ApiConstants.DOMAIN__ID, type = CommandType.LONG, description = "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precendence")
|
@Parameter(name = ApiConstants.DOMAIN__ID, type = CommandType.LONG, description = "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precedence.")
|
||||||
private Long domainId;
|
private Long domainId;
|
||||||
|
|
||||||
@Inject
|
@Inject
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user