Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel3
minLevel2


YAML configuration

The delivery endpoint requires a YAML configuration - otherwise it cannot deliver cannot. Add the configuration to the folder your-light-module/restEndpoints/.

Code Pro
class: info.magnolia.rest.delivery.jcr.JcrDeliveryEndpointDefinition
implementationClass: info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpoint
params:
  website:
    depth: 3
    includeSystemProperties: false
    nodeTypes:
      - mgnl:page
      - mgnl:area
      - mgnl:component
    rootPath: /
    limit: 10
    bypassWorkspaceAcls: true
  dam:
    depth: 1
    includeSystemProperties: false
    nodeTypes:
      - mgnl:asset
      - mgnl:folder
    rootPath: /
    limit: 10
    bypassWorkspaceAcls: false


PropertyValue
class

Required

Must be info.magnolia.rest.delivery.jcr.JcrDeliveryEndpointDefinition or a subclass.

implementationClass

Required

Must be info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpoint or a subclass.

params

Required

The map defining at least one ore more workspace parameters.


Methods

readNode

Returns a node including its properties and child nodes down to a certain depth.

...