Versions Compared

Old Version 12

changes.mady.by.user Christoph Meier

Saved on

compared with

New Version 13

changes.mady.by.user Christoph Meier

Saved on

Key

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

...

Table of Contents
maxLevel3
minLevel2

Methods

readNode

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

Request URL

..

Parameters

..

Example

...

queryNodes

..


YAML configuration

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

...

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. (warning) (warning) Use with care and for development reasons only!

limit

optional (default=10)

The number of nodes (of level 1) in the result.

(question) (question) Only working together with offset ???

Methods

readNode

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

Request URL

..

Parameters

..

Example

...

queryNodes

..

 xx