preview_rendering

readSeit v1.0

Rendert ein Rendering gegen ein Element und gibt die entstehende Seite zurück, zusammen mit einem Bericht darüber, was funktioniert hat. Dafür brauchen Sie keine Publikation — das ist das Werkzeug fürs Schreiben eines Renderings, denn create_rendering und update_rendering schreiben das Dokument blind.

Die Diagnosen sind der eigentliche Punkt. Sie sagen Ihnen, wenn ein Abfrageblock nicht gelesen werden konnte, wenn ein Abschnitt auf nichts zutraf (und warum — etwa dass kein Beziehungstyp so geschrieben wird, wie Sie ihn geschrieben haben), wenn ein Block auf einen nie deklarierten Abschnitt verweist und wenn ein Platzhalter niemals aufgelöst werden kann. Ein Abschnitt, der still nichts findet, ist der häufigste Fehler beim Schreiben und in der gerenderten Seite unsichtbar — lesen Sie die Diagnosen also, bevor Sie der Ausgabe trauen.

Übergeben Sie eine locale, um die Seite so zu sehen, wie sie Leser dieser Sprache sehen.

Parameter

Name	Typ	Pflichtfeld	Standard	Beschreibung
`rendering`	`String`	✓		Das Rendering für die Vorschau, per ID oder Name. Finden Sie es über list_renderings.
`format`	`String`	—	markdown	Format der zurückgegebenen Seite: „markdown” ist die lesbare, gut vergleichbare Fassung; „html” ist das, was der Viewer in der App zeigt.
`subject`	`String`	—		Das Element, über das die Seite gerendert werden soll — eine ID, eine Auto-ID wie „SRV-12” oder eine Bezeichnung. Lassen Sie es nur weg bei einem Dokument, in dem es um kein bestimmtes Element geht, etwa der Startseite einer Publikation. Es sollte vom Zieltyp des Renderings sein; passt es nicht, wird trotzdem gerendert und als Warnung gemeldet.
`locale`	`String`	—		Rendert die Seite so, wie Leser dieser Sprache sie sehen (zum Beispiel „de”).

Beispielanfrage

{"rendering": "Service page", "subject": "SRV-12", "format": "markdown"}

Beispielantwort

{"content": "# Payment Capture\n\n...", "format": "markdown", "sections": [{"name": "roles", "kind": "collect", "item_count": 0, "displayed": true}], "diagnostics": [{"severity": "warning", "message": "Section 'roles' resolved to 0 items: no relationship type matches 'composed of'"}]}