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

Create rest endpoint that returns results from a template (ie FTL)

    XMLWordPrintable

Details

    • Story
    • Resolution: Unresolved
    • Neutral
    • None
    • None
    • None
    • None

    Description

      As a developer I need to create an endpoint that returns results generated by a template script, so that I can fulfill the complex headless requirements of my projects.

      Notes

      Headless projects can require advanced results that should be computed on the server rather then the client. Delivery endpoints only deliver content (stored in Magnolia and potentially elsewhere) - but cannot return calculated values or items based on a registry for example.

      Using templates to generate REST response gives developers access to the full range of power in Magnolia - from FTL templating to templating functions to JS models, allowing them to solve any headless usecase.

      A developer could do that in a regular Magnolia page now - but that is not ideal because it can be confusing for users of the pages app - and it is harder to setup for the developer because it depends on adding content, not just using light development. Also it makes controlling access better and more consistent with other REST endpoints.

      These endpoints should work like the delivery endpoints in that they are simply configured in a light module.

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                Unassigned Unassigned
                czimmermann Christopher Zimmermann
                Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                  Created:
                  Updated:

                  Checklists

                    Task DoD