The delivery endpoint requires a YAML configuration or otherwise it cannot deliver content. Version 2.0 of the magnolia-rest-content-delivery module can have only one configuration. Future versions will allow multiple configurations which can be distinguished via a URL parameter. Add the configuration to the restEndpoints folder in a light module or within src/main/resources/<module-name>/restEndpoints in a Magnolia Maven module. Anchor |
---|
| simple-config |
---|
| simple-config |
---|
| Basic configuration Code Pro |
---|
language | yaml |
---|
title | my-lightmodule/restEndpoints /my-endpoint.yaml |
---|
| class: info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpointDefinition
implementationClass: info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpoint
params:
website:
depth: 32
includeSystemProperties: false
nodeTypes:
- mgnl:page
- mgnl:area
- mgnl:component
rootPathchildNodeTypes:
/
dam:
- depthmgnl:area
1
- includeSystemPropertiesmgnl: falsecomponent
nodeTypesrootPath: /
travelling:
- mgnl:assetworkspace: tours
rootPathincludeSystemProperties: /travel-demofalse |
Properties: class | required Must be info.magnolia.rest.delivery.jcr.v1.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 or more workspaces. | <endpointPrefix>
| required Defines an endpoint prefix where requests will be routed and handled according to the associated workspace parameters below. The value can be an arbitrary name (no special characters!) - or it can be a real workspace name. If it is not a real workspace name, you must provide the sub property workspace . | workspace
| optional
The name of the JCR workspace to deliver content from. Must be set if the parent <endpointPrefix> is not a real workspace name. | nodeTypes
| optional default=mgnl:content A list of allowed node types for depth-0 nodes. mgnl:folder is ignored deliberately. | childNodeTypes
| optional default=mgnl:contentNode
A list of allowed node types for child nodes. | depth
| optional, default is 0 The depth of subnodes to display in the result. | includeSystemProperties
| optional, default is true Specifies whether the result should show system properties. | rootPath
| optional The root path of this endpoint. The path information when requesting the endpoint is added to this path. | bypassWorkspaceAcls
| optional, default is false Note |
---|
If set to true , JCR security is bypassed. Use this with care and for development reasons only! |
| limit *
| optional, default is 10 The number of nodes (of level 0) in the result. Used only in the queryNodes method. | *) The property can be overridden when calling queryNodes with a request parameter. Anchor |
---|
| reference-resolving-configuration |
---|
| reference-resolving-configuration |
---|
| Reference resolving configurationA node may contain references to other nodes. With the references property you can extend the configuration to force it to resolve the referenced nodes per workspace. Anchor |
---|
|