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

DOC: How to collectively refer to Delivery API in v 3.x of REST module

    XMLWordPrintable

Details

    • Task
    • Resolution: Obsolete
    • Neutral
    • None
    • None
    • None
    • None

    Description

      A bit of history about the collective name:

      (https://documentation.magnolia-cms.com/display/DOCS57/Delivery+endpoint+API)

      Delivery endpoint v2

      Version 2 was introduced with Magnolia REST 2.1 and provides more flexibility. You can use it to define multiple endpoint configurations, deliver localized content and resolve references to nodes of other workspaces including assets and asset renditions.

      See Delivery endpoint API v2.

      Delivery endpoint v1

      Version 1 was introduced with Magnolia REST 2.0. You can configure a single endpoint for your project.

      In the 6.2 docs, we now only have v2 and refer to it like that:
      (https://docs.magnolia-cms.com/product-docs/6.2/Developing/API/Delivery-API.html)

       

      How to proceed after module version 3.0.0 is released?

      Possibility A:
      Start using Delivery API v3 

      For module v 3.x+, I ve temporarily started using v3 for the docs update:
      (and docs-internally as well for docu includables, see ex here: https://git.magnolia-cms.com/projects/MODULES/repos/rest/browse/docs/modules/api/partials/r_delivery-endpoint-v3-configuration.adoc )

      Cons:  Internally, for continuity, v3 would in fact apply only to the JCR part:

      not to the Norsu part:

      Pros: Everybody will easily remember that v3 of the Delivery API can handle both, JCR + Norsu deliveries, whereas v2 can do only JCR.

      Possibility B:
      Use just Delivery API, don't add v3.

      Cons: Breaks away from what we've been doing until now. 
      **

      Pros: Avoids that v2(JCR) / <????>(Norsu) referencing issue using v<number>.

       

       

       

       

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                mdrapela Martin Drápela
                mdrapela Martin Drápela
                DeveloperX
                Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Task DoR