[MGNLREST-294] Rest Tools Loads Nothing Created: 04/Jan/21  Updated: 31/May/21  Resolved: 28/May/21

Status: Closed
Project: Magnolia REST Framework
Component/s: tools
Affects Version/s: 2.2.2, 2.2.5
Fix Version/s: 2.2.7

Type: Bug Priority: Blocker
Reporter: Chris Jennings Assignee: Mikaël Geljić
Resolution: Fixed Votes: 3
Labels: maintenance
Remaining Estimate: 0d
Time Spent: 1d 0.5h
Original Estimate: Not Specified

Attachments: PNG File new-rest-tools-look.png     PNG File rest-tools.png    
Issue Links:
Relates
relates to MGNLREST-231 Decouple OpenAPI/Swagger support from... Open
relation
is related to MGNLRESTCL-24 Cannot install Rest Client app and Re... Open
Template:
Acceptance criteria:
Empty
Task DoD:
[X]* Doc/release notes changes? Comment present?
[X]* Downstream builds green?
[X]* Solution information and context easily available?
[X]* Tests
[X]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Bug DoR:
[X]* Steps to reproduce, expected, and actual results filled
[X]* Affected version filled
Release notes required:
Yes
Date of First Response:
Epic Link: Support
Sprint: Maintenance 58, Maintenance 60
Story Points: 5

 Description   

Steps to reproduce

  1.  Add the rest-tools dependency to the Travel Demo project
  2.  Start the project and open the Rest Tools app.
  3. Assuming the API base path is set, nothing is displayed.

Expected results

  1. The Swagger Ui is displayed with the Nodes endpoint documented.

Actual results

  1. Nothing is displayed. The JSON endpoint the module adds, /.rest/swagger.json, is available.

Workaround

  1. Nothing obvious

Development notes



 Comments   
Comment by Chris Jennings [ 04/Jan/21 ]

I am aware of MGNLRESTCL-24 and removed the dependencies for Rest Client from the POM to no effect.

Necessary exclusions are:

      <exclusions>
        <exclusion>
            <groupId>info.magnolia.restclient</groupId>
            <artifactId>magnolia-rest-client</artifactId>
        </exclusion>
        <exclusion>
            <groupId>info.magnolia.restclient</groupId>
            <artifactId>magnolia-rest-client-app</artifactId>
        </exclusion>
        <exclusion>
          <groupId>info.magnolia.restclient</groupId>
          <artifactId>magnolia-rest-client-ui</artifactId>
        </exclusion>
        <exclusion>
          <groupId>info.magnolia.cache</groupId>
          <artifactId>magnolia-cache-browser-app</artifactId>
        </exclusion>
      </exclusions>
Comment by Will Scheidegger [ 15/Jan/21 ]

This seems to be due to a dependency mismatch in with jackson. The rest tools require 2.9.something whereas the rest client manages them to 2.11.1.

Comment by Mikaël Geljić [ 22/Apr/21 ]

Mind the note on 6.2 release notes:

Due to an upgrade of the Swagger libraries and pending adjustments to Open API integration, the REST Tools module, which is a submodule of the REST module but is not installed by default, is not compatible with Magnolia 6.2. For more details about ongoing development, see MGNLREST-231.

Long story short, since 6.2 we use open API v3 annotations (MGNLREST-230), while the REST tools implementation producing the schema is still looking for older swagger specs, and pending for its update. I just briefly gave it a shot however. 

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