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

Magnolia's REST API naming convention does not match Swagger's

    XMLWordPrintable

Details

    • Bug
    • Resolution: Unresolved
    • Neutral
    • None
    • None
    • None
    • None

    Description

      Swagger expects the first segment of the REST API to be the version, followed by the endpoint name, e.g.

      /v1/shop/...

      However in Magnolia's REST API this is flipped:

      /nodes/v1/...

      Because of this, Swagger lists all 3 Magnolia REST APIs (commands, properties and nodes) as "v1" and when you click on one of them all three are expanded. Maybe it would be a good thing to change this for v2?

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

              Unassigned Unassigned
              will Will Scheidegger
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:

                Checklists

                  Bug DoR
                  Task DoD