The JSON Preview Client is available together with a Preview URL Service in the module json-preview-client.

Deployment

The JSON preview client is deployed together with the Headless Server. The Headless Server has a dependency to json-preview-client. It is activated with property caas.preview=true which is set for headless-server-preview.

To remove the JSON Preview Client, either remove the dependency to json-preview-client or adapt JsonPreviewClientConfig.java.

JSON Preview Client Configuration

A JSON Preview is available for all content types that have a preview configured. To support specific documenttype properties, corresponding queries can be added in content.graphql.

As the JSON Preview Client is deployed together with the headless-server-preview, the following configuration needs to be applied to headless-server-preview: