[cloudstack] branch main updated: Update listVirtualMachines API documentation with 'projectid=-1' to list all VMs in projects. (#4276)

[sureshanaparti]

This is an automated email from the ASF dual-hosted git repository.

sureshanaparti pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudstack.git


The following commit(s) were added to refs/heads/main by this push:
     new cb75e8f  Update listVirtualMachines API documentation with 
'projectid=-1' to list all VMs in projects. (#4276)
cb75e8f is described below

commit cb75e8f1af33f76cc90a1e363fe7bc5ced9fdcd1
Author: Gabriel Beims Bräscher <gabr...@apache.org>
AuthorDate: Tue Dec 14 13:06:51 2021 -0300

    Update listVirtualMachines API documentation with 'projectid=-1' to list 
all VMs in projects. (#4276)
    
    * Enhance API list commands documentation for "listAll" and "projectid" 
parameters
---
 .../main/java/org/apache/cloudstack/api/BaseListDomainResourcesCmd.java | 2 +-
 .../apache/cloudstack/api/BaseListProjectAndAccountResourcesCmd.java    | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git 
a/api/src/main/java/org/apache/cloudstack/api/BaseListDomainResourcesCmd.java 
b/api/src/main/java/org/apache/cloudstack/api/BaseListDomainResourcesCmd.java
index c402a3c..7a8cee3 100644
--- 
a/api/src/main/java/org/apache/cloudstack/api/BaseListDomainResourcesCmd.java
+++ 
b/api/src/main/java/org/apache/cloudstack/api/BaseListDomainResourcesCmd.java
@@ -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,
diff --git 
a/api/src/main/java/org/apache/cloudstack/api/BaseListProjectAndAccountResourcesCmd.java
 
b/api/src/main/java/org/apache/cloudstack/api/BaseListProjectAndAccountResourcesCmd.java
index 46d09b2..0bcfba1 100644
--- 
a/api/src/main/java/org/apache/cloudstack/api/BaseListProjectAndAccountResourcesCmd.java
+++ 
b/api/src/main/java/org/apache/cloudstack/api/BaseListProjectAndAccountResourcesCmd.java
@@ -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