Run scan, validation, and compilation before rendering a composite template.

Overview

Run scan, validation, and compilation before rendering a composite template. Composite templates improve reuse but add a publish-time compilation step. Treat component and assignment changes as release events.

Key points

• Scan all template and component placeholders.
• Resolve field mappings.
• Compile enabled assignments in order.
• Review the checksum, validation result, and manifest.
• Publish or render only after status returns READY.

Example

curl --request POST \
  "<render-base-url>/api/v1/templates/i/<template-uuid>/compile" \
  --header "x-auth-token: <token>" \
  --header "instance: <instance-uuid>"

Replace bracketed values with values issued for the target environment. Never place production tokens, API keys, or client data in screenshots or public examples.

Recommended procedure

1. Confirm the base package and body are compatible.
2. Select active preamble and postamble components.
3. Set deterministic placement order.
4. Scan, validate, compile, and render a regression sample.

Troubleshooting

Compilation reports a declaration conflict

Rename or centralize variables, parameters, or named templates that share a name but differ in content.

The component order is rejected

Use unique sort-order values within PREAMBLE and POSTAMBLE.

Rendering returns TEMPLATE_COMPILATION_REQUIRED

The compiled package is absent or stale; validate and compile before rendering.

Related documentation

• Manage Stale Composite Templates
• Order Preambles and Postambles
• Assign Components to a Template

Documentation source: feradelinc/feradel.render.api, reviewed against repository revision b2c3a710. Verify behavior against the deployed release before publishing exact routes, limits, or version requirements.