Address reviews

Author: winterhazel

plugins/database/quota/src/main/java/org/apache/cloudstack/api/command/QuotaSummaryCmd.java

@@ -38,7 +38,7 @@
 
 import javax.inject.Inject;
 
-@APICommand(name = "quotaSummary", responseObject = QuotaSummaryResponse.class, description = "Lists Quota balance summary of Accounts.", since = "4.7.0",
+@APICommand(name = "quotaSummary", responseObject = QuotaSummaryResponse.class, description = "Lists Quota balance summary of Accounts and Projects.", since = "4.7.0",
         requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, httpMethod = "GET")
 public class QuotaSummaryCmd extends BaseListCmd {
 
@@ -49,19 +49,19 @@ public class QuotaSummaryCmd extends BaseListCmd {
     QuotaService quotaService;
 
     @ACL
-    @Parameter(name = ApiConstants.ACCOUNT_ID, type = CommandType.UUID, entityType = AccountResponse.class, description = "ID of the account for which balance will be listed. Can not be specified with projectId.", since = "4.23.0")
+    @Parameter(name = ApiConstants.ACCOUNT_ID, type = CommandType.UUID, entityType = AccountResponse.class, description = "ID of the Account for which balance will be listed. Can not be specified with projectid.", since = "4.23.0")
     private Long accountId;
 
     @ACL
-    @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, required = false, description = "Optional, Account Id for which statement needs to be generated")
+    @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, required = false, description = "Name of the Account for which balance will be listed.")
     private String accountName;
 
     @ACL
-    @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, required = false, entityType = DomainResponse.class, description = "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.")
+    @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, required = false, entityType = DomainResponse.class, description = "ID of the Domain for which balance will be listed. May be used individually or with accountname.")
     private Long domainId;
 
     @Parameter(name = ApiConstants.LIST_ALL, type = CommandType.BOOLEAN, description = "False (default) lists the Quota balance summary for calling Account. True lists balance summary for " +
-            "Accounts which the caller has access.")
+            "Accounts which the caller has access. If domain ID is informed, this parameter is considered as true.")
     private Boolean listAll;
 
     @Parameter(name = ApiConstants.ACCOUNT_STATE_TO_SHOW, type = CommandType.STRING, description =  "Possible values are [ALL, ACTIVE, REMOVED]. ALL will list summaries for " +
@@ -70,7 +70,7 @@ public class QuotaSummaryCmd extends BaseListCmd {
     private String accountStateToShow;
 
     @ACL
-    @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "ID of the project for which balance will be listed. Can not be specified with accountId.", since = "4.23.0")
+    @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "ID of the Project for which balance will be listed. Can not be specified with accountId.", since = "4.23.0")
     private Long projectId;
 
     @Override

plugins/database/quota/src/main/java/org/apache/cloudstack/api/response/QuotaResponseBuilderImpl.java

@@ -51,7 +51,6 @@
 import com.cloud.utils.exception.CloudRuntimeException;
 import org.apache.cloudstack.api.ApiErrorCode;
 import org.apache.cloudstack.api.ServerApiException;
-
 import org.apache.cloudstack.api.command.QuotaBalanceCmd;
 import org.apache.cloudstack.api.command.QuotaConfigureEmailCmd;
 import org.apache.cloudstack.api.command.QuotaCreditsListCmd;
@@ -217,7 +216,6 @@ protected Pair<List<QuotaSummaryResponse>, Integer> getQuotaSummaryResponseWithL
 
         Long accountId = cmd.getEntityOwnerId();
         if (accountId == -1) {
-            // No specific account was provided
             accountId = cmd.isListAll() ? null : caller.getAccountId();
         }
 
@@ -245,9 +243,15 @@ protected String getDomainPathByDomainIdForDomainAdmin(Account caller) {
         return domain.getPath();
     }
 
+    /**
+     * Returns a <code>List</code> of <code>QuotaSummaryResponse</code> based on the provided parameters.
+     * @param accountId ID of the Account to return the summaries for. If <code>-1</code>, either because no specific
+     *                  Account was provided, or list all is disabled, then the summary is generated for the calling Account.
+     * @param domainId ID of the Domain to return the summaries for.
+     * @param domainPath path of the Domain to return the summaries for.
+     */
     protected Pair<List<QuotaSummaryResponse>, Integer> getQuotaSummaryResponse(Long accountId, Long domainId, String domainPath, QuotaSummaryCmd cmd) {
         if (accountId != null && accountId == -1) {
-            // Either no specific account as provided, or list all is disabled
             accountId = CallContext.current().getCallingAccountId();
         }
 

plugins/database/quota/src/main/java/org/apache/cloudstack/api/response/QuotaSummaryResponse.java

@@ -53,11 +53,11 @@ public class QuotaSummaryResponse extends BaseResponse {
     private State state;
 
     @SerializedName("domainremoved")
-    @Param(description = "If the domain is removed or not", since = "4.21.0")
+    @Param(description = "If the domain is removed or not", since = "4.23.0")
     private boolean domainRemoved;
 
     @SerializedName("accountremoved")
-    @Param(description = "If the account is removed or not", since = "4.21.0")
+    @Param(description = "If the account is removed or not", since = "4.23.0")
     private boolean accountRemoved;
 
     @SerializedName("quota")
@@ -81,15 +81,15 @@ public class QuotaSummaryResponse extends BaseResponse {
     private boolean quotaEnabled;
 
     @SerializedName("projectname")
-    @Param(description = "Name of the project", since = "4.21.0")
+    @Param(description = "Name of the project", since = "4.23.0")
     private String projectName;
 
     @SerializedName("projectid")
-    @Param(description = "Project's id", since = "4.21.0")
+    @Param(description = "Project's id", since = "4.23.0")
     private String projectId;
 
     @SerializedName("projectremoved")
-    @Param(description = "Whether the project is removed or not", since = "4.21.0")
+    @Param(description = "Whether the project is removed or not", since = "4.23.0")
     private Boolean projectRemoved;
 
     public String getAccountId() {

server/src/main/java/com/cloud/user/AccountManagerImpl.java

@@ -3904,7 +3904,7 @@ public Long finalizeAccountId(Long accountId, String accountName, Long domainId,
         }
 
         if (accountName == null && domainId == null) {
-            throw new ServerApiException(ApiErrorCode.PARAM_ERROR, String.format("Either %s or %s is required.", ApiConstants.ACCOUNT_ID, ApiConstants.PROJECT_ID));
+            throw new ServerApiException(ApiErrorCode.PARAM_ERROR, String.format("Either %s or %s must be informed.", ApiConstants.ACCOUNT_ID, ApiConstants.PROJECT_ID));
         }
 
         try {