API docs/generation improvements #12467
Open
+108
−501
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Proper category alignments during API docs generation - Since attribute for API, Request & Response parameters - Code improvements/cleanup
boring-cyborg
bot
added
component:api
component:networking
Python
Contributor
Author
|
@blueorangutan package |
|
@sureshanaparti a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress. |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #12467 +/- ##
=========================================
Coverage 17.84% 17.85%
Complexity 15983 15983
=========================================
Files 5929 5929
Lines 531084 531039 -45
Branches 64914 64909 -5
=========================================
Hits 94795 94795
+ Misses 425675 425630 -45
Partials 10614 10614
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
sureshanaparti
force-pushed
the
api-docs-improvements
branch
from
fb010ac to
5482fdf
Compare
|
Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✖️ debian ✔️ suse15. SL-JID 16428 |
|
Contributor
|
thnx @sureshanaparti , looks good and I’ll give it a test swing. Does this not apply to v20 and 22 as well? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 overall docs generation time.Re-mapped APIs to proper category. (Eg. changeBgpPeersForNetwork to 'BGP Peer, listVsphereStoragePolicyCompatiblePools to vSphere Storage Policies, listStorageTags to Storage Pool)
Add new Categories (same as existing Tungsten, NSX, Netris)
Update Category
Removed Categories
(with this changes, total 104 categories now, earlier was 105).
Types of changes
Feature/Enhancement Scale or Bug Severity
Feature/Enhancement Scale
Bug Severity
Screenshots (if appropriate):
Current API docs: https://cloudstack.apache.org/api/apidocs-4.22/
New API docs:
CloudStack API Reference - Updated.pdf
updateVirtualMachine API =>
migrateVirtualMachine API =>
unmanageVirtualMachine API =>
How Has This Been Tested?
Verified the generated API docs index page and some API pages.
How did you try to break this feature and the system with this change?