[DOCU-2914] Update the $type explanation Created: 14/Nov/23  Updated: 16/Nov/23  Resolved: 15/Nov/23

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Bartosz Staryga Assignee: Martin Drápela
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File image-2023-11-15-13-23-15-766.png    
Documentation page URL: https://docs.magnolia-cms.com/headless/api/delivery.html#_configuration
Reporter Name: Bartosz
Email: bartosz.staryga@magnolia-cms.com

 Description   

1/ $type is not required, not even when there is no class.
AFAIK only the workspace is required

2/ Possible values:
can we update that jcrDeliveryEndpoint_v2 needs to be set ONLY if user wants to use inheritance and autogeneration of components

jcrPagesDeliveryEndpoint_v2 is a preconfigured endpoint, so can we put there that using this type is equivalent to having this YAML (yaml based on https://git.magnolia-cms.com/projects/MODULES/repos/pages/browse/magnolia-pages-jcr-rest/src/main/java/info/magnolia/pages/rest/v2/JcrPagesDeliveryEndpointDefinition.java)



 Comments   
Comment by Christopher Zimmermann [ 15/Nov/23 ]

bstaryga this is a typo right? "can we update that jcrDeliveryEndpoint_v2 needs to be set " you meant to say jcrPagesDeliveryEndpoint_v2 there?

Comment by Bartosz Staryga [ 15/Nov/23 ]

czimmermann that one of the confusions i have now
What is the difference between jcrDeliveryEndpoint_v2 and * jcrPagesDeliveryEndpoint_v2{*}?
From code (and i am not good reading Java )

  • jcrDeliveryEndpoint_v2 is simply bringing the inheritance and autogeneration to endpoint
  • jcrPagesDeliveryEndpoint_v2 is preconfigured endpoint, equivalent if i had yaml:
    $type: jcrDeliveryEndpoint_v2 
    workspace: pages
    ...
    ...
    ...

    So if my understanding is correct then no typo

 

 

Generated at Mon Feb 12 01:31:26 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.