You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@knox.apache.org by "ASF GitHub Bot (Jira)" <ji...@apache.org> on 2020/12/15 11:08:00 UTC
[jira] [Work logged] (KNOX-2509) Use Open API UI to browse the Knox
Admin/Metadata API REST endpoints
[ https://issues.apache.org/jira/browse/KNOX-2509?focusedWorklogId=524370&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-524370 ]
ASF GitHub Bot logged work on KNOX-2509:
----------------------------------------
Author: ASF GitHub Bot
Created on: 15/Dec/20 11:07
Start Date: 15/Dec/20 11:07
Worklog Time Spent: 10m
Work Description: 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:
users@infra.apache.org
Issue Time Tracking
-------------------
Worklog Id: (was: 524370)
Remaining Estimate: 0h
Time Spent: 10m
> Use Open API UI to browse the Knox Admin/Metadata API REST endpoints
> --------------------------------------------------------------------
>
> Key: KNOX-2509
> URL: https://issues.apache.org/jira/browse/KNOX-2509
> Project: Apache Knox
> Issue Type: New Feature
> Components: Homepage, Server
> Affects Versions: 1.5.0
> Reporter: Sandor Molnar
> Assignee: Sandor Molnar
> Priority: Major
> Fix For: 1.6.0
>
> Time Spent: 10m
> Remaining Estimate: 0h
>
> I had some contribution that allows end-users managing service definitions without restarting the Knox Gateway. See KNOX-2053 and KNOX-2056 for further details.
>
> I've been just about creating a new JIRA to document those new API endpoints in the Knox user guide but it has come to my mind that we can do it much better by using Swagger.
>
> Given the fact, the Admin/Metadata API does not consist of hundreds of existing endpoints it should not be 'that' huge work. I personally believe the project would gain a lot by using this very useful tool. This way the Admin/Metadata API documentation would be generated out-of-the-box, no more documentation JIRAs required. Moreover, the generated documentation would be in sync with the actual implementation.
> You can check this out here: [https://swagger.io/tools/swagger-ui/] (there is a live demo too; it's worth looking at).
--
This message was sent by Atlassian Jira
(v8.3.4#803005)