GabrielBrascher opened a new pull request #3247: Make the API documentation 
version not *hardcoded* to v4.9.0
URL: https://github.com/apache/cloudstack/pull/3247
 
 
   Currently, the API documentation is *hardcoded* to _v4.9.0_. This commit 
makes the API documentation automatically updated to the current project 
version. If one wants to set another version, it is possible by just editing 
the `ACS_RELEASE` variable in _build-apidoc.sh_.
   
   ## Description
   <!--- Describe your changes in detail -->
   
   <!-- 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: # -->
   
   ## Types of changes
   <!--- What types of changes does your code introduce? Put an `x` in all the 
boxes that apply: -->
   - [ ] 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)
   - [ ] Cleanup (Code refactoring and cleanup, that may add test cases)
   
   ## Screenshots (if appropriate):
   Prior to the changes proposed in this PR the generated API documentaion was 
labeled as '4.9.0':
   
![image](https://user-images.githubusercontent.com/5025148/55164448-7393b300-514a-11e9-95d5-a8c99b71b486.png)
   
   ## 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 
-->
   <!-- see how your change affects other areas of the code, etc. -->
   Project API documentation page:
   
![image](https://user-images.githubusercontent.com/5025148/55164220-0d0e9500-514a-11e9-8fac-db7d75e64ff4.png)
   
   Example of a API command documentation page:
   
![image](https://user-images.githubusercontent.com/5025148/55164328-37f8e900-514a-11e9-88b0-86858e08a4c4.png)
   
   <!-- Please read the 
[CONTRIBUTING](https://github.com/apache/cloudstack/blob/master/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.
 
For queries about this service, please contact Infrastructure at:
[email protected]


With regards,
Apache Git Services

Reply via email to