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

Custom endpoints no longer show up in REST Tools (Swagger UI)

    XMLWordPrintable

Details

    • Bug
    • Resolution: Not an issue
    • Major
    • None
    • 1.2
    • tools
    • None

    Description

      I wrote and contributed the forge module "magnolia-rest-queries" that adds a RESTful interface for executing JCR queries. After this latest swagger update my endpoint no longer appears in the REST Tools interface. I checked /.rest/swagger.json and it is also missing from there.

      The module configures itself according to the documentation provided here: https://documentation.magnolia-cms.com/display/DOCS/REST+API#RESTAPI-Exposingyourownendpoints

      It was working well in 5.4.x. It looks like the new Swagger re-organized things and now you're generating /.rest/swagger.json instead of /.rest/api-docs. I would guess that the code that generates swagger.json is failing to look in other module configurations for a /rest-endpoints/ node, but that is simply a guess.

      RESTful requests to the endpoint do continue to work correctly.

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                Unassigned Unassigned
                nwing Nickolaus Wing
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Bug DoR
                    Task DoD