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

Specify delivery endpoint version in clean way

    XMLWordPrintable

Details

    • Story
    • Resolution: Not an issue
    • Neutral
    • None
    • None
    • None
    • None

    Description

      As a developer I must somehow specify which version of the DeliveryEndpoint system I am using, I want to do that in a clean, simple to understand, and not java-oriented way.

      Also, we have decided that we should not supply a default endpoint as we see that this will cause projects to break in the future when we introduce new versions of the default endpoint which will not be backwards compatible.

      Notes:

      Currently one has to specify the class (or rely on a default).

      class: info.magnolia.rest.delivery.jcr.v2.JcrDeliveryEndpointDefinition

      The standard magnolia pattern for this would be to add a $type mapping with a simple name, like "jcrDeliveryEndpoint_v2". I think this would be an acceptible solution. However, consider if there might be a better way, keeping in mind that we will be introducing new versionss, like "v3", and we  might want to even introduce minor versions . like "3.2".

      Would we want do do something like:

      type: jcrDeliveryEndpoint
      version: 3 

      If we did introduce a new 'version' field, then we could actually consdier making the type/class a default since the developers projects would be safe since they are pinned on a specific version.

       

       

       

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            1.
            Implementation Sub-task To Do Unassigned
            2.
            Review Sub-task To Do Unassigned
            3.
            Pre-Integration QA Sub-task To Do Unassigned
            4.
            QA Sub-task To Do Unassigned

            Activity

              People

                oanh.thai Oanh Thai Hoang
                czimmermann Christopher Zimmermann
                DeveloperX
                Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Task DoD

                    Time Tracking

                      Estimated:
                      Original Estimate - Not Specified
                      Not Specified
                      Remaining:
                      Remaining Estimate - Not Specified
                      Not Specified
                      Logged:
                      Time Spent - 4.5h
                      4.5h