address review comments

sudo87 · sudo87 · commit 04da981233cf · 2025-12-09T11:42:14.000+05:30
diff --git a/api/src/main/java/org/apache/cloudstack/api/BaseUpdateTemplateOrIsoPermissionsCmd.java b/api/src/main/java/org/apache/cloudstack/api/BaseUpdateTemplateOrIsoPermissionsCmd.java
@@ -46,10 +46,10 @@ protected String getResponseName() {
     @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, required = true, description = "The Template ID")
     private Long id;
 
-    @Parameter(name = ApiConstants.IS_FEATURED, type = CommandType.BOOLEAN, description = "True for featured Template/iso, false otherwise")
+    @Parameter(name = ApiConstants.IS_FEATURED, type = CommandType.BOOLEAN, description = "True for featured Template/ISO, false otherwise")
     private Boolean featured;
 
-    @Parameter(name = ApiConstants.IS_PUBLIC, type = CommandType.BOOLEAN, description = "True for public Template/iso, false for private Templates/ISOs")
+    @Parameter(name = ApiConstants.IS_PUBLIC, type = CommandType.BOOLEAN, description = "True for public Template/ISO, false for private Templates/ISOs")
     private Boolean isPublic;
 
     @Parameter(name = ApiConstants.IS_EXTRACTABLE,
@@ -121,7 +121,7 @@ public void execute() {
             SuccessResponse response = new SuccessResponse(getCommandName());
             setResponseObject(response);
         } else {
-            throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update Template/iso permissions");
+            throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update Template/ISO permissions");
         }
     }
 }
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/DeleteAccountCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/DeleteAccountCmd.java
@@ -35,7 +35,7 @@
 import com.cloud.event.EventTypes;
 import com.cloud.user.Account;
 
-@APICommand(name = "deleteAccount", description = "Deletes an account and all users associated with this account", responseObject = SuccessResponse.class, entityType = {Account.class},
+@APICommand(name = "deleteAccount", description = "Deletes an Account and all Users associated with this Account", responseObject = SuccessResponse.class, entityType = {Account.class},
         requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
 public class DeleteAccountCmd extends BaseAsyncCmd {
 
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/DisableAccountCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/DisableAccountCmd.java
@@ -108,7 +108,7 @@ public long getEntityOwnerId() {
 
     @Override
     public String getEventDescription() {
-        return  "Disabling account: " + getAccountName() + " in domain: " + getDomainId();
+        return  "Disabling Account: " + getAccountName() + " in domain: " + getDomainId();
     }
 
     @Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/LockAccountCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/LockAccountCmd.java
@@ -28,7 +28,7 @@
 import com.cloud.utils.exception.CloudRuntimeException;
 
 @APICommand(name = "lockAccount",
-            description = "This deprecated function used to lock an account. Look for the API DisableAccount instead",
+            description = "This deprecated function used to lock an Account. Look for the API DisableAccount instead",
             responseObject = AccountResponse.class,
             entityType = {Account.class},
             requestHasSensitiveInfo = false,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/UpdateProjectRolePermissionCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/UpdateProjectRolePermissionCmd.java
@@ -57,7 +57,7 @@ public class UpdateProjectRolePermissionCmd extends BaseCmd {
     private Long projectId;
 
     @Parameter(name = ApiConstants.RULE_ORDER, type = CommandType.LIST, collectionType = CommandType.UUID, entityType = ProjectRolePermissionResponse.class,
-            description = "The parent role permission UUID, use 0 to move this rule at the top of the list")
+            description = "ID of the parent role permission, use 0 to move this rule at the top of the list")
     private List<Long> projectRulePermissionOrder;
 
     @Parameter(name = ApiConstants.PROJECT_ROLE_PERMISSION_ID, type = CommandType.UUID, entityType = ProjectRolePermissionResponse.class,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/RemoveAnnotationCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/RemoveAnnotationCmd.java
@@ -35,7 +35,7 @@
 public class RemoveAnnotationCmd extends BaseCmd {
 
 
-    @Parameter(name = ApiConstants.ID, type = CommandType.STRING, required = true, description = "The id of the annotation")
+    @Parameter(name = ApiConstants.ID, type = CommandType.STRING, required = true, description = "The ID of the annotation")
     private String uuid;
 
     public String getUuid() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/ca/ProvisionCertificateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/ca/ProvisionCertificateCmd.java
@@ -52,7 +52,7 @@ public class ProvisionCertificateCmd extends BaseAsyncCmd {
     /////////////////////////////////////////////////////
 
     @Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, required = true, entityType = HostResponse.class,
-            description = "The host/agent UUID to which the certificate has to be provisioned (issued and propagated)")
+            description = "The host/agent ID to which the certificate has to be provisioned (issued and propagated)")
     private Long hostId;
 
     @Parameter(name = ApiConstants.RECONNECT, type = CommandType.BOOLEAN,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/DeclareHostAsDegradedCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/DeclareHostAsDegradedCmd.java
@@ -33,7 +33,7 @@
 import org.apache.cloudstack.context.CallContext;
 
 @APICommand(name = "declareHostAsDegraded",
-        description = "Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no Instances running on the respective host otherwise this command might corrupted VMs that were running on the 'Degraded' host.",
+        description = "Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no Instances running on the respective host otherwise this command might corrupted Instances that were running on the 'Degraded' host.",
         since = "4.16.0.0",
         responseObject = HostResponse.class,
         requestHasSensitiveInfo = false,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/UpdateHostCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/UpdateHostCmd.java
@@ -47,7 +47,7 @@ public class UpdateHostCmd extends BaseCmd {
     @Parameter(name = ApiConstants.OS_CATEGORY_ID,
                type = CommandType.UUID,
                entityType = GuestOSCategoryResponse.class,
-               description = "The ID of Os category to update the host with")
+               description = "The ID of OS category to update the host with")
     private Long osCategoryId;
 
     @Parameter(name = ApiConstants.ALLOCATION_STATE,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/ListInternalLBVMsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/ListInternalLBVMsCmd.java
@@ -48,33 +48,33 @@ public class ListInternalLBVMsCmd extends BaseListProjectAndAccountResourcesCmd
     @Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, description = "The host ID of the Internal LB Instance")
     private Long hostId;
 
-    @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "The ID of the Internal LB VM")
+    @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "The ID of the Internal LB Instance")
     private Long id;
 
-    @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the Internal LB VM")
+    @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the Internal LB Instance")
     private String routerName;
 
-    @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "The Pod ID of the Internal LB VM")
+    @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "The Pod ID of the Internal LB Instance")
     private Long podId;
 
-    @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "The state of the Internal LB VM")
+    @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "The state of the Internal LB Instance")
     private String state;
 
-    @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The Zone ID of the Internal LB VM")
+    @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The Zone ID of the Internal LB Instance")
     private Long zoneId;
 
-    @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "List by network id")
+    @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "List by Network ID")
     private Long networkId;
 
-    @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "List Internal LB VMs by VPC")
+    @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "List Internal LB Instances by VPC")
     private Long vpcId;
 
-    @Parameter(name = ApiConstants.FOR_VPC, type = CommandType.BOOLEAN, description = "If true is passed for this parameter, list only VPC Internal LB VMs")
+    @Parameter(name = ApiConstants.FOR_VPC, type = CommandType.BOOLEAN, description = "If true is passed for this parameter, list only VPC Internal LB Instances")
     private Boolean forVpc;
 
 
     @Parameter(name = ApiConstants.FETCH_ROUTER_HEALTH_CHECK_RESULTS, type = CommandType.BOOLEAN, since = "4.14",
-            description = "If true is passed for this parameter, also fetch last executed health check results for the VM. Default is false")
+            description = "If true is passed for this parameter, also fetch last executed health check results for the Instance. Default is false")
     private Boolean fetchHealthCheckResults;
 
     /////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/StartInternalLBVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/StartInternalLBVMCmd.java
@@ -38,7 +38,7 @@
 import com.cloud.network.router.VirtualRouter.Role;
 import com.cloud.vm.VirtualMachine;
 
-@APICommand(name = "startInternalLoadBalancerVM", responseObject = DomainRouterResponse.class, description = "Starts an existing internal lb vm.", entityType = {VirtualMachine.class},
+@APICommand(name = "startInternalLoadBalancerVM", responseObject = DomainRouterResponse.class, description = "Starts an existing Internal LB Instance.", entityType = {VirtualMachine.class},
         requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
 public class StartInternalLBVMCmd extends BaseAsyncCmd {
     private static final String s_name = "startinternallbvmresponse";
@@ -47,7 +47,7 @@ public class StartInternalLBVMCmd extends BaseAsyncCmd {
     //////////////// API parameters /////////////////////
     /////////////////////////////////////////////////////
     @ACL(accessType = AccessType.OperateEntry)
-    @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DomainRouterResponse.class, required = true, description = "The ID of the internal lb vm")
+    @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DomainRouterResponse.class, required = true, description = "The ID of the Internal LB Instance")
     private Long id;
 
     /////////////////////////////////////////////////////
@@ -77,7 +77,7 @@ public long getEntityOwnerId() {
         if (router != null && router.getRole() == Role.INTERNAL_LB_VM) {
             return router.getAccountId();
         } else {
-            throw new InvalidParameterValueException("Unable to find internal lb vm by id");
+            throw new InvalidParameterValueException("Unable to find Internal LB Instance by ID");
         }
     }
 
@@ -88,7 +88,7 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return "starting internal lb Instance: " + getId();
+        return "starting Internal LB Instance: " + getId();
     }
 
     @Override
@@ -103,11 +103,11 @@ public Long getApiResourceId() {
 
     @Override
     public void execute() throws ConcurrentOperationException, ResourceUnavailableException, InsufficientCapacityException {
-        CallContext.current().setEventDetails("Internal Lb Vm Id: " + getId());
+        CallContext.current().setEventDetails("Internal LB Instance ID: " + getId());
         VirtualRouter result = null;
         VirtualRouter router = _routerService.findRouter(getId());
         if (router == null || router.getRole() != Role.INTERNAL_LB_VM) {
-            throw new InvalidParameterValueException("Can't find internal lb vm by id");
+            throw new InvalidParameterValueException("Can't find Internal LB Instance by ID");
         } else {
             result = _internalLbSvc.startInternalLbVm(getId(), CallContext.current().getCallingAccount(), CallContext.current().getCallingUserId());
         }
@@ -117,7 +117,7 @@ public void execute() throws ConcurrentOperationException, ResourceUnavailableEx
             routerResponse.setResponseName(getCommandName());
             setResponseObject(routerResponse);
         } else {
-            throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to start internal lb vm");
+            throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to start Internal LB Instance");
         }
     }
 }
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/StopInternalLBVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/StopInternalLBVMCmd.java
@@ -75,7 +75,7 @@ public long getEntityOwnerId() {
         if (vm != null && vm.getRole() == Role.INTERNAL_LB_VM) {
             return vm.getAccountId();
         } else {
-            throw new InvalidParameterValueException("Unable to find Internal LB Instance by id");
+            throw new InvalidParameterValueException("Unable to find Internal LB Instance by ID");
         }
     }
 
@@ -105,11 +105,11 @@ public boolean isForced() {
 
     @Override
     public void execute() throws ConcurrentOperationException, ResourceUnavailableException {
-        CallContext.current().setEventDetails("Internal lb vm Id: " + getId());
+        CallContext.current().setEventDetails("Internal LB Instance Id: " + getId());
         VirtualRouter result = null;
         VirtualRouter vm = _routerService.findRouter(getId());
         if (vm == null || vm.getRole() != Role.INTERNAL_LB_VM) {
-            throw new InvalidParameterValueException("Can't find internal lb vm by id");
+            throw new InvalidParameterValueException("Can't find Internal LB Instance by ID");
         } else {
             result = _internalLbSvc.stopInternalLbVm(getId(), isForced(), CallContext.current().getCallingAccount(), CallContext.current().getCallingUserId());
         }
@@ -119,7 +119,7 @@ public void execute() throws ConcurrentOperationException, ResourceUnavailableEx
             response.setResponseName(getCommandName());
             setResponseObject(response);
         } else {
-            throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to stop internal lb vm");
+            throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to stop Internal LB Instance");
         }
     }
 }
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateNetworkCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateNetworkCmdByAdmin.java
@@ -31,32 +31,32 @@
 
 import java.util.List;
 
-@APICommand(name = "createNetwork", description = "Creates a network", responseObject = NetworkResponse.class, responseView = ResponseView.Full, entityType = {Network.class},
+@APICommand(name = "createNetwork", description = "Creates a Network", responseObject = NetworkResponse.class, responseView = ResponseView.Full, entityType = {Network.class},
         requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
 public class CreateNetworkCmdByAdmin extends CreateNetworkCmd implements AdminCmd {
 
     @Parameter(name=ApiConstants.VLAN, type=CommandType.STRING, description = "The ID or VID of the network")
     private String vlan;
 
-    @Parameter(name=ApiConstants.BYPASS_VLAN_OVERLAP_CHECK, type=CommandType.BOOLEAN, description = "When true bypasses VLAN id/range overlap check during network creation for shared and L2 networks")
+    @Parameter(name=ApiConstants.BYPASS_VLAN_OVERLAP_CHECK, type=CommandType.BOOLEAN, description = "When true bypasses VLAN ID/range overlap check during Network creation for shared and L2 Networks")
     private Boolean bypassVlanOverlapCheck;
 
-    @Parameter(name=ApiConstants.HIDE_IP_ADDRESS_USAGE, type=CommandType.BOOLEAN, description = "When true ip address usage for the network will not be exported by the listUsageRecords API")
+    @Parameter(name=ApiConstants.HIDE_IP_ADDRESS_USAGE, type=CommandType.BOOLEAN, description = "When true IP address usage for the Network will not be exported by the listUsageRecords API")
     private Boolean hideIpAddressUsage;
 
-    @Parameter(name = ApiConstants.ROUTER_IP, type = CommandType.STRING, description = "IPV4 address to be assigned to a router in a shared network", since = "4.16",
+    @Parameter(name = ApiConstants.ROUTER_IP, type = CommandType.STRING, description = "IPv4 address to be assigned to a router in a shared Network", since = "4.16",
             validations = {ApiArgValidator.NotNullOrEmpty})
     private String routerIp;
 
-    @Parameter(name = ApiConstants.ROUTER_IPV6, type = CommandType.STRING, description = "IPV6 address to be assigned to a router in a shared network", since = "4.16",
+    @Parameter(name = ApiConstants.ROUTER_IPV6, type = CommandType.STRING, description = "IPv6 address to be assigned to a router in a shared Network", since = "4.16",
             validations = {ApiArgValidator.NotNullOrEmpty})
     private String routerIpv6;
 
     @Parameter(name = ApiConstants.BGP_PEER_IDS,
             type = CommandType.LIST,
             collectionType = CommandType.UUID,
             entityType = BgpPeerResponse.class,
-            description = "Ids of the Bgp Peer for the network",
+            description = "IDs of the Bgp Peer for the Network",
             since = "4.20.0")
     private List<Long> bgpPeerIds;
 
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateNetworkOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateNetworkOfferingCmd.java
@@ -83,7 +83,7 @@ public class CreateNetworkOfferingCmd extends BaseCmd {
     @Parameter(name = ApiConstants.TAGS, type = CommandType.STRING, description = "The tags for the network offering.", length = 4096)
     private String tags;
 
-    @Parameter(name = ApiConstants.SPECIFY_VLAN, type = CommandType.BOOLEAN, description = "True if network offering supports vlans")
+    @Parameter(name = ApiConstants.SPECIFY_VLAN, type = CommandType.BOOLEAN, description = "True if network offering supports VLANs")
     private Boolean specifyVlan;
 
     @Parameter(name = ApiConstants.AVAILABILITY, type = CommandType.STRING, description = "The availability of network offering. The default value is Optional. "
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreatePhysicalNetworkCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreatePhysicalNetworkCmd.java
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateStorageNetworkIpRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateStorageNetworkIpRangeCmd.java

Original file line number	Diff line number	Diff line change
`@@ -46,10 +46,10 @@ protected String getResponseName() {`
`46`	`46`	`@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, required = true, description = "The Template ID")`
`47`	`47`	`private Long id;`
`48`	`48`
`49`		`- @Parameter(name = ApiConstants.IS_FEATURED, type = CommandType.BOOLEAN, description = "True for featured Template/iso, false otherwise")`
	`49`	`+ @Parameter(name = ApiConstants.IS_FEATURED, type = CommandType.BOOLEAN, description = "True for featured Template/ISO, false otherwise")`
`50`	`50`	`private Boolean featured;`
`51`	`51`
`52`		`- @Parameter(name = ApiConstants.IS_PUBLIC, type = CommandType.BOOLEAN, description = "True for public Template/iso, false for private Templates/ISOs")`
	`52`	`+ @Parameter(name = ApiConstants.IS_PUBLIC, type = CommandType.BOOLEAN, description = "True for public Template/ISO, false for private Templates/ISOs")`
`53`	`53`	`private Boolean isPublic;`
`54`	`54`
`55`	`55`	`@Parameter(name = ApiConstants.IS_EXTRACTABLE,`
`@@ -121,7 +121,7 @@ public void execute() {`
`121`	`121`	`SuccessResponse response = new SuccessResponse(getCommandName());`
`122`	`122`	`setResponseObject(response);`
`123`	`123`	`} else {`
`124`		`- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update Template/iso permissions");`
	`124`	`+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update Template/ISO permissions");`
`125`	`125`	`}`
`126`	`126`	`}`
`127`	`127`	`}`
Original file line number	Diff line number	Diff line change
`@@ -108,7 +108,7 @@ public long getEntityOwnerId() {`
`108`	`108`
`109`	`109`	`@Override`
`110`	`110`	`public String getEventDescription() {`
`111`		`- return "Disabling account: " + getAccountName() + " in domain: " + getDomainId();`
	`111`	`+ return "Disabling Account: " + getAccountName() + " in domain: " + getDomainId();`
`112`	`112`	`}`
`113`	`113`
`114`	`114`	`@Override`