<!-- 
RSS generated by JIRA (9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b) at Mon Feb 12 07:00:46 CET 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary append 'field=key&field=summary' to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>Magnolia - Issue tracker</title>
    <link>https://jira.magnolia-cms.com</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-uk</language>    <build-info>
        <version>9.4.2</version>
        <build-number>940002</build-number>
        <build-date>19-01-2023</build-date>
    </build-info>


<item>
            <title>[MGNLREST-529] DOC: How to collectively refer to Delivery API in v 3.x of REST module</title>
                <link>https://jira.magnolia-cms.com/browse/MGNLREST-529</link>
                <project id="10674" key="MGNLREST">Magnolia REST Framework</project>
                    <description>&lt;p&gt;A bit of history about the collective name:&lt;/p&gt;
&lt;blockquote&gt;&lt;p&gt;(&lt;a href=&quot;https://documentation.magnolia-cms.com/display/DOCS57/Delivery+endpoint+API)&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://documentation.magnolia-cms.com/display/DOCS57/Delivery+endpoint+API)&lt;/a&gt;&lt;/p&gt;
&lt;h2&gt;&lt;a name=&quot;Deliveryendpoint&quot;&gt;&lt;/a&gt;Delivery endpoint &lt;font color=&quot;#de350b&quot;&gt;v2&lt;/font&gt;&lt;/h2&gt;

&lt;p&gt;Version 2 was introduced with&#160;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.&lt;/p&gt;

&lt;p&gt;See&#160;&lt;a href=&quot;https://documentation.magnolia-cms.com/display/DOCS57/Delivery+endpoint+API+v2&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;Delivery endpoint API v2&lt;/a&gt;.&lt;/p&gt;
&lt;h2&gt;&lt;a name=&quot;Deliveryendpoint&quot;&gt;&lt;/a&gt;Delivery endpoint &lt;font color=&quot;#de350b&quot;&gt;v1&lt;/font&gt;&lt;/h2&gt;

&lt;p&gt;Version 1 was introduced with Magnolia REST 2.0. You can configure a single endpoint for your project.&lt;/p&gt;&lt;/blockquote&gt;
&lt;p&gt;In the 6.2 docs, we now only have v2 and refer to it like that:&lt;br/&gt;
(&lt;a href=&quot;https://docs.magnolia-cms.com/product-docs/6.2/Developing/API/Delivery-API.html&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://docs.magnolia-cms.com/product-docs/6.2/Developing/API/Delivery-API.html&lt;/a&gt;)&lt;/p&gt;

&lt;p&gt;&lt;span class=&quot;image-wrap&quot; style=&quot;&quot;&gt;&lt;img src=&quot;https://jira.magnolia-cms.com/secure/attachment/102163/102163_image-2022-10-19-10-38-15-118.png&quot; style=&quot;border: 0px solid black&quot; /&gt;&lt;/span&gt;&lt;/p&gt;

&lt;p&gt;&#160;&lt;/p&gt;

&lt;p&gt;&lt;font color=&quot;#0747a6&quot;&gt;&lt;em&gt;&lt;b&gt;How to proceed after module version 3.0.0 is released?&lt;/b&gt;&lt;/em&gt;&lt;/font&gt;&lt;/p&gt;

&lt;p&gt;&lt;ins&gt;&lt;font color=&quot;#ff8b00&quot;&gt;&lt;b&gt;Possibility A&lt;/b&gt;&lt;/font&gt;:&lt;/ins&gt;&lt;br/&gt;
Start using &lt;b&gt;Delivery API v3&lt;/b&gt;&#160;&lt;/p&gt;

&lt;p&gt;For module v 3.x+, I ve temporarily started using v3 for the docs update:&lt;br/&gt;
(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-&lt;font color=&quot;#de350b&quot;&gt;v3&lt;/font&gt;-configuration.adoc )&lt;br/&gt;
&lt;span class=&quot;image-wrap&quot; style=&quot;&quot;&gt;&lt;img src=&quot;https://jira.magnolia-cms.com/secure/attachment/102162/102162_image-2022-10-19-10-42-33-463.png&quot; style=&quot;border: 0px solid black&quot; /&gt;&lt;/span&gt;&lt;br/&gt;
&lt;b&gt;&lt;font color=&quot;#de350b&quot;&gt;Cons&lt;/font&gt;&lt;/b&gt;:&#160; Internally, for continuity, v3 would in fact apply only to the JCR part:&lt;br/&gt;
&lt;span class=&quot;image-wrap&quot; style=&quot;&quot;&gt;&lt;img src=&quot;https://jira.magnolia-cms.com/secure/attachment/102161/102161_image-2022-10-19-10-45-24-924.png&quot; style=&quot;border: 0px solid black&quot; /&gt;&lt;/span&gt;&lt;br/&gt;
not to the Norsu part:&lt;br/&gt;
&lt;span class=&quot;image-wrap&quot; style=&quot;&quot;&gt;&lt;img src=&quot;https://jira.magnolia-cms.com/secure/attachment/102160/102160_image-2022-10-19-10-45-56-271.png&quot; style=&quot;border: 0px solid black&quot; /&gt;&lt;/span&gt;&lt;/p&gt;

&lt;p&gt;&lt;b&gt;&lt;font color=&quot;#00875a&quot;&gt;Pros&lt;/font&gt;&lt;/b&gt;: Everybody will easily remember that &lt;b&gt;v3&lt;/b&gt; of the Delivery API can handle both, JCR + Norsu deliveries, whereas v2 can do only JCR.&lt;/p&gt;

&lt;p&gt;&lt;ins&gt;&lt;font color=&quot;#ff8b00&quot;&gt;&lt;b&gt;Possibility B&lt;/b&gt;&lt;/font&gt;:&lt;/ins&gt;&lt;br/&gt;
Use just &lt;b&gt;Delivery API&lt;/b&gt;, don&apos;t add &lt;b&gt;v3&lt;/b&gt;.&lt;/p&gt;

&lt;p&gt;&lt;b&gt;&lt;font color=&quot;#de350b&quot;&gt;Cons&lt;/font&gt;&lt;/b&gt;: Breaks away from what we&apos;ve been doing until now.&#160;&lt;br/&gt;
**&lt;/p&gt;

&lt;p&gt;&lt;b&gt;&lt;font color=&quot;#00875a&quot;&gt;Pros&lt;/font&gt;&lt;/b&gt;: Avoids that &lt;b&gt;v2(JCR) / &amp;lt;????&amp;gt;(Norsu)&lt;/b&gt; referencing issue using &lt;b&gt;v&amp;lt;number&amp;gt;&lt;/b&gt;.&lt;/p&gt;

&lt;p&gt;&#160;&lt;/p&gt;

&lt;p&gt;&#160;&lt;/p&gt;

&lt;p&gt;&#160;&lt;/p&gt;

&lt;p&gt;&#160;&lt;/p&gt;</description>
                <environment></environment>
        <key id="120692">MGNLREST-529</key>
            <summary>DOC: How to collectively refer to Delivery API in v 3.x of REST module</summary>
                <type id="3" iconUrl="https://jira.magnolia-cms.com/secure/viewavatar?size=xsmall&amp;avatarId=10898&amp;avatarType=issuetype">Task</type>
                                            <priority id="6" iconUrl="https://jira.magnolia-cms.com/images/icons/priorities/neutral.gif">Neutral</priority>
                        <status id="6" iconUrl="https://jira.magnolia-cms.com/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="success"/>
                                    <resolution id="9">Obsolete</resolution>
                                        <assignee username="mdrapela">Martin Dr&#225;pela</assignee>
                                    <reporter username="mdrapela">Martin Dr&#225;pela</reporter>
                        <labels>
                    </labels>
                <created>Wed, 19 Oct 2022 10:51:13 +0200</created>
                <updated>Mon, 27 Feb 2023 09:46:30 +0100</updated>
                            <resolved>Mon, 27 Feb 2023 09:46:29 +0100</resolved>
                                                                        <due></due>
                            <votes>0</votes>
                                    <watches>3</watches>
                                                                                                                <comments>
                            <comment id="327227" author="czimmermann" created="Wed, 19 Oct 2022 12:28:52 +0200"  >&lt;p&gt;I dont think the current changes indicate a jcrDeliveryEndpont_v3. A new major version would indicate to me that it is either incompatible with v2 functionaallity, that is it brings breaking changes, or that it brings major new functionality. It does not do either of these things so I would keep it as jcrDeliveryEndpoint_v2&lt;/p&gt;

&lt;p&gt;I would not link the module version to the REST delivery endpoint version.&lt;/p&gt;

&lt;p&gt;For the new norsu delivery endpoint, the users must specify a different class or `$type` to use it - ie &quot;norsuDeliveryEndpoint&quot;.&#160;&lt;br/&gt;
Here I am not 100% sure - but I would recommend starting with norsuDeliveryEndpoint_v2 as it has roughly the same functionality, saame configuration, and same response as the jcrDeliveryEndpoint_v2.&lt;/p&gt;
&lt;ul&gt;
	&lt;li&gt;Certainly its no problem to start with v2.&lt;/li&gt;
	&lt;li&gt;In the present time having theme with the same version is helpful, since the functionality is comparable.&lt;/li&gt;
	&lt;li&gt;But I&apos;m not sure about the future - the functionality may diverge... at which point the versions might not have much to do with each other. But my hunch is that the functionality will stay relativly similar for jcr and norsu endpoints.&lt;/li&gt;
&lt;/ul&gt;
</comment>
                            <comment id="327230" author="czimmermann" created="Wed, 19 Oct 2022 12:30:45 +0200"  >&lt;p&gt;Developers must specify the version of the endpoint. If they do not then when a new version comes with breaking changes it will break their projects.&lt;br/&gt;
(We did recently introduce that developer does not have to specify the class for the delivery endpoint, but this is going to be deprecated for the aabove reason.)&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10160">
                    <name>Relates</name>
                                            <outwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="120480">MGNLREST-522</issuekey>
        </issuelink>
                            </outwardlinks>
                                                        </issuelinktype>
                    </issuelinks>
                <attachments>
                            <attachment id="102163" name="image-2022-10-19-10-38-15-118.png" size="35709" author="mdrapela" created="Wed, 19 Oct 2022 10:38:15 +0200"/>
                            <attachment id="102162" name="image-2022-10-19-10-42-33-463.png" size="35713" author="mdrapela" created="Wed, 19 Oct 2022 10:42:34 +0200"/>
                            <attachment id="102161" name="image-2022-10-19-10-45-24-924.png" size="15137" author="mdrapela" created="Wed, 19 Oct 2022 10:45:25 +0200"/>
                            <attachment id="102160" name="image-2022-10-19-10-45-56-271.png" size="15167" author="mdrapela" created="Wed, 19 Oct 2022 10:45:57 +0200"/>
                            <attachment id="107015" name="image-2023-02-27-09-44-52-478.png" size="41109" author="mdrapela" created="Mon, 27 Feb 2023 09:44:53 +0100"/>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                            <customfield id="customfield_14166" key="com.okapya.jira.checklist:checklist">
                        <customfieldname>Acceptance criteria</customfieldname>
                        <customfieldvalues>
                            
        <checklist>
        <![CDATA[
                            




                
                                    <div class="o-completion" style="display: flex; flex-shrink: 0;"><span  class="aui-lozenge aui-lozenge-complete" style="font-size: 12px; font-weight: normal; display: flex; flex-direction: row; align-items: center;" ><span style="padding-right: 4px; vertical-align: middle;"><svg width="15" height="15" viewBox="0 0 15 15" xmlns="http://www.w3.org/2000/svg" fill="white"><path clip-rule="evenodd" d="m10.41037,3.42544l-7.86501,0c-0.72395,0 -1.31084,0.58688 -1.31084,1.31084l0,7.86508c0,0.7239 0.58689,1.3108 1.31084,1.3108l7.86501,0c0.724,0 1.3109,-0.5869 1.3109,-1.3108l0,-7.86508c0,-0.72396 -0.5869,-1.31084 -1.3109,-1.31084zm-7.86501,-0.65542c-1.08593,0 -1.96626,0.88032 -1.96626,1.96626l0,7.86508c0,1.0859 0.88033,1.9662 1.96626,1.9662l7.86501,0c1.086,0 1.9663,-0.8803 1.9663,-1.9662l0,-7.86508c0,-1.08594 -0.8803,-1.96626 -1.9663,-1.96626l-7.86501,0z" fill-rule="evenodd"/><path d="m5.09049,10.18526l-1.82767,-1.82766l-0.78479,0.78479l2.61246,2.61246l5.38758,-5.38754l-0.78483,-0.78479l-4.60275,4.60274z"/></svg></span><span>Empty</span></span></div>
                        ]]>
    </checklist>


                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                <customfield id="customfield_10111" key="com.atlassian.jira.toolkit:reporterdomain">
                        <customfieldname>Company</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>magnolia-cms.com</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                <customfield id="customfield_10031" key="com.atlassian.jira.ext.charting:firstresponsedate">
                        <customfieldname>Date of First Response</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Wed, 19 Oct 2022 12:28:52 +0200</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_12730" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_14151" key="com.atlassian.jira.toolkit:message">
                        <customfieldname>Docu info</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                            <customfield id="customfield_10246" key="com.pyxis.greenhopper.jira:gh-epic-link">
                        <customfieldname>Epic Link</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>MGNLREST-390</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10061" key="com.atlassian.jira.toolkit:lastusercommented">
                        <customfieldname>Last comm is not jira-dev</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>true</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10071" key="com.atlassian.jira.toolkit:lastupdaterorcommenter">
                        <customfieldname>Last participant</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>mdrapela</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_13136" key="com.atlassian.jira.toolkit:LastCommentDate">
                        <customfieldname>Last public comment date</customfieldname>
                        <customfieldvalues>
                            1 year, 16 weeks, 4 days ago
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                            <customfield id="customfield_10020" key="com.atlassian.jira.toolkit:attachments">
                        <customfieldname>Number of attachments</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>5.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10150" key="com.atlassian.jira.toolkit:comments">
                        <customfieldname>Number of comments</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10011" key="com.atlassian.jira.toolkit:participants">
                        <customfieldname>Participants</customfieldname>
                        <customfieldvalues>
                                        <customfieldvalue>czimmermann</customfieldvalue>
            <customfieldvalue>mdrapela</customfieldvalue>
    
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                <customfield id="customfield_10833" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>0|hzztx1:1ye8900nu301r</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10244" key="com.pyxis.greenhopper.jira:gh-global-rank">
                        <customfieldname>Rank (Obsolete)</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>9223372036854775807</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10242" key="com.atlassian.jira.plugin.system.customfieldtypes:float">
                        <customfieldname>Story Points</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                <customfield id="customfield_14167" key="com.okapya.jira.checklist:checklist">
                        <customfieldname>Task DoR</customfieldname>
                        <customfieldvalues>
                            
        <checklist>
        <![CDATA[
                            




                
                                    <div class="o-completion" style="display: flex; flex-shrink: 0;"><span  class="aui-lozenge aui-lozenge-complete" style="font-size: 12px; font-weight: normal; display: flex; flex-direction: row; align-items: center;" ><span style="padding-right: 4px; vertical-align: middle;"><svg width="15" height="15" viewBox="0 0 15 15" xmlns="http://www.w3.org/2000/svg" fill="white"><path clip-rule="evenodd" d="m10.41037,3.42544l-7.86501,0c-0.72395,0 -1.31084,0.58688 -1.31084,1.31084l0,7.86508c0,0.7239 0.58689,1.3108 1.31084,1.3108l7.86501,0c0.724,0 1.3109,-0.5869 1.3109,-1.3108l0,-7.86508c0,-0.72396 -0.5869,-1.31084 -1.3109,-1.31084zm-7.86501,-0.65542c-1.08593,0 -1.96626,0.88032 -1.96626,1.96626l0,7.86508c0,1.0859 0.88033,1.9662 1.96626,1.9662l7.86501,0c1.086,0 1.9663,-0.8803 1.9663,-1.9662l0,-7.86508c0,-1.08594 -0.8803,-1.96626 -1.9663,-1.96626l-7.86501,0z" fill-rule="evenodd"/><path d="m5.09049,10.18526l-1.82767,-1.82766l-0.78479,0.78479l2.61246,2.61246l5.38758,-5.38754l-0.78483,-0.78479l-4.60275,4.60274z"/></svg></span><span>Empty</span></span></div>
                        ]]>
    </checklist>


                        </customfieldvalues>
                    </customfield>
                                                                                            <customfield id="customfield_12430" key="com.atlassian.teams:rm-teams-custom-field-team">
                        <customfieldname>Team</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue><![CDATA[26]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                            <customfield id="customfield_14145" key="com.intenso.jira.issue-templates:issue-templates-customfield">
                        <customfieldname>Template</customfieldname>
                        <customfieldvalues>
                            


                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                            <customfield id="customfield_15131" key="com.onresolve.jira.groovy.groovyrunner:scripted-field">
                        <customfieldname>Time in Discovery</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>0</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10032" key="com.atlassian.jira.ext.charting:timeinstatus">
                        <customfieldname>Time in Status</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                            <customfield id="customfield_13933" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Urgency (resolution)</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="15724"><![CDATA[Normal]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                </customfields>
    </item>
</channel>
</rss>