Page History

...

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

Code Pro

title	my-endpoint.yaml

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

Properties:

`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.
`<workspace-name>`	required The name of the JCR workspace to deliver content from.
`depth`	optional (default=0) The depth of subnodes to shwo in the result
`includeSystemProperties`	optional (default=true) Whether the result should show the system properties.
`rootPath`	required The root path of this endpoint. Path information when requesting the endpoint is added to this path.
`bypassWorkspaceAcls`	optional (default=false) When set to true JCR security is bypassed. Use with care and for development reasons only!
`limit`	optional (default=10) The number of nodes (of level 1) in the result. Only working together with `offset` ???

xx

Page tree

Versions Compared

Old Version 13

New Version 14

Key