sureshanaparti opened a new pull request, #12467: URL: https://github.com/apache/cloudstack/pull/12467
### Description This PR improves the API docs/generation and has some code improvements/cleanup. - Since release added to the API, Request and Response parameters. - Categories list (`known_categories`) updated to 185 elements (from 228 elements), reduces the docs generation time. - Add new Categories - OpenDaylight Controller, Cisco Nexus VSM, Elastistor (same as existing Tungsten, NSX, Netris) - Update Category 'Misc Network Service Providers' to 'Stratosphere SSP' - Removed Category 'Import VM Task', API _listImportVmTasks_ moved to 'Virtual Machine' Category (same as other related APIs _importVm_, _importUnmanagedInstance_) - Removed Category 'Pool', 'Misc' - APIs _listElastistorPool_, _listElastistorInterface_ moved to 'Elastistor' Category and API _listVsphereStoragePolicyCompatiblePools_ moved to 'vSphere Storage Policies' Category. - Removed Category 'Limit' - API _updateResourceCount_ moved to 'Resource Limit' Category. - Cleanup un-used methods / files. <!--- Describe your changes in DETAIL - And how has behaviour functionally changed. --> <!-- For new features, provide link to FS, dev ML discussion etc. --> <!-- In case of bug fix, the expected and actual behaviours, steps to reproduce. --> <!-- When "Fixes: #<id>" is specified, the issue/PR will automatically be closed when this PR gets merged --> <!-- For addressing multiple issues/PRs, use multiple "Fixes: #<id>" --> <!-- Fixes: # --> <!--- ******************************************************************************* --> <!--- NOTE: AUTOMATION USES THE DESCRIPTIONS TO SET LABELS AND PRODUCE DOCUMENTATION. --> <!--- PLEASE PUT AN 'X' in only **ONE** box --> <!--- ******************************************************************************* --> ### 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) - [x] Enhancement (improves an existing feature and functionality) - [x] Cleanup (Code refactoring and cleanup, that may add test cases) - [ ] Build/CI - [ ] Test (unit or integration test code) ### Feature/Enhancement Scale or Bug Severity #### Feature/Enhancement Scale - [ ] Major - [x] Minor #### Bug Severity - [ ] BLOCKER - [ ] Critical - [ ] Major - [ ] Minor - [ ] Trivial ### Screenshots (if appropriate): Current API docs: https://cloudstack.apache.org/api/apidocs-4.22/ New API docs: [CloudStack API Reference - Updated.pdf](https://github.com/user-attachments/files/24720328/CloudStack.API.Reference.-.Updated.pdf) updateVirtualMachine API => <img width="954" height="768" alt="updateVirtualMachine_API" src="https://github.com/user-attachments/assets/18c938d3-281c-4c73-92e3-3d2c444697fc"; /> <img width="933" height="761" alt="updateVirtualMachine_API_Response" src="https://github.com/user-attachments/assets/7ea29693-9b63-4b1d-9e97-9072d5b68bba"; /> migrateVirtualMachine API => <img width="1006" height="774" alt="migrateVirtualMachine_API" src="https://github.com/user-attachments/assets/b23a6c7a-7662-4136-bbd2-3747aca109c7"; /> unmanageVirtualMachine API => <img width="970" height="547" alt="unmanageVirtualMachine_API" src="https://github.com/user-attachments/assets/0844a5f1-98f9-476a-99b6-59ef36819441"; /> ### How Has This Been Tested? <!-- Please describe in detail how you tested your changes. --> <!-- Include details of your testing environment, and the tests you ran to --> #### How did you try to break this feature and the system with this change? <!-- see how your change affects other areas of the code, etc. --> <!-- Please read the [CONTRIBUTING](https://github.com/apache/cloudstack/blob/main/CONTRIBUTING.md) document --> -- 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]
