Uploaded image for project: 'Apache Knox'
  1. Apache Knox
  2. KNOX-2509

Use Open API UI to browse the Knox Admin/Metadata API REST endpoints

    XMLWordPrintableJSON

    Details

    • Type: New Feature
    • Status: In Progress
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: 1.5.0
    • Fix Version/s: 1.6.0
    • Component/s: Homepage, Server
    • Labels:
      None

      Description

      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).

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                smolnar Sandor Molnar
                Reporter:
                smolnar Sandor Molnar
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 2.5h
                  2.5h