[jira] [Updated] (KNOX-2509) Use Open API UI to browse the Knox Admin/Metadata API REST endpoints
[ https://issues.apache.org/jira/browse/KNOX-2509?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Larry McCay updated KNOX-2509: -- Due to the pending 2.0.0 release this JIRA has been pushed out to 2.1.0 as part of a bulk update. If there is a specific reason to pull this back into the 2.0.0 release and you intend to provide a PR in the next few days please provide justification and reset the Fix Version to 2.0.0. > 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: 2.1.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)
[jira] [Updated] (KNOX-2509) Use Open API UI to browse the Knox Admin/Metadata API REST endpoints
[ https://issues.apache.org/jira/browse/KNOX-2509?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Larry McCay updated KNOX-2509: -- Fix Version/s: 2.1.0 2.1.0 (was: 2.0.1) > 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: 2.1.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)
[jira] [Updated] (KNOX-2509) Use Open API UI to browse the Knox Admin/Metadata API REST endpoints
[ https://issues.apache.org/jira/browse/KNOX-2509?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Larry McCay updated KNOX-2509: -- Fix Version/s: 2.0.1 (was: 2.0.0) > 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: 2.0.1 > > 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)
[jira] [Updated] (KNOX-2509) Use Open API UI to browse the Knox Admin/Metadata API REST endpoints
[ https://issues.apache.org/jira/browse/KNOX-2509?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Sandor Molnar updated KNOX-2509: Fix Version/s: (was: 1.6.0) 2.0.0 > 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: 2.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.3.4#803005)
