rajujith commented on code in PR #7857:
URL: https://github.com/apache/cloudstack/pull/7857#discussion_r2332125957
##########
api/src/main/java/org/apache/cloudstack/api/response/NetworkResponse.java:
##########
@@ -144,179 +144,179 @@ public class NetworkResponse extends
BaseResponseWithAssociatedNetwork implement
private Long asNumber;
@SerializedName(ApiConstants.ACL_TYPE)
- @Param(description = "acl type - access type to the network")
+ @Param(description = "ACL type - access type to the Network")
private String aclType;
@SerializedName(ApiConstants.SUBDOMAIN_ACCESS)
- @Param(description = "true if users from subdomains can access the domain
level network")
+ @Param(description = "True if users from subdomains can access the domain
level Network")
private Boolean subdomainAccess;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the owner of the network")
+ @Param(description = "The owner of the Network")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the ipaddress")
+ @Param(description = "The project id of the IP address")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the address")
+ @Param(description = "The project name of the address")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain id of the network owner")
+ @Param(description = "The domain id of the Network owner")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the network owner")
+ @Param(description = "The domain name of the Network owner")
private String domain;
@SerializedName(ApiConstants.DOMAIN_PATH)
@Param(description = "path of the Domain the network belongs to", since =
"4.19.0.0")
private String domainPath;
@SerializedName("isdefault")
- @Param(description = "true if network is default, false otherwise")
+ @Param(description = "True if Network is default, false otherwise")
private Boolean isDefault;
@SerializedName("service")
- @Param(description = "the list of services", responseObject =
ServiceResponse.class)
+ @Param(description = "The list of services", responseObject =
ServiceResponse.class)
private List<ServiceResponse> services;
@SerializedName(ApiConstants.NETWORK_DOMAIN)
- @Param(description = "the network domain")
+ @Param(description = "The Network domain")
private String networkDomain;
@SerializedName(ApiConstants.PHYSICAL_NETWORK_ID)
- @Param(description = "the physical network id")
+ @Param(description = "The physical Network id")
private String physicalNetworkId;
@SerializedName(ApiConstants.RESTART_REQUIRED)
- @Param(description = "true network requires restart")
+ @Param(description = "True if Network requires restart")
private Boolean restartRequired;
@SerializedName(ApiConstants.SPECIFY_VLAN)
@Param(description = "true if network supports specifying vlan, false
otherwise")
private Boolean specifyVlan;
@SerializedName(ApiConstants.SPECIFY_IP_RANGES)
- @Param(description = "true if network supports specifying ip ranges, false
otherwise")
+ @Param(description = "True if Network supports specifying IP ranges, false
otherwise")
private Boolean specifyIpRanges;
@SerializedName(ApiConstants.VPC_ID)
- @Param(description = "VPC the network belongs to")
+ @Param(description = "VPC the Network belongs to")
private String vpcId;
@SerializedName(ApiConstants.VPC_NAME)
- @Param(description = "Name of the VPC to which this network belongs",
since = "4.15")
+ @Param(description = "Name of the VPC to which this Network belongs",
since = "4.15")
private String vpcName;
@SerializedName(ApiConstants.TUNGSTEN_VIRTUAL_ROUTER_UUID)
- @Param(description = "Tungsten-Fabric virtual router the network belongs
to")
+ @Param(description = "Tungsten-Fabric virtual router the Network belongs
to")
private String tungstenVirtualRouterUuid;
@SerializedName(ApiConstants.CAN_USE_FOR_DEPLOY)
- @Param(description = "list networks available for vm deployment")
+ @Param(description = "List Networks available for Instance deployment")
private Boolean canUseForDeploy;
@SerializedName(ApiConstants.IS_PERSISTENT)
- @Param(description = "list networks that are persistent")
+ @Param(description = "List Networks that are persistent")
private Boolean isPersistent;
@SerializedName(ApiConstants.TAGS)
- @Param(description = "the list of resource tags associated with network",
responseObject = ResourceTagResponse.class)
+ @Param(description = "The list of resource tags associated with Network",
responseObject = ResourceTagResponse.class)
private List<ResourceTagResponse> tags;
@SerializedName(ApiConstants.DETAILS)
- @Param(description = "the details of the network")
+ @Param(description = "The details of the Network")
private Map<String, String> details;
@SerializedName(ApiConstants.IP6_GATEWAY)
- @Param(description = "the gateway of IPv6 network")
+ @Param(description = "The gateway of IPv6 Network")
private String ip6Gateway;
@SerializedName(ApiConstants.IP6_CIDR)
- @Param(description = "the cidr of IPv6 network")
+ @Param(description = "The CIDR of IPv6 Network")
private String ip6Cidr;
@SerializedName(ApiConstants.DISPLAY_NETWORK)
- @Param(description = "an optional field, whether to the display the
network to the end user or not.", authorized = {RoleType.Admin})
+ @Param(description = "An optional field, whether to the display the
Network to the end user or not.", authorized = {RoleType.Admin})
private Boolean displayNetwork;
@SerializedName(ApiConstants.ACL_ID)
- @Param(description = "ACL Id associated with the VPC network")
+ @Param(description = "ACL Id associated with the VPC Network")
Review Comment:
'ID'
##########
api/src/main/java/org/apache/cloudstack/api/response/NetworkResponse.java:
##########
@@ -144,179 +144,179 @@ public class NetworkResponse extends
BaseResponseWithAssociatedNetwork implement
private Long asNumber;
@SerializedName(ApiConstants.ACL_TYPE)
- @Param(description = "acl type - access type to the network")
+ @Param(description = "ACL type - access type to the Network")
private String aclType;
@SerializedName(ApiConstants.SUBDOMAIN_ACCESS)
- @Param(description = "true if users from subdomains can access the domain
level network")
+ @Param(description = "True if users from subdomains can access the domain
level Network")
private Boolean subdomainAccess;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the owner of the network")
+ @Param(description = "The owner of the Network")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the ipaddress")
+ @Param(description = "The project id of the IP address")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the address")
+ @Param(description = "The project name of the address")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain id of the network owner")
+ @Param(description = "The domain id of the Network owner")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the network owner")
+ @Param(description = "The domain name of the Network owner")
private String domain;
@SerializedName(ApiConstants.DOMAIN_PATH)
@Param(description = "path of the Domain the network belongs to", since =
"4.19.0.0")
private String domainPath;
@SerializedName("isdefault")
- @Param(description = "true if network is default, false otherwise")
+ @Param(description = "True if Network is default, false otherwise")
private Boolean isDefault;
@SerializedName("service")
- @Param(description = "the list of services", responseObject =
ServiceResponse.class)
+ @Param(description = "The list of services", responseObject =
ServiceResponse.class)
private List<ServiceResponse> services;
@SerializedName(ApiConstants.NETWORK_DOMAIN)
- @Param(description = "the network domain")
+ @Param(description = "The Network domain")
private String networkDomain;
@SerializedName(ApiConstants.PHYSICAL_NETWORK_ID)
- @Param(description = "the physical network id")
+ @Param(description = "The physical Network id")
private String physicalNetworkId;
@SerializedName(ApiConstants.RESTART_REQUIRED)
- @Param(description = "true network requires restart")
+ @Param(description = "True if Network requires restart")
private Boolean restartRequired;
@SerializedName(ApiConstants.SPECIFY_VLAN)
@Param(description = "true if network supports specifying vlan, false
otherwise")
private Boolean specifyVlan;
@SerializedName(ApiConstants.SPECIFY_IP_RANGES)
- @Param(description = "true if network supports specifying ip ranges, false
otherwise")
+ @Param(description = "True if Network supports specifying IP ranges, false
otherwise")
private Boolean specifyIpRanges;
@SerializedName(ApiConstants.VPC_ID)
- @Param(description = "VPC the network belongs to")
+ @Param(description = "VPC the Network belongs to")
private String vpcId;
@SerializedName(ApiConstants.VPC_NAME)
- @Param(description = "Name of the VPC to which this network belongs",
since = "4.15")
+ @Param(description = "Name of the VPC to which this Network belongs",
since = "4.15")
private String vpcName;
@SerializedName(ApiConstants.TUNGSTEN_VIRTUAL_ROUTER_UUID)
- @Param(description = "Tungsten-Fabric virtual router the network belongs
to")
+ @Param(description = "Tungsten-Fabric virtual router the Network belongs
to")
private String tungstenVirtualRouterUuid;
@SerializedName(ApiConstants.CAN_USE_FOR_DEPLOY)
- @Param(description = "list networks available for vm deployment")
+ @Param(description = "List Networks available for Instance deployment")
private Boolean canUseForDeploy;
@SerializedName(ApiConstants.IS_PERSISTENT)
- @Param(description = "list networks that are persistent")
+ @Param(description = "List Networks that are persistent")
private Boolean isPersistent;
@SerializedName(ApiConstants.TAGS)
- @Param(description = "the list of resource tags associated with network",
responseObject = ResourceTagResponse.class)
+ @Param(description = "The list of resource tags associated with Network",
responseObject = ResourceTagResponse.class)
private List<ResourceTagResponse> tags;
@SerializedName(ApiConstants.DETAILS)
- @Param(description = "the details of the network")
+ @Param(description = "The details of the Network")
private Map<String, String> details;
@SerializedName(ApiConstants.IP6_GATEWAY)
- @Param(description = "the gateway of IPv6 network")
+ @Param(description = "The gateway of IPv6 Network")
private String ip6Gateway;
@SerializedName(ApiConstants.IP6_CIDR)
- @Param(description = "the cidr of IPv6 network")
+ @Param(description = "The CIDR of IPv6 Network")
private String ip6Cidr;
@SerializedName(ApiConstants.DISPLAY_NETWORK)
- @Param(description = "an optional field, whether to the display the
network to the end user or not.", authorized = {RoleType.Admin})
+ @Param(description = "An optional field, whether to the display the
Network to the end user or not.", authorized = {RoleType.Admin})
private Boolean displayNetwork;
@SerializedName(ApiConstants.ACL_ID)
- @Param(description = "ACL Id associated with the VPC network")
+ @Param(description = "ACL Id associated with the VPC Network")
private String aclId;
@SerializedName(ApiConstants.ACL_NAME)
- @Param(description = "ACL name associated with the VPC network")
+ @Param(description = "ACL name associated with the VPC Network")
private String aclName;
@SerializedName(ApiConstants.STRECHED_L2_SUBNET)
- @Param(description = "true if network can span multiple zones", since =
"4.4")
+ @Param(description = "True if Network can span multiple zones", since =
"4.4")
private Boolean strechedL2Subnet;
@SerializedName(ApiConstants.NETWORK_SPANNED_ZONES)
- @Param(description = "If a network is enabled for 'streched l2 subnet'
then represents zones on which network currently spans", since = "4.4")
+ @Param(description = "If a Network is enabled for 'stretched L2 subnet'
then represents zones on which Network currently spans", since = "4.4")
private Set<String> networkSpannedZones;
@SerializedName(ApiConstants.EXTERNAL_ID)
- @Param(description = "The external id of the network", since = "4.11")
+ @Param(description = "The external id of the Network", since = "4.11")
Review Comment:
'ID'
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
