Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix toc generation for api docs #9655

Merged
merged 2 commits into from
Sep 17, 2024
Merged

Conversation

vishesh92
Copy link
Member

Description

This PR modifies the categories of the commands API Documentation.

Details

Command Category before changes Category after changes
addAccountToProject Account Project
addBaremetalHost Host Baremetal
addGloboDnsHost Host Network
addImageStoreS3 S3 Image Store
addNetscalerLoadBalancer Load Balancer Netscaler
addNetworkDevice Network Network Device
addObjectStoragePool Storage Pool Object Store
addPaloAltoFirewall Firewall Palo Alto
addSecondaryStorage Host Image Store
addStratosphereSsp Stratosphere SSP Misc Network Service Providers
addSwift Swift Image Store
addTrafficMonitor Usage Network
addTrafficType Usage Network
addTungstenFabricNetworkGatewayToLogicalRouter Router Tungsten
addUserToProject User Project
addVirtualMachinesToKubernetesCluster Virtual Machine Kubernetes Service
addVpnUser User VPN
cancelShutdown Shutdown Management
changeSharedFileSystemDiskOffering Disk Offering Shared FileSystem
changeSharedFileSystemServiceOffering Service Offering Shared FileSystem
configureInternalLoadBalancerElement Load Balancer Internal LB
configureNetscalerLoadBalancer Load Balancer Netscaler
configurePaloAltoFirewall Firewall Palo Alto
createInternalLoadBalancerElement Load Balancer Internal LB
createKubernetesCluster Cluster Kubernetes Service
createManagementNetworkIpRange Network Pod
createProjectRole Role Project
createProjectRolePermission Role Project
createSecondaryStorageSelector Host Image Store
createSnapshotFromVMSnapshot Virtual Machine Snapshot
createTungstenFabricFirewallPolicy Firewall Tungsten
createTungstenFabricFirewallRule Firewall Tungsten
createTungstenFabricLogicalRouter Router Tungsten
createTungstenFabricManagementNetwork Network Tungsten
createTungstenFabricPublicNetwork Network Tungsten
createVMSnapshot Virtual Machine Snapshot
createVPCOffering VPC VPC Offering
dedicateHost Host Dedicate Resources
deleteAccountFromProject Account Project
deleteKubernetesCluster Cluster Kubernetes Service
deleteManagementNetworkIpRange Network Pod
deleteNetscalerControlCenter Load Balancer Netscaler
deleteNetscalerLoadBalancer Load Balancer Netscaler
deleteNetworkDevice Network Network Device
deleteObjectStoragePool Storage Pool Object Store
deletePaloAltoFirewall Firewall Palo Alto
deleteProjectRole Role Project
deleteProjectRolePermission Role Project
deleteSslCert Load Balancer SSL Certificates
deleteStratosphereSsp Stratosphere SSP Misc Network Service Providers
deleteTrafficMonitor Usage Network
deleteTrafficType Usage Network
deleteTungstenFabricFirewallPolicy Firewall Tungsten
deleteTungstenFabricFirewallRule Firewall Tungsten
deleteTungstenFabricLogicalRouter Router Tungsten
deleteUserData User User Data
deleteUserFromProject User Project
deleteVMSnapshot Virtual Machine Snapshot
deleteVPCOffering VPC VPC Offering
disableOutOfBandManagementForHost Host Out-of-band Management
enableOutOfBandManagementForHost Host Out-of-band Management
getApiLimit Limit Configuration
getKubernetesClusterConfig Cluster Kubernetes Service
getSolidFireAccountId Account SolidFire
getSolidFireVolumeAccessGroupIds Volume SolidFire
getSolidFireVolumeSize Volume SolidFire
getVolumeSnapshotDetails Volume Snapshot
linkUserDataToTemplate Template User Data
listBrocadeVcsDeviceNetworks Network Brocade VCS
listHostsMetrics Host Metrics
listHypervisors Hypervisor Configuration
listInternalLoadBalancerElements Load Balancer Internal LB
listInternalLoadBalancerVMs Virtual Machine Internal LB
listKubernetesClusters Cluster Kubernetes Service
listManagementServersMetrics Metrics Management
listNetscalerControlCenter Load Balancer Netscaler
listNetscalerLoadBalancerNetworks Load Balancer Netscaler
listNetscalerLoadBalancers Load Balancer Netscaler
listNetworkDevice Network Network Device
listNetworkIsolationMethods ISO Network
listNiciraNvpDeviceNetworks Network Nicira NVP
listObjectStoragePools Storage Pool Object Store
listPaloAltoFirewallNetworks Firewall Palo Alto
listPaloAltoFirewalls Firewall Palo Alto
listProjectAccounts Account Project
listProjectRolePermissions Role Project
listProjectRoles Role Project
listResourceLimits Limit Resource Limit
listSecondaryStorageSelectors Host Image Store
listSslCerts Load Balancer SSL Certificates
listSwifts Swift Image Store
listTemplateDirectDownloadCertificates Template Certificate
listTrafficMonitors Usage Network
listTrafficTypeImplementors Usage Network
listTrafficTypes Usage Network
listTungstenFabricFirewallPolicy Firewall Tungsten
listTungstenFabricFirewallRule Firewall Tungsten
listTungstenFabricLogicalRouter Router Tungsten
listTungstenFabricNetwork Network Tungsten
listUsageServerMetrics Usage Metrics
listUserData User User Data
listVMSnapshot Virtual Machine Snapshot
listVPCOfferings VPC VPC Offering
listVolumesMetrics Volume Metrics
listVpnUsers User VPN
listZonesMetrics Zone Metrics
migrateResourceToAnotherSecondaryStorage Host Image Store
migrateSecondaryStorageData Host Image Store
moveNetworkAclItem Network Network ACL
prepareForShutdown Shutdown Management
provisionTemplateDirectDownloadCertificate Template Certificate
readyForShutdown Shutdown Management
registerNetscalerControlCenter Registration Netscaler
registerNetscalerServicePackage Registration Netscaler
registerOauthProvider Registration Oauth
registerUserData User User Data
releaseDedicatedHost Host Dedicate Resources
removeSecondaryStorageSelector Host Image Store
removeTungstenFabricNetworkGatewayFromLogicalRouter Router Tungsten
removeVirtualMachinesFromKubernetesCluster Virtual Machine Kubernetes Service
removeVpnUser User VPN
resetApiLimit Limit Configuration
restoreVolumeFromBackupAndAttachToVM Virtual Machine Volume
revokeTemplateDirectDownloadCertificate Template Certificate
scaleKubernetesCluster Cluster Kubernetes Service
startInternalLoadBalancerVM Virtual Machine Internal LB
startKubernetesCluster Cluster Kubernetes Service
stopInternalLoadBalancerVM Virtual Machine Internal LB
stopKubernetesCluster Cluster Kubernetes Service
triggerShutdown Shutdown Management
updateObjectStoragePool Storage Pool Object Store
updateProjectRole Role Project
updateProjectRolePermission Role Project
updateResourceLimit Limit Resource Limit
updateSecondaryStorageSelector Host Image Store
updateStorageCapabilities Configuration Storage Pool
updateTrafficType Usage Network
updateVMAffinityGroup Virtual Machine Affinity Group
updateVPCOffering VPC VPC Offering
upgradeKubernetesCluster Cluster Kubernetes Service
uploadSslCert Load Balancer SSL Certificates
uploadTemplateDirectDownloadCertificate Template Certificate

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)
  • 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
  • Minor

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

@boring-cyborg boring-cyborg bot added the Python Warning... Python code Ahead! label Sep 9, 2024
Copy link

codecov bot commented Sep 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 15.81%. Comparing base (f8d8a9c) to head (fe62a4f).
Report is 20 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #9655      +/-   ##
============================================
+ Coverage     15.77%   15.81%   +0.03%     
- Complexity    12542    12554      +12     
============================================
  Files          5623     5629       +6     
  Lines        491611   492023     +412     
  Branches      60012    61243    +1231     
============================================
+ Hits          77568    77813     +245     
- Misses       405584   405887     +303     
+ Partials       8459     8323     -136     
Flag Coverage Δ
uitests 4.48% <ø> (+0.43%) ⬆️
unittests 16.60% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@sureshanaparti sureshanaparti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clgtm

@DaanHoogland @rajujith check/confirm the API & its updated category

Copy link
Contributor

@DaanHoogland DaanHoogland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if the indentation issue is not a problem for pythonc : clgtm

tools/apidoc/gen_toc.py Outdated Show resolved Hide resolved
@DaanHoogland
Copy link
Contributor

@blueorangutan package

@blueorangutan
Copy link

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

@blueorangutan
Copy link

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 11052

@rohityadavcloud rohityadavcloud added this to the 4.20.0.0 milestone Sep 9, 2024
@JoaoJandre JoaoJandre modified the milestones: 4.20.0.0, 4.21.0.0 Sep 10, 2024
Co-authored-by: dahn <daan.hoogland@gmail.com>
@vishesh92
Copy link
Member Author

@blueorangutan package

@blueorangutan
Copy link

@vishesh92 a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

@blueorangutan
Copy link

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 11090

@rohityadavcloud rohityadavcloud modified the milestones: 4.21.0.0, 4.20.1.0 Sep 12, 2024
@rohityadavcloud
Copy link
Member

Manually QA on the built apidocs html/site is needed.

@sureshanaparti
Copy link
Contributor

@JoaoJandre I think, it's better to have this in 4.20, as the APIs would have the updated/correct categories in the docs.

@rohityadavcloud rohityadavcloud modified the milestones: 4.20.1.0, 4.20.0.0 Sep 17, 2024
@rohityadavcloud
Copy link
Member

Agree @sureshanaparti could be useful as usually the major release api docs is what we upload to project website. Let me help QA this.

@rohityadavcloud
Copy link
Member

Manually built and tested - OK. API docs LGTM. Screenshot below, passing to @JoaoJandre to consider and merge:

image

@JoaoJandre JoaoJandre merged commit aa64476 into apache:main Sep 17, 2024
24 of 26 checks passed
@DaanHoogland DaanHoogland deleted the fixup-toc-generation branch September 17, 2024 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants