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

REST Queries - Expand references

    XMLWordPrintable

Details

    • Story
    • Resolution: Fixed
    • Neutral
    • 2.0
    • None
    • None
    • Saigon 115, Saigon 116, Saigon 117, Saigon 118
    • 5

    Description

      User story:
      As a Developer, I can request a reference to be expanded , so that I only need to make one request to get all of the information I need.

      Capabilities:

      • When an item refers to another item, I can retrieve that referenced item in the same request.
      • The reference item info can be "shaped" in the same way as the main item - requesting specific fields, resolving links etc.
      • I can request how many levels of expansion to perform, default is 0.

      To Specify: Format of expanded content.
      There are different opinions as to how to best include expanded content. Two options to evaluate:

      • Content is expanded "in place" - so right where a linked categories UUID would have been, now there is an object containing the categories contents.
      • Content is appended to the end of the response. So an additional category object is included at the end of the response.

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                sang.ngo Sang Ngo Huu
                czimmermann Christopher Zimmermann
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Task DoD

                    Time Tracking

                      Estimated:
                      Original Estimate - 5.5h Original Estimate - 5.5h
                      5.5h
                      Remaining:
                      Remaining Estimate - 0d
                      0d
                      Logged:
                      Time Spent - 5d 3h
                      5d 3h