[MGNLREST-202] Update the REST tools module to include a more recent version of swagger (to benefit from swagger bug fixes) Created: 10/May/16  Updated: 09/May/19  Resolved: 09/May/19

Status: Closed
Project: Magnolia REST Framework
Component/s: tools
Affects Version/s: 1.1
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Mike Nuttall Assignee: Unassigned
Resolution: Duplicate Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File Screen Shot 2016-05-10 at 15.37.22.png     PNG File Screen Shot 2016-05-10 at 15.48.48.png     PNG File Screen Shot 2016-05-10 at 15.49.04.png    
Issue Links:
relation
is related to MGNLREST-70 REST tools module uses an old versio... Closed
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)

 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 attachment. This proves that everything should work fine if swagger-ui was updated, or the dependency fixed.


Generated at Mon Feb 12 06:57:38 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.