[
https://issues.apache.org/jira/browse/KNOX-2509?focusedWorklogId=524543&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-524543
]
ASF GitHub Bot logged work on KNOX-2509:
----------------------------------------
Author: ASF GitHub Bot
Created on: 15/Dec/20 16:35
Start Date: 15/Dec/20 16:35
Worklog Time Spent: 10m
Work Description: smolnar82 commented on a change in pull request #393:
URL: https://github.com/apache/knox/pull/393#discussion_r543499360
##########
File path: gateway-openapi-ui/src/main/resources/swagger/package.json
##########
@@ -0,0 +1,18 @@
+{
+ "name": "swagger-ui-dist",
+ "version": "3.36.2",
+ "main": "index.js",
+ "repository": "[email protected]:swagger-api/swagger-ui.git",
+ "contributors": [
+ "(in alphabetical order)",
+ "Anna Bodnia <[email protected]>",
+ "Buu Nguyen <[email protected]>",
+ "Josh Ponelat <[email protected]>",
+ "Kyle Shockey <[email protected]>",
+ "Robert Barnwell <[email protected]>",
+ "Sahar Jafari <[email protected]>"
+ ],
Review comment:
Removed.
##########
File path: pom.xml
##########
@@ -438,6 +440,12 @@
<exclude>atlassian-ide-plugin.xml</exclude>
<exclude>**/PULL_REQUEST_TEMPLATE*</exclude>
<exclude>**/new-service-definition-template.xml</exclude>
+ <exclude>**/swagger/*.js</exclude>
+ <exclude>**/swagger/*.js.map</exclude>
+ <exclude>**/swagger/*.html</exclude>
+ <exclude>**/swagger/*.css</exclude>
+ <exclude>**/swagger/*.css.map</exclude>
+ <exclude>**/swagger/*.md</exclude>
Review comment:
Fixed.
----------------------------------------------------------------
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]
Issue Time Tracking
-------------------
Worklog Id: (was: 524543)
Time Spent: 2h 10m (was: 2h)
> 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: 2h 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)
