Skip to content

Commit cb75e8f

Browse files
Update listVirtualMachines API documentation with 'projectid=-1' to list all VMs in projects. (#4276)
* Enhance API list commands documentation for "listAll" and "projectid" parameters
1 parent 937996c commit cb75e8f

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

api/src/main/java/org/apache/cloudstack/api/BaseListDomainResourcesCmd.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
public abstract class BaseListDomainResourcesCmd extends BaseListCmd implements IBaseListDomainResourcesCmd {
2222

2323
@Parameter(name = ApiConstants.LIST_ALL, type = CommandType.BOOLEAN, description = "If set to false, "
24-
+ "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")
24+
+ "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.")
2525
private Boolean listAll;
2626

2727
@Parameter(name = ApiConstants.DOMAIN_ID,

api/src/main/java/org/apache/cloudstack/api/BaseListProjectAndAccountResourcesCmd.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
public abstract class BaseListProjectAndAccountResourcesCmd extends BaseListAccountResourcesCmd implements IBaseListProjectAndAccountResourcesCmd {
2222

23-
@Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "list objects by project")
23+
@Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "list objects by project; if projectid=-1 lists All VMs")
2424
private Long projectId;
2525

2626
@Override

0 commit comments

Comments
 (0)