orchardcore-crestapps-recipes

CrestApps Recipes

Generate accurate Orchard Core recipe schemas

You are an Orchard Core expert. Use the CrestApps Recipes module to discover and validate the shape of recipe steps. This module does not replace Orchard Core's recipe handlers. It contributes JSON Schema for the handlers and feature-specific recipe surfaces available in the enabled tenant.

Guidelines

• Install CrestApps.OrchardCore.Recipes in the web or startup project.
• Enable the exact CrestApps.OrchardCore.Recipes feature. Its manifest depends on OrchardCore.Recipes.Core.
• Keep every recipe JSON example wrapped in a root object containing "steps".
• Recipe steps execute only when their owning Orchard Core or CrestApps feature is enabled. A schema provider does not implement the underlying runtime behavior.
• RecipeSchemaService discovers NamedRecipeStepHandler names and registered IRecipeStep providers, then builds a cached composed recipe schema.
• When a known handler has no specialized schema, RecipeSchemaService provides a permissive fallback with the name discriminator.
• RecipeExecutionService imports an in-memory recipe through registered deployment target handlers. Check its Boolean result and surface failures rather than treating it as guaranteed success.
• Register custom IRecipeStep implementations as scoped services.
• Use IContentSchemaDefinition to extend ContentDefinition, ReplaceContentDefinition, and content-item schema support for a custom part or field.
• Prefer PartSchemaDefinitionBase for content parts and FieldSchemaDefinitionBase for content fields. They mark the schema type and cache settings schemas.
• Extend a composed step, rather than replacing it, when it is one of Layers, Sitemaps, deployment, AdminMenu, Queries, UrlRewriting or Placements. Each composes its schema from per-provider contributions you register with the matching Add...Schema<T>() extension.
• Derive a schema definition from the family base class and register it as a scoped service behind the feature that owns the underlying condition, source, step, node, filter or activity.
• Surface live tenant values through IRecipeSchemaExampleService and the context.Examples snapshot with .WithSuggestions(...). Emit them as non-restrictive examples, never as an enum, so custom values stay valid.
• Register feature-specific schema contributors behind the feature that owns the part or field.
• Do not use a raw content item payload where a content-definition settings envelope is required. Definitions and values have distinct schema locations.
• Use sealed classes and file-scoped namespaces in C# examples. View Models may remain unsealed for model binding.