[ 
https://issues.apache.org/jira/browse/KNOX-2509?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Sandor Molnar updated KNOX-2509:
--------------------------------

+Apache Knox 3.0.0 release preparation+
   
We are about to cut the 3.0.0 release branch. master will move on to 3.1.0.
This issue is currently unresolved and is not automatically included in 3.0.0. 
Please choose one of the following:
# If this belongs in 3.0.0: once the branch is cut, cherry-pick your commit(s) 
onto the new v3.0.0 branch in addition to master. Leave Fix Version = 3.0.0 so 
we can track it.
# Do nothing: we will move this issue to the next release (3.1.0) as part of 
release cleanup.
   
If we don't hear back and see no cherry-pick, the issue will be re-targeted to 
3.1.0. Thanks!

> 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: 3.0.0
>
>          Time Spent: 2.5h
>  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.20.10#820010)

Reply via email to