Uploaded image for project: 'Magnolia REST Framework'
  1. Magnolia REST Framework
  2. MGNLREST-70

REST tools module uses an old version of swagger ui, meaning that relative api base paths do not work

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.2
    • Component/s: None
    • Labels:
    • Environment:
      OSX Version: 10.11.2 - El Capitan
    • Release notes required:
      Yes
    • Documentation update required:
      Yes
    • Sprint:
      Basel 63
    • Story Points:
      13
    • Magnolia Release:
      5.5

      Description

      The REST tools module (version 1.1.1) uses an old version of swagger-ui (although I cannot see the version specified in the source code.)

      This old version relies on the shred javascript library. This version of the library contains a bug which means that the basePath attribute cannot be a relative url when the rest tools are served from a non standard port (See https://github.com/pandastrike/shred/issues/60).

      In newer versions of swagger-ui, the shred library is no longer used for ajax requests, and it is possible to use swagger with a relative base path (this is something we have done in other projects - see attached screenshot.)

      We think it is useful to be able to use a relative basePath if need be, as the port/ full url that Magnolia will run on is not always known before start up, and therefore cannot always be managed by .properties files.

      We have managed to get the swagger ui working in magnolia if we set the relative base path (e.g. "/.rest") and hotfix the shred.bundle.js rest-tools resource as shown in the attachments. This proves that relative base paths should work fine if swagger-ui was updated, or the dependency is hotfixed.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                creichenbach Cedric Reichenbach
                Reporter:
                mnuttall Mike Nuttall
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Date of First Response:

                  Time Tracking

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