[GitHub] [knox] smolnar82 opened a new pull request #393: KNOX-2509 - Added OpenAPI UI (v3.36.2) for documenting Knox's REST API endpoints and models

[GitBox]

smolnar82 opened a new pull request #393:
URL: https://github.com/apache/knox/pull/393


   ## What changes were proposed in this pull request?
   
   In this change, I'm integrating Open API UI version 3.36.2 into the Knox 
Home page, under `home/swagger`. The UI itself is downloaded and unpacked as I 
needed to modify the out-of-the-box `index.html`.
   
   I annotated many of the resources in the relevant classes, but that work is 
not yet finished (it'll come later in a different PR). I just wanted to make 
sure the UI itself, its build integration, and the basic annotations are merged 
into Apache.
   
   The location of the Swagger browser is available here (assuming a fresh Knox 
install): https://localhost:8443/home/swagger/
   
   ## How was this patch tested?
   
   Ran a full build including tests, static code analyzing tools.
   
   Manually tested the UI itself.
   
   <img width="1609" alt="Screen Shot 2020-12-15 at 12 00 13 PM" 
src="https://user-images.githubusercontent.com/34065904/102206682-4b735700-3ecd-11eb-8f23-92b2fa11808c.png";>
   <img width="1610" alt="Screen Shot 2020-12-15 at 12 00 54 PM" 
src="https://user-images.githubusercontent.com/34065904/102206691-4f06de00-3ecd-11eb-8a6c-4e6dbfa83ce8.png";>
   <img width="1597" alt="Screen Shot 2020-12-15 at 12 01 23 PM" 
src="https://user-images.githubusercontent.com/34065904/102206695-4f9f7480-3ecd-11eb-8563-9ed8deccd180.png";>
   
   


----------------------------------------------------------------
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:
us...@infra.apache.org