address comments; consistent API description

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

Author: shwstppr

api/src/main/java/org/apache/cloudstack/api/command/user/bootgroup/AddMemberToInstanceBootGroupCmd.java

@@ -37,7 +37,7 @@
 import org.apache.cloudstack.vm.bootgroup.InstanceBootGroupService;
 
 @APICommand(name = "addMemberToInstanceBootGroup",
-        description = "Adds a VM or instance group to an instance boot group. Exactly one of virtualmachineid or instancegroupid must be specified.",
+        description = "Adds an Instance or instance group to an instance boot group. Exactly one of virtualmachineid or instancegroupid must be specified.",
         responseObject = InstanceBootGroupMemberResponse.class,
         entityType = {InstanceBootGroupMember.class},
         requestHasSensitiveInfo = false,
@@ -51,15 +51,15 @@ public class AddMemberToInstanceBootGroupCmd extends BaseCmd implements UserCmd
     @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = InstanceBootGroupResponse.class, required = true, description = "The ID of the instance boot group")
     private Long id;
 
-    @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "The ID of the VM to add (exclusive with instancegroupid)")
+    @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "The ID of the Instance to add (exclusive with instancegroupid)")
     private Long virtualMachineId;
 
-    @Parameter(name = ApiConstants.INSTANCE_GROUP_ID, type = CommandType.UUID, entityType = InstanceGroupResponse.class, description = "The ID of the instance group to add (exclusive with virtualmachineid)")
+    @Parameter(name = ApiConstants.INSTANCE_GROUP_ID, type = CommandType.UUID, entityType = InstanceGroupResponse.class, description = "The ID of the Instance Group to add (exclusive with virtualmachineid)")
     private Long instanceGroupId;
 
     @Parameter(name = ApiConstants.BOOT_ORDER, type = CommandType.INTEGER, required = true,
             description = "The boot order value for this member (0 or greater; non-contiguous values are allowed). "
-                    + "Any existing member already at or past this value is shifted one slot later to make room.")
+                    + "Any existing member already at or past this value is shifted one slot later to make room")
     private int order;
 
     public Long getId() {

api/src/main/java/org/apache/cloudstack/api/command/user/bootgroup/CreateInstanceBootGroupCmd.java

@@ -36,7 +36,7 @@
 import org.apache.cloudstack.vm.bootgroup.InstanceBootGroupService;
 
 @APICommand(name = "createInstanceBootGroup",
-        description = "Creates an instance boot group",
+        description = "Creates an Instance Boot Group",
         responseObject = InstanceBootGroupResponse.class,
         entityType = {InstanceBootGroup.class},
         requestHasSensitiveInfo = false,
@@ -47,19 +47,19 @@ public class CreateInstanceBootGroupCmd extends BaseCmd implements UserCmd {
     @Inject
     InstanceBootGroupService instanceBootGroupService;
 
-    @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the instance boot group")
+    @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the Instance Boot Group")
     private String name;
 
-    @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "The description of the instance boot group")
+    @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "The description of the Instance Boot Group")
     private String description;
 
-    @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "The account of the instance boot group. Must be used with domainId.")
+    @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "The account of the Instance Boot Group. Must be used with domainid")
     private String accountName;
 
-    @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "The domain ID of the account owning the instance boot group")
+    @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "The domain ID of the account owning the Instance Boot Group")
     private Long domainId;
 
-    @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "The project of the instance boot group")
+    @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "The project of the Instance Boot Group")
     private Long projectId;
 
     @Parameter(name = ApiConstants.READINESS_ATTEMPT_TIMEOUT_SECONDS, type = CommandType.LONG,

api/src/main/java/org/apache/cloudstack/api/command/user/bootgroup/CreateInstanceBootGroupReadinessRuleCmd.java

@@ -40,8 +40,7 @@
 import org.apache.cloudstack.vm.bootgroup.InstanceBootGroupService;
 
 @APICommand(name = "createInstanceBootGroupReadinessRule",
-        description = "Creates a readiness rule for a VM or instance group that is a member (directly, or via its instance group) of an instance boot group. " +
-                "Exactly one of virtualmachineid or instancegroupid must be specified.",
+        description = "Creates a readiness rule for an Instance or Instance Group that is a member (directly, or via its instance group) of an Instance Boot Group",
         responseObject = InstanceBootGroupReadinessRuleResponse.class,
         entityType = {InstanceBootGroupReadinessRule.class},
         requestHasSensitiveInfo = false,
@@ -53,15 +52,15 @@ public class CreateInstanceBootGroupReadinessRuleCmd extends BaseCmd implements
     InstanceBootGroupService instanceBootGroupService;
 
     @Parameter(name = ApiConstants.BOOT_GROUP_ID, type = CommandType.UUID, entityType = InstanceBootGroupResponse.class, required = true,
-            description = "The ID of the boot group this rule belongs to")
+            description = "The ID of the Instance Boot Group this rule belongs to")
     private Long bootGroupId;
 
     @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class,
-            description = "The ID of the VM this rule applies to (exclusive with instancegroupid)")
+            description = "The ID of the Instance this rule applies to (exclusive with instancegroupid)")
     private Long virtualMachineId;
 
     @Parameter(name = ApiConstants.INSTANCE_GROUP_ID, type = CommandType.UUID, entityType = InstanceGroupResponse.class,
-            description = "The ID of the instance group this rule applies to (exclusive with virtualmachineid)")
+            description = "The ID of the Instance Group this rule applies to (exclusive with virtualmachineid)")
     private Long instanceGroupId;
 
     @Parameter(name = ApiConstants.RULE_TYPE, type = CommandType.STRING, required = true,

api/src/main/java/org/apache/cloudstack/api/command/user/bootgroup/DeleteInstanceBootGroupCmd.java

@@ -35,7 +35,7 @@
 import org.apache.cloudstack.vm.bootgroup.InstanceBootGroupService;
 
 @APICommand(name = "deleteInstanceBootGroup",
-        description = "Deletes an instance boot group",
+        description = "Deletes an Instance Boot Group",
         responseObject = SuccessResponse.class,
         entityType = {InstanceBootGroup.class},
         requestHasSensitiveInfo = false,
@@ -46,7 +46,7 @@ public class DeleteInstanceBootGroupCmd extends BaseCmd implements UserCmd {
     @Inject
     InstanceBootGroupService instanceBootGroupService;
 
-    @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = InstanceBootGroupResponse.class, required = true, description = "The ID of the instance boot group")
+    @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = InstanceBootGroupResponse.class, required = true, description = "The ID of the Instance Boot Group")
     private Long id;
 
     public Long getId() {

api/src/main/java/org/apache/cloudstack/api/command/user/bootgroup/DeleteInstanceBootGroupReadinessRuleCmd.java

@@ -35,7 +35,7 @@
 import org.apache.cloudstack.vm.bootgroup.InstanceBootGroupService;
 
 @APICommand(name = "deleteInstanceBootGroupReadinessRule",
-        description = "Deletes an instance boot group readiness rule",
+        description = "Deletes an Instance Boot Group readiness rule",
         responseObject = SuccessResponse.class,
         entityType = {InstanceBootGroupReadinessRule.class},
         requestHasSensitiveInfo = false,
@@ -47,7 +47,7 @@ public class DeleteInstanceBootGroupReadinessRuleCmd extends BaseCmd implements
     InstanceBootGroupService instanceBootGroupService;
 
     @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = InstanceBootGroupReadinessRuleResponse.class, required = true,
-            description = "The ID of the readiness rule")
+            description = "The ID of the Instance Boot Group readiness rule")
     private Long id;
 
     public Long getId() {

api/src/main/java/org/apache/cloudstack/api/command/user/bootgroup/ListInstanceBootGroupMembersCmd.java

@@ -36,7 +36,7 @@
 import org.apache.cloudstack.vm.bootgroup.InstanceBootGroupService;
 
 @APICommand(name = "listInstanceBootGroupMembers",
-        description = "Lists members of an instance boot group, sorted by boot order",
+        description = "Lists members of an Instance Boot Group, sorted by boot order",
         responseObject = InstanceBootGroupMemberResponse.class,
         entityType = {InstanceBootGroupMember.class},
         requestHasSensitiveInfo = false,
@@ -47,7 +47,7 @@ public class ListInstanceBootGroupMembersCmd extends BaseListCmd implements User
     @Inject
     InstanceBootGroupService instanceBootGroupService;
 
-    @Parameter(name = ApiConstants.BOOT_GROUP_ID, type = CommandType.UUID, required = true, entityType = InstanceBootGroupResponse.class, description = "The ID of the instance boot group")
+    @Parameter(name = ApiConstants.BOOT_GROUP_ID, type = CommandType.UUID, required = true, entityType = InstanceBootGroupResponse.class, description = "The ID of the Instance Boot Group")
     private Long bootGroupId;
 
     @Parameter(name = ApiConstants.MEMBER_TYPE, type = CommandType.STRING, description = "Filter by member type: VirtualMachine or InstanceGroup")
@@ -58,12 +58,12 @@ public class ListInstanceBootGroupMembersCmd extends BaseListCmd implements User
                collectionType = CommandType.STRING,
                description = "Comma separated list of additional details requested, value can be a list of [all, readiness, children]. "
                        + "Readiness fields are computed from cached check results (not a live re-check) and are omitted unless requested, since computing them is not free. "
-                       + "Children returns the member VMs of InstanceGroup-type members (omitted for VirtualMachine-type members); combine with readiness to also include per-child readiness.")
+                       + "Children returns the member Instances of InstanceGroup-type members (omitted for VirtualMachine-type members); combine with readiness to also include per-child readiness")
     private List<String> viewDetails;
 
     @Parameter(name = ApiConstants.IGNORE_INSTANCE_STATE, type = CommandType.BOOLEAN,
                description = "If true, readiness status/message reflect the last cached rule check regardless of the member's current instance state. "
-                       + "If false (default), a VM that isn't Running is always reported NotReady, even if its rules were last cached Ready.")
+                       + "If false (default), an Instance that isn't Running is always reported NotReady, even if its rules were last cached Ready")
     private Boolean ignoreInstanceState;
 
     public Long getBootGroupId() {

api/src/main/java/org/apache/cloudstack/api/command/user/bootgroup/ListInstanceBootGroupReadinessRulesCmd.java

@@ -34,7 +34,7 @@
 import org.apache.cloudstack.vm.bootgroup.InstanceBootGroupService;
 
 @APICommand(name = "listInstanceBootGroupReadinessRules",
-        description = "Lists readiness rules for an instance boot group",
+        description = "Lists readiness rules for an Instance Boot Group",
         responseObject = InstanceBootGroupReadinessRuleResponse.class,
         entityType = {InstanceBootGroupReadinessRule.class},
         requestHasSensitiveInfo = false,
@@ -46,16 +46,16 @@ public class ListInstanceBootGroupReadinessRulesCmd extends BaseListCmd implemen
     InstanceBootGroupService instanceBootGroupService;
 
     @Parameter(name = ApiConstants.BOOT_GROUP_ID, type = CommandType.UUID, entityType = InstanceBootGroupResponse.class, required = true,
-            description = "The ID of the instance boot group; listing is always scoped to one boot group")
+            description = "The ID of the Instance Boot Group; listing is always scoped to one boot group")
     private Long bootGroupId;
 
     @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = InstanceBootGroupReadinessRuleResponse.class, description = "List by readiness rule ID")
     private Long id;
 
-    @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "Narrow to this VM's rules")
+    @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "List rules for the Instance")
     private Long virtualMachineId;
 
-    @Parameter(name = ApiConstants.INSTANCE_GROUP_ID, type = CommandType.UUID, entityType = InstanceGroupResponse.class, description = "Narrow to this instance group's rules")
+    @Parameter(name = ApiConstants.INSTANCE_GROUP_ID, type = CommandType.UUID, entityType = InstanceGroupResponse.class, description = "List rules for the Instance Group")
     private Long instanceGroupId;
 
     @Parameter(name = ApiConstants.RULE_TYPE, type = CommandType.STRING, description = "Filter by readiness rule type")

api/src/main/java/org/apache/cloudstack/api/command/user/bootgroup/ListInstanceBootGroupsCmd.java

@@ -33,7 +33,7 @@
 import org.apache.cloudstack.vm.bootgroup.InstanceBootGroupService;
 
 @APICommand(name = "listInstanceBootGroups",
-        description = "Lists instance boot groups",
+        description = "Lists Instance Boot Groups",
         responseObject = InstanceBootGroupResponse.class,
         entityType = {InstanceBootGroup.class},
         requestHasSensitiveInfo = false,
@@ -44,16 +44,16 @@ public class ListInstanceBootGroupsCmd extends BaseListProjectAndAccountResource
     @Inject
     InstanceBootGroupService instanceBootGroupService;
 
-    @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = InstanceBootGroupResponse.class, description = "List instance boot groups by ID")
+    @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = InstanceBootGroupResponse.class, description = "List Instance Boot Group by ID")
     private Long id;
 
-    @Parameter(name = ApiConstants.KEYWORD, type = CommandType.STRING, description = "List instance boot groups by name keyword")
+    @Parameter(name = ApiConstants.KEYWORD, type = CommandType.STRING, description = "List Instance Boot Groups by name keyword")
     private String keyword;
 
-    @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "List boot groups that contain this VM")
+    @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "List Instance Boot Groups that contain the Instance")
     private Long virtualMachineId;
 
-    @Parameter(name = ApiConstants.INSTANCE_GROUP_ID, type = CommandType.UUID, entityType = InstanceGroupResponse.class, description = "List boot groups that contain this instance group")
+    @Parameter(name = ApiConstants.INSTANCE_GROUP_ID, type = CommandType.UUID, entityType = InstanceGroupResponse.class, description = "List Instance Boot Groups that contain the Instance Group")
     private Long instanceGroupId;
 
     public Long getId() {

api/src/main/java/org/apache/cloudstack/api/command/user/bootgroup/RebootInstanceBootGroupCmd.java

@@ -37,7 +37,7 @@
 import com.cloud.utils.exception.CloudRuntimeException;
 
 @APICommand(name = "rebootInstanceBootGroup",
-        description = "Reboots all VMs in an instance boot group: stops in reverse order then starts in forward order.",
+        description = "Reboots all VMs in an Instance Boot Group: stops in reverse order then starts in forward order",
         responseObject = InstanceBootGroupResponse.class,
         entityType = {InstanceBootGroup.class},
         requestHasSensitiveInfo = false,
@@ -48,11 +48,11 @@ public class RebootInstanceBootGroupCmd extends BaseAsyncCmd implements UserCmd
     @Inject
     InstanceBootGroupService instanceBootGroupService;
 
-    @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = InstanceBootGroupResponse.class, required = true, description = "The ID of the instance boot group")
+    @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = InstanceBootGroupResponse.class, required = true, description = "The ID of the Instance Boot Group")
     private Long id;
 
     @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN, required = false,
-            description = "Force stop every Instance in the instance boot group during the stop phase of the reboot (It is force-stopped and then started)")
+            description = "Whether to force stop every Instance in the Instance Boot Group during the stop phase of the reboot (It is force-stopped and then started)")
     private Boolean forced;
 
     public Long getId() {
@@ -75,7 +75,7 @@ public String getEventType() {
 
     @Override
     public String getEventDescription() {
-        return "Rebooting instance boot group with ID: " + getResourceUuid(ApiConstants.ID);
+        return "Rebooting Instance Boot Group with ID: " + getResourceUuid(ApiConstants.ID);
     }
 
     @Override

api/src/main/java/org/apache/cloudstack/api/command/user/bootgroup/RemoveInstanceBootGroupMemberCmd.java

@@ -35,7 +35,7 @@
 import org.apache.cloudstack.vm.bootgroup.InstanceBootGroupService;
 
 @APICommand(name = "removeInstanceBootGroupMember",
-        description = "Removes a member (VM or instance group) from an instance boot group",
+        description = "Removes a member from an Instance Boot Group",
         responseObject = SuccessResponse.class,
         entityType = {InstanceBootGroupMember.class},
         requestHasSensitiveInfo = false,
@@ -46,7 +46,7 @@ public class RemoveInstanceBootGroupMemberCmd extends BaseCmd implements UserCmd
     @Inject
     InstanceBootGroupService instanceBootGroupService;
 
-    @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = InstanceBootGroupMemberResponse.class, required = true, description = "The ID of the boot group member entry to remove")
+    @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = InstanceBootGroupMemberResponse.class, required = true, description = "The ID of the Instance Boot Group member to remove")
     private Long id;
 
     public Long getId() {