Versions Compared

Old Version 50

changes.mady.by.user Christoph Meier

Saved on

compared with

New Version 51

changes.mady.by.user Christoph Meier

Saved on

Key

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

...

Expand
titleClick to see the resulting JSON


Code Pro
languagejs
[
  {
    "@name": "The-Trans-Siberian-Railway",
    "@path": "/magnolia-travels/The-Trans-Siberian-Railway",
    "name": "The Trans-Siberian Railway",
    "description": "A fascinating tour through Russia.",
    "location": "Vladivostok, Russia",
    "tourTypes": [
      "e007e401-1bf8-4658-8293-b9c743784264"
    ],
    "author": "Magnolia Travels",
    "body_de": "<p>Gehen Sie auf eine epische Zugfahrt, die &uuml;ber ein Drittel der Welt verl&auml;uft, in Vladivostok, Russlands gr&ouml;&szlig;ter Hafenstadt, beginnt und im majest&auml;tischen Moskau endet. Die legend&auml;re Transsibirische Eisenbahn verl&auml;uft von der mongolischen Steppe zu den fernen Ufern des Baikalsees und zu den schneebedeckten Bergen des Urals; sie gibt Ihnen einen seltenen Einblick in die so unterschiedlichen Landschaften Russlands. Im Komfort Ihres Luxus-Zuges erfahren Sie mehr &uuml;ber die russische Geschichte von den Mongolen bis zu den Zaren und Kommunisten.</p> ",
    "body": "<p>Set out on an epic train journey that goes across one-third of the world, starting in Vladivostok, Russia&rsquo;s biggest port city, &nbsp;and ending in majestic Moscow. The legendary Trans-Siberian Railway goes from the Mongolian steppe to Lake Baikal&rsquo;s remote shores to the snow-capped Ural Mountains, giving you a rare view on Russia&rsquo;s vastly differing landscapes. You&rsquo;ll be able to find out more about Russian history, from the Mongols right through to Tsars and communists, all from the comfort of your luxury train.</p> ",
    "description_de": "Faszinierende Reise durch Russland",
    "destination": [
      "6cc50e28-fb0e-4e49-b3b6-728690a2e861"
    ],
    "duration": "21",
    "name_de": "Die Trans-Sibirische Eisenbahn",
    "image": "jcr:5d3a5a2c-dec2-4ac6-915f-0a487aaecf7f",
    "@nodes": []
  }
]


Anchor
configuration
configuration
YAML configuration

Multiexcerpt
MultiExcerptNameconfiguration

The delivery endpoint requires a YAML configuration - 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 URL parameter.)

Add the configuration to the folder restEndpoints in a light module or within src/main/resources/<module-name>/restEndpoints in a Magnolia Maven module.

Basic configuration

Code Pro
titlemy-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: /
  dam:
    depth: 1
    includeSystemProperties: false
    nodeTypes:
      - mgnl:asset
      - mgnl:folder
    rootPath: /travel-demoe

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. You define as many workspaces as you need.

You define one workspace with the below properties. (The definiton class is

Javadoc resource link
classNameinfo.magnolia.rest.delivery.jcr.WorkspaceParameters
renderTypeasynchronous
).

nodeTypes*

required

An list of allowed node types.

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

limit*

optional (default=10)

The number of nodes (of level 0) in the result. Only used in queryNodes method.

*) These properties can be overridden when calling queryNodes with a request parameter.

Configuring reference resolving

..

...