Skip to content

Shows quotaSummary in API documentation#6605

Merged
yadvr merged 1 commit intoapache:4.17from
RodrigoDLopez:shows-quotaSummary-in-API-documentation
Aug 3, 2022
Merged

Shows quotaSummary in API documentation#6605
yadvr merged 1 commit intoapache:4.17from
RodrigoDLopez:shows-quotaSummary-in-API-documentation

Conversation

@RodrigoDLopez
Copy link
Copy Markdown
Contributor

@RodrigoDLopez RodrigoDLopez commented Aug 2, 2022

Description

Through analysis, it was found that the Cloudstack API documentation (https://cloudstack.apache.org/api/apidocs-4.17) does not present the document for the quotaSummary API. This error has been present since the creation of this API.
The present patch corrects this behavior, exposing the documentation for this API to the user.

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)

Screenshots:

image

How Has This Been Tested?

To generate the documentation and verify the correction, you can run mvn clean install inside the tools/apidoc project and check the content of the page present in tools/apidoc/target/xmldoc/html/index.html. Or run the build-apidoc.sh script:

`./build-apidoc.sh 4.17.0.0 ../../client/target//cloud-client-ui-4.17.0.0.jar ../../client/target//cloud-client-ui-4.17.00.jar ./myout

and check the page content available in myout/xmldoc/html/index.html

@boring-cyborg boring-cyborg bot added the Python Warning... Python code Ahead! label Aug 2, 2022
@RodrigoDLopez
Copy link
Copy Markdown
Contributor Author

@DaanHoogland I did mess with the other PR. I closed that one and opened this one with the asked target.

@yadvr yadvr added this to the 4.17.1.0 milestone Aug 3, 2022
@yadvr yadvr merged commit 3220efe into apache:4.17 Aug 3, 2022
neogismm pushed a commit to neogismm/cloudstack that referenced this pull request Aug 6, 2022
Co-authored-by: Lopez <rodrigo@scclouds.com.br>
@RodrigoDLopez RodrigoDLopez deleted the shows-quotaSummary-in-API-documentation branch January 9, 2023 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Python Warning... Python code Ahead!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants