Update listVirtualMachines API documentation with 'projectid=-1' to list all VMs in projects. (#4276)

* Enhance API list commands documentation for "listAll" and "projectid" parameters
This commit is contained in:
Gabriel Beims Bräscher 2021-12-14 13:06:51 -03:00 committed by GitHub
parent 937996c1a1
commit cb75e8f1af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 2 deletions

View File

@ -21,7 +21,7 @@ import org.apache.cloudstack.api.response.DomainResponse;
public abstract class BaseListDomainResourcesCmd extends BaseListCmd implements IBaseListDomainResourcesCmd {
@Parameter(name = ApiConstants.LIST_ALL, type = CommandType.BOOLEAN, description = "If set to false, "
+ "list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false")
+ "list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.")
private Boolean listAll;
@Parameter(name = ApiConstants.DOMAIN_ID,

View File

@ -20,7 +20,7 @@ import org.apache.cloudstack.api.response.ProjectResponse;
public abstract class BaseListProjectAndAccountResourcesCmd extends BaseListAccountResourcesCmd implements IBaseListProjectAndAccountResourcesCmd {
@Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "list objects by project")
@Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "list objects by project; if projectid=-1 lists All VMs")
private Long projectId;
@Override