Compose a Publication
The goal of the composition endpoint is to gather all required information to render a document in one endpoint and to work for different rendering strategies (e.g. render from JSON or use the prerendered Html). The composition Api supports rendering Html without any configuration, can preload references in metadata and can return resolved includes as JSON.
It offers optimised performance for all those tasks and will replace the RenderPipeline feature.
We plan to add additional functionalities like automatic design updates of documents and more to the composition Api in upcoming releases and are open for inputs what we could add.
|fields||array<string>||A list of the properties which should be computed and returned.
Default: [‘systemdata’, ‘content’, ‘metadata’, ‘includes’, ‘html’, ‘design’]
|metadata.preload||object||You can pass metadata properties which should be resolved.
This only works for properties of type ‘li-reference’, ‘li-document-reference’, ‘li-reference-list’ and ‘li-list-reference’
|resolveIncludes||boolean||Resolve includes. If
|renderOptions.decodeHtml||boolean||Decode html entities into unicode|
|renderOptions.renderDirectiveInfo||boolean||Add attributes with the directive name to directive elements.|