ezntt opened a new pull request, #7022:
URL: https://github.com/apache/cloudstack/pull/7022
### Description
It was noticed that the APIs (most of them) follow a pattern in which the
*response name* equals to `APINAME.toLowerCase() + 'response'`, which is the
value returned by `getCommandName` method.
Therefore, I am proposing the removal of the different repeated
`getCommandName` instructions throughout the APIs. Additionally, it also
removed API name/_response name_ declarations from the affected classes; the
API name values were moved to the `name` parameter in `@APICommand`.
To help me in the process of normalizing the code base, I created a script
that iterates through the APIs using the existing method in class
`ApiXmlDocWriter`. The number of APIs that did not follow the standard is 88,
so they weren't changed, and they can be seen in the collapse below with their
respective _response name_ and how they would be if they were in the majority
standard:
<details><summary>Unchanged APIs</summary>
<p>
```
1. Class org.apache.cloudstack.api.command.LdapCreateAccountCmd unchanged.
actual response name - createaccountresponse
expected response name - ldapcreateaccountresponse
2. Class org.apache.cloudstack.api.command.admin.iso.CopyIsoCmdByAdmin
unchanged.
actual response name - copytemplateresponse
expected response name - copyisoresponse
3. Class org.apache.cloudstack.api.command.LdapImportUsersCmd unchanged.
actual response name - ldapuserresponse
expected response name - importldapusersresponse
4. Class org.apache.cloudstack.storage.datastore.util.ListElastistorPoolCmd
unchanged.
actual response name - listElastistorPoolResponse
expected response name - listelastistorpoolresponse
5. Class com.cloud.api.commands.ListSrxFirewallsCmd unchanged.
actual response name - listsrxfirewallresponse
expected response name - listsrxfirewallsresponse
6. Class org.apache.cloudstack.api.command.admin.vm.RestoreVMCmdByAdmin
unchanged.
actual response name - restorevmresponse
expected response name - restorevirtualmachineresponse
7. Class org.apache.cloudstack.api.ListUcsBladeCmd unchanged.
actual response name - listucsbladeresponse
expected response name - listucsbladesresponse
8. Class org.apache.cloudstack.api.BaremetalProvisionDoneNotificationCmd
unchanged.
actual response name - baremetalprovisiondone
expected response name - notifybaremetalprovisiondoneresponse
9. Class com.cloud.api.commands.DeleteServicePackageOfferingCmd unchanged.
actual response name - deleteServicePackage
expected response name - deleteservicepackageofferingresponse
10. Class org.apache.cloudstack.api.command.admin.systemvm.ScaleSystemVMCmd
unchanged.
actual response name - changeserviceforsystemvmresponse
expected response name - scalesystemvmresponse
11. Class org.apache.cloudstack.api.command.LdapListConfigurationCmd
unchanged.
actual response name - ldapconfigurationresponse
expected response name - listldapconfigurationsresponse
12. Class
org.apache.cloudstack.api.command.admin.storage.ListSecondaryStagingStoresCmd
unchanged.
actual response name - listsecondarystagingstoreresponse
expected response name - listsecondarystagingstoresresponse
13. Class
org.apache.cloudstack.api.command.user.autoscale.CreateAutoScalePolicyCmd
unchanged.
actual response name - autoscalepolicyresponse
expected response name - createautoscalepolicyresponse
14. Class org.apache.cloudstack.api.commands.DeleteSspCmd unchanged.
actual response name - deleteStratosphereSsp
expected response name - deletestratospheresspresponse
15. Class
org.apache.cloudstack.api.command.admin.resource.CleanVMReservationsCmd
unchanged.
actual response name - cleanvmreservationresponse
expected response name - cleanvmreservationsresponse
16. Class
org.apache.cloudstack.storage.datastore.util.ListElastistorInterfaceCmd
unchanged.
actual response name - listElastistorInterfaceResponse
expected response name - listelastistorinterfaceresponse
17. Class
org.apache.cloudstack.api.command.admin.internallb.StartInternalLBVMCmd
unchanged.
actual response name - startinternallbvmresponse
expected response name - startinternalloadbalancervmresponse
18. Class org.apache.cloudstack.api.command.LdapUserSearchCmd unchanged.
actual response name - ldapuserresponse
expected response name - searchldapresponse
19. Class
org.apache.cloudstack.api.command.user.autoscale.CreateAutoScaleVmGroupCmd
unchanged.
actual response name - autoscalevmgroupresponse
expected response name - createautoscalevmgroupresponse
20. Class org.apache.cloudstack.api.AddBaremetalPxePingServerCmd unchanged.
actual response name - addbaremetalpxeresponse
expected response name - addbaremetalpxepingserverresponse
21. Class
org.apache.cloudstack.api.command.admin.region.ListPortableIpRangesCmd
unchanged.
actual response name - listportableipresponse
expected response name - listportableiprangesresponse
22. Class org.apache.cloudstack.api.command.user.vm.AddIpToVmNicCmd
unchanged.
actual response name - addiptovmnicresponse
expected response name - addiptonicresponse
23. Class com.cloud.api.commands.StopNetScalerVMCmd unchanged.
actual response name - stopNetScalerVmresponse
expected response name - stopnetscalervpxresponse
24. Class org.apache.cloudstack.api.DeleteUcsManagerCmd unchanged.
actual response name - deleteUcsManagerResponse
expected response name - deleteucsmanagerresponse
25. Class
org.apache.cloudstack.api.command.user.autoscale.DisableAutoScaleVmGroupCmd
unchanged.
actual response name - disableautoscalevmGroupresponse
expected response name - disableautoscalevmgroupresponse
26. Class com.cloud.api.commands.AddCiscoVnmcResourceCmd unchanged.
actual response name - addCiscoVnmcResource
expected response name - addciscovnmcresourceresponse
27. Class org.apache.cloudstack.api.command.LdapListUsersCmd unchanged.
actual response name - ldapuserresponse
expected response name - listldapusersresponse
28. Class org.apache.cloudstack.api.command.GetServiceProviderMetaDataCmd
unchanged.
actual response name - spmetadataresponse
expected response name - getspmetadataresponse
29. Class
org.apache.cloudstack.network.opendaylight.api.commands.ListOpenDaylightControllersCmd
unchanged.
actual response name - listOpenDaylightControllers
expected response name - listopendaylightcontrollersresponse
30. Class
org.apache.cloudstack.api.command.admin.storage.UpdateImageStoreCmd unchanged.
actual response name - updateImageStore
expected response name - updateimagestoreresponse
31. Class com.cloud.api.commands.DeleteCiscoVnmcResourceCmd unchanged.
actual response name - deleteCiscoVnmcResource
expected response name - deleteciscovnmcresourceresponse
32. Class
org.apache.cloudstack.api.command.admin.internallb.StopInternalLBVMCmd
unchanged.
actual response name - stopinternallbvmresponse
expected response name - stopinternalloadbalancervmresponse
33. Class org.apache.cloudstack.api.command.SAML2LoginAPIAuthenticatorCmd
unchanged.
actual response name - loginresponse
expected response name - samlssoresponse
34. Class com.cloud.api.commands.ListNiciraNvpDeviceNetworksCmd unchanged.
actual response name - listniciranvpdevicenetworks
expected response name - listniciranvpdevicenetworksresponse
35. Class com.cloud.api.commands.ListNetscalerControlCenterCmd unchanged.
actual response name - listNetscalerControlCenter
expected response name - listnetscalercontrolcenterresponse
36. Class
org.apache.cloudstack.api.command.admin.network.ListNetworkDeviceCmd unchanged.
actual response name - listnetworkdevice
expected response name - listnetworkdeviceresponse
37. Class
org.apache.cloudstack.network.opendaylight.api.commands.DeleteOpenDaylightControllerCmd
unchanged.
actual response name - deleteOpenDaylightController
expected response name - deleteopendaylightcontrollerresponse
38. Class org.apache.cloudstack.api.ListUcsManagerCmd unchanged.
actual response name - listucsmanagerreponse
expected response name - listucsmanagersresponse
39. Class org.apache.cloudstack.api.command.LdapDeleteConfigurationCmd
unchanged.
actual response name - ldapconfigurationresponse
expected response name - deleteldapconfigurationresponse
40. Class org.apache.cloudstack.api.command.user.snapshot.ArchiveSnapshotCmd
unchanged.
actual response name - createsnapshotresponse
expected response name - archivesnapshotresponse
41. Class
org.apache.cloudstack.api.command.admin.address.AcquirePodIpCmdByAdmin
unchanged.
actual response name - acquirepodipaddress
expected response name - acquirepodipaddressresponse
42. Class com.cloud.api.commands.ListBrocadeVcsDevicesCmd unchanged.
actual response name - listbrocadevcsdeviceresponse
expected response name - listbrocadevcsdevicesresponse
43. Class org.apache.cloudstack.api.command.admin.vm.ResetVMSSHKeyCmdByAdmin
unchanged.
actual response name - resetSSHKeyforvirtualmachineresponse
expected response name - resetsshkeyforvirtualmachineresponse
44. Class
org.apache.cloudstack.api.command.admin.internallb.ListInternalLBVMsCmd
unchanged.
actual response name - listinternallbvmsresponse
expected response name - listinternalloadbalancervmsresponse
45. Class com.cloud.api.commands.ListCiscoVnmcResourcesCmd unchanged.
actual response name - listCiscoVnmcResources
expected response name - listciscovnmcresourcesresponse
46. Class
org.apache.cloudstack.api.command.user.volume.GetUploadParamsForVolumeCmd
unchanged.
actual response name - postuploadvolumeresponse
expected response name - getuploadparamsforvolumeresponse
47. Class
org.apache.cloudstack.api.command.user.autoscale.EnableAutoScaleVmGroupCmd
unchanged.
actual response name - enableautoscalevmGroupresponse
expected response name - enableautoscalevmgroupresponse
48. Class com.cloud.api.commands.DeleteCiscoAsa1000vResourceCmd unchanged.
actual response name - deleteCiscoAsa1000vResource
expected response name - deleteciscoasa1000vresourceresponse
49. Class org.apache.cloudstack.api.ListUcsProfileCmd unchanged.
actual response name - listucsprofileresponse
expected response name - listucsprofilesresponse
50. Class
org.apache.cloudstack.api.command.user.autoscale.CreateConditionCmd unchanged.
actual response name - conditionresponse
expected response name - createconditionresponse
51. Class com.cloud.api.commands.ListCiscoAsa1000vResourcesCmd unchanged.
actual response name - listCiscoAsa1000vResources
expected response name - listciscoasa1000vresourcesresponse
52. Class com.cloud.api.commands.DeployNetscalerVpxCmd unchanged.
actual response name - deployNetscalerVpx
expected response name - deploynetscalervpxresponse
53. Class
org.apache.cloudstack.storage.datastore.util.ListElastistorVolumeCmd unchanged.
actual response name - listElastistorVolumeResponse
expected response name - listelastistorvolumeresponse
54. Class
org.apache.cloudstack.api.command.admin.region.DeletePortableIpRangeCmd
unchanged.
actual response name - deleteportablepublicipresponse
expected response name - deleteportableiprangeresponse
55. Class com.cloud.api.commands.ListNiciraNvpDevicesCmd unchanged.
actual response name - listniciranvpdeviceresponse
expected response name - listniciranvpdevicesresponse
56. Class org.apache.cloudstack.api.AddBaremetalKickStartPxeCmd unchanged.
actual response name - addbaremetalpxeresponse
expected response name - addbaremetalpxekickstartserverresponse
57. Class
org.apache.cloudstack.api.command.user.loadbalancer.DeleteLBStickinessPolicyCmd
unchanged.
actual response name - deleteLBstickinessrruleresponse
expected response name - deletelbstickinesspolicyresponse
58. Class
org.apache.cloudstack.api.command.admin.affinitygroup.UpdateVMAffinityGroupCmdByAdmin
unchanged.
actual response name - updatevirtualmachineresponse
expected response name - updatevmaffinitygroupresponse
59. Class com.cloud.api.commands.RegisterServicePackageCmd unchanged.
actual response name - registerNetscalerServicePackage
expected response name - registernetscalerservicepackageresponse
60. Class org.apache.cloudstack.api.command.SAML2LogoutAPIAuthenticatorCmd
unchanged.
actual response name - logoutresponse
expected response name - samlsloresponse
61. Class org.apache.cloudstack.api.command.LdapAddConfigurationCmd
unchanged.
actual response name - ldapconfigurationresponse
expected response name - addldapconfigurationresponse
62. Class com.cloud.api.commands.ListBigSwitchBcfDevicesCmd unchanged.
actual response name - listbigswitchbcfdeviceresponse
expected response name - listbigswitchbcfdevicesresponse
63. Class com.cloud.api.commands.ListRegisteredServicePackageCmd unchanged.
actual response name - listregisteredservicepackage
expected response name - listregisteredservicepackagesresponse
64. Class
org.apache.cloudstack.api.command.user.template.GetUploadParamsForTemplateCmd
unchanged.
actual response name - postuploadtemplateresponse
expected response name - getuploadparamsfortemplateresponse
65. Class org.apache.cloudstack.api.command.user.autoscale.ListCountersCmd
unchanged.
actual response name - counterresponse
expected response name - listcountersresponse
66. Class
org.apache.cloudstack.api.command.user.loadbalancer.CreateLBStickinessPolicyCmd
unchanged.
actual response name - createLBStickinessPolicy
expected response name - createlbstickinesspolicyresponse
67. Class com.cloud.api.commands.AddCiscoAsa1000vResourceCmd unchanged.
actual response name - addCiscoAsa1000vResource
expected response name - addciscoasa1000vresourceresponse
68. Class
org.apache.cloudstack.api.command.user.network.UpdateNetworkACLItemCmd
unchanged.
actual response name - createnetworkaclresponse
expected response name - updatenetworkaclitemresponse
69. Class com.cloud.api.commands.ListBrocadeVcsDeviceNetworksCmd unchanged.
actual response name - listbrocadevcsdevicenetworks
expected response name - listbrocadevcsdevicenetworksresponse
70. Class com.cloud.api.commands.DeleteNetscalerControlCenterCmd unchanged.
actual response name - deleteNetscalerControlCenter
expected response name - deletenetscalercontrolcenterresponse
71. Class org.apache.cloudstack.api.commands.AddSspCmd unchanged.
actual response name - addStratosphereSsp
expected response name - addstratospheresspresponse
72. Class
org.apache.cloudstack.network.opendaylight.api.commands.AddOpenDaylightControllerCmd
unchanged.
actual response name - addOpenDaylightController
expected response name - addopendaylightcontrollerresponse
73. Class org.apache.cloudstack.api.command.admin.storage.AddImageStoreS3CMD
unchanged.
actual response name - addImageStoreS3Response
expected response name - addimagestores3response
74. Class
org.apache.cloudstack.api.command.user.network.MoveNetworkAclItemCmd unchanged.
actual response name - moveNetworkAclItemResponse
expected response name - movenetworkaclitemresponse
75. Class
org.apache.cloudstack.api.command.admin.storage.PreparePrimaryStorageForMaintenanceCmd
unchanged.
actual response name - prepareprimarystorageformaintenanceresponse
expected response name - enablestoragemaintenanceresponse
76. Class
org.apache.cloudstack.api.command.admin.storage.CancelPrimaryStorageMaintenanceCmd
unchanged.
actual response name - cancelprimarystoragemaintenanceresponse
expected response name - cancelstoragemaintenanceresponse
77. Class org.apache.cloudstack.api.command.admin.autoscale.CreateCounterCmd
unchanged.
actual response name - counterresponse
expected response name - createcounterresponse
78. Class org.apache.cloudstack.api.command.user.project.ActivateProjectCmd
unchanged.
actual response name - activaterojectresponse
expected response name - activateprojectresponse
79. Class
org.apache.cloudstack.api.command.user.iso.GetUploadParamsForIsoCmd unchanged.
actual response name - postuploadisoresponse
expected response name - getuploadparamsforisoresponse
80. Class com.cloud.api.commands.ListPaloAltoFirewallsCmd unchanged.
actual response name - listpaloaltofirewallresponse
expected response name - listpaloaltofirewallsresponse
81. Class
org.apache.cloudstack.api.command.user.autoscale.CreateAutoScaleVmProfileCmd
unchanged.
actual response name - autoscalevmprofileresponse
expected response name - createautoscalevmprofileresponse
82. Class org.apache.cloudstack.api.AddUcsManagerCmd unchanged.
actual response name - addUcsManagerResponse
expected response name - adducsmanagerresponse
83. Class com.cloud.api.commands.ListNetscalerLoadBalancersCmd unchanged.
actual response name - listnetscalerloadbalancerresponse
expected response name - listnetscalerloadbalancersresponse
84. Class
org.apache.cloudstack.api.command.admin.iso.ListIsoPermissionsCmdByAdmin
unchanged.
actual response name - listtemplatepermissionsresponse
expected response name - listisopermissionsresponse
85. Class com.cloud.api.commands.ListCiscoNexusVSMsCmd unchanged.
actual response name - listcisconexusvsmscmdresponse
expected response name - listcisconexusvsmsresponse
86. Class
org.apache.cloudstack.api.command.admin.address.ReleasePodIpCmdByAdmin
unchanged.
actual response name - releasepodipresponse
expected response name - releasepodipaddressresponse
87. Class org.apache.cloudstack.api.command.ListSamlAuthorizationCmd
unchanged.
actual response name - listsamlauthorizationsresponse
expected response name - listsamlauthorizationresponse
88. Class
org.apache.cloudstack.api.command.user.region.ha.gslb.RemoveFromGlobalLoadBalancerRuleCmd
unchanged.
actual response name - removefromloadbalancerruleresponse
expected response name - removefromgloballoadbalancerruleresponse
Total of APIs verified: 693.
Total of unchanged APIs: 88.
```
</p>
</details>
### Types of changes
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] Enhancement (improves an existing feature and functionality)
- [x] Cleanup (Code refactoring and cleanup, that may add test cases)
### How Has This Been Tested?
After the changes, I've built the project locally and succeeded.
--
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]
