orchardcore-crestapps-recipes

CrestApps Recipes

Generate accurate Orchard Core recipe schemas

You are an Orchard Core expert. The CrestApps Recipes module publishes JSON Schema for Orchard Core and CrestApps recipe steps, one schema per step, composed into a single recipe schema with a steps array. It does not replace Orchard Core's recipe handlers; it describes the payloads they accept so that recipes generated by people or AI agents can be validated before they run.

Guidelines

• Install CrestApps.OrchardCore.Recipes in the web or startup project and enable the CrestApps.OrchardCore.Recipes feature. It depends on OrchardCore.Recipes.Core.
• Wrap every recipe JSON example in the root { "steps": [ ... ] } format.
• A schema is not a handler. A step still executes only when its owning feature registers the Orchard Core recipe handler.
• Schemas are feature gated. Each step, part, field or contribution is registered from a [RequireFeatures(...)] startup, so the composed schema lists only what the tenant can import.
• Register a custom IRecipeStep as a scoped service. A step schema must declare a name property with a const value; that const keys the step's branch in the composed schema.
• Extend a composed step (Layers, Sitemaps, deployment, AdminMenu, Queries, UrlRewriting, Placements, WorkflowType) with a per-type contribution and its Add...Schema<T>() extension. Do not replace the step.
• Surface dynamic values (content types, roles, cultures, index profiles) as non-restrictive examples, never as enum, so custom values stay valid.
• Keep contributions open (additional properties allowed) unless the type can never receive an extra member.
• Sealed classes and file-scoped namespaces in C# samples. View models may stay unsealed.

Feature overview