ui: add new API docs tab

[yadvr]

This introduces a new API docs tab which is enabled by default but the admin can disable it via config.json. This uses the discovered APIs for logged in user/account to show them the APIs accessible to them and generates dynamic API docs based on them which are searchable. Also introduces some common auto-completed API groups that are available to most roles.

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)

[yadvr]

@blueorangutan ui

[blueorangutan]

@rohityadavcloud a Jenkins job has been kicked to build UI QA env. I'll keep you posted as I make progress.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 15.54%. Comparing base (afdf4d7) to head (ac1a9a0).
Report is 14 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #9409      +/-   ##
============================================
- Coverage     15.54%   15.54%   -0.01%     
+ Complexity    11976    11975       -1     
============================================
  Files          5493     5494       +1     
  Lines        481030   481055      +25     
  Branches      60247    60363     +116     
============================================
- Hits          74766    74763       -3     
- Misses       398000   398030      +30     
+ Partials       8264     8262       -2     

Flag	Coverage Δ
uitests	4.18% <ø> (+0.01%)	⬆️
unittests	16.30% <ø> (-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.

[blueorangutan]

UI build: ✔️
Live QA URL: https://qa.cloudstack.cloud/simulator/pr/9409 (QA-JID-407)

[yadvr]

@blueorangutan ui

[blueorangutan]

@rohityadavcloud a Jenkins job has been kicked to build UI QA env. I'll keep you posted as I make progress.

[blueorangutan]

UI build: ✔️
Live QA URL: https://qa.cloudstack.cloud/simulator/pr/9409 (QA-JID-408)

[DaanHoogland]

looks good

[sureshanaparti]

Parameter Name column in Request parameters table sometimes wraps text - not sure if that's the expected behavior. Not noticed in Response parameters.

[sureshanaparti]

Noticed blank lines in response parameters table for some of the APIs, few screenshots for ref.

[yadvr]

@blueorangutan ui

[blueorangutan]

@rohityadavcloud a Jenkins job has been kicked to build UI QA env. I'll keep you posted as I make progress.

[blueorangutan]

UI build: ✔️
Live QA URL: https://qa.cloudstack.cloud/simulator/pr/9409 (QA-JID-409)

[JoaoJandre]

LGTM, tested with npm run serve, went through a lot of APIs and all seemed ok, also verified that the download and docs for CMK was ok. Great addition!

I think that it might be interesting to have the 'since' for APIs/params as well, what do you think @rohityadavcloud ? cc @DaanHoogland @weizhouapache

[sureshanaparti]

Verified the API docs section, with some APIs listed.

[yadvr]

@JoaoJandre thanks for reviewing and testing. Let me explore if since can be added. There’s also a related field and routability between selected APIs.

[yadvr]

@blueorangutan ui

[blueorangutan]

@rohityadavcloud a Jenkins job has been kicked to build UI QA env. I'll keep you posted as I make progress.

[blueorangutan]

UI build: ✔️
Live QA URL: https://qa.cloudstack.cloud/simulator/pr/9409 (QA-JID-410)