Happklaar API
string · required
string · required
string · requiredstring · minLength: 3 · maxLength: 160 · pattern:
string · required
string · required
GET /v1/recipes/meta — canonical filter options for the SPA library page. Auth-gated + tenant-scoped even though the option set is global today (D-18 forward compat)
GET
https://api.happklaar.nl/v1
/recipes/meta
GET /v1/recipes/meta — canonical filter options for the SPA library page. Auth-gated + tenant-scoped even though the option set is global today (D-18 forward compat) › Responses
Recipe.RecipeFilterOptionsData · required
DELETE /v1/recipes/{recipe} — soft-delete on a household-owned recipe
DELETE
https://api.happklaar.nl/v1
/recipes/{recipe}
Soft-delete via Eloquent SoftDeletes — deleted_at is set, the row
persists. Dependent FKs (recipe_ingredients, recipe_cooks,
recipe_ingredient_checks, recipe_notes, recipe_reports) all use
cascadeOnDelete which only triggers on FORCE delete; soft-delete
leaves them intact, preserving history + supporting future restore.
Returns 204 No Content on success. Cross-tenant private 404; system recipe + non-owner-on-community 403.
path Parameters
recipeDELETE /v1/recipes/{recipe} — soft-delete on a household-owned recipe › Responses
No Content
No data returned
PATCH /v1/recipes/{recipe} — partial update on a household-owned recipe
PATCH
https://api.happklaar.nl/v1
/recipes/{recipe}
System recipes are immutable for every caller; community + private recipes are mutable only by the owning household. Cross-tenant 404 (recipe-existence guard, not 403). (split-pass-1).
path Parameters
recipePATCH /v1/recipes/{recipe} — partial update on a household-owned recipe › Request Body
(split-pass-1) — PATCH /v1/recipes/{recipe} request body.
Partial-update wire shape — every field is `Optional` so omitting it
means "leave unchanged". Sending an explicit `null` on a nullable field
means "clear it" (only the columns that are nullable in the schema can
be cleared this way: prep_minutes, cook_minutes, fridge_days,
freezer_days). Required fields (title, description, yields_portions,
freezes_well, status) reject `null` via validation.
The handler maps `Optional` ↔ "not touched" and "explicit null" ↔
"clear". The controller flattens the DTO into the command's
`$touched` whitelist before dispatch.
yields_portionsprep_minutescook_minutesfridge_daysfreezer_daysfreezes_wellstatusEnum values:
draft
published
archived
titledescriptionPATCH /v1/recipes/{recipe} — partial update on a household-owned recipe › Responses
Recipe.RecipeData · required
PATCH /v1/recipes/{recipe}/slug — owner-gated slug rename. Slug uniqueness enforced by the handler (DB unique index `recipes_slug_unique`)
PATCH
https://api.happklaar.nl/v1
/recipes/{recipe}/slug
path Parameters
recipePATCH /v1/recipes/{recipe}/slug — owner-gated slug rename. Slug uniqueness enforced by the handler (DB unique index `recipes_slug_unique`) › Request Body
slug^[a-z0-9]+(?:-[a-z0-… · requiredPATCH /v1/recipes/{recipe}/slug — owner-gated slug rename. Slug uniqueness enforced by the handler (DB unique index `recipes_slug_unique`) › Responses
Recipe.RecipeData · required
PUT /v1/recipes/{recipe}/ingredients — full-replace ingredient list. (D-17 / D-18 / T-16-03-T4 transactional)
PUT
https://api.happklaar.nl/v1
/recipes/{recipe}/ingredients
path Parameters
recipePUT /v1/recipes/{recipe}/ingredients — full-replace ingredient list. (D-17 / D-18 / T-16-03-T4 transactional) › Request Body
object[] · required
PUT /v1/recipes/{recipe}/ingredients — full-replace ingredient list. (D-17 / D-18 / T-16-03-T4 transactional) › Responses
Eager-load ingredients.ingredient so the response-DTO build path
(RecipeData::fromRecipe → IngredientData::fromRecipeIngredient) does
not trigger Eloquent strict-mode LazyLoadingViolationException on
each $row->ingredient access. Mirrors the D-27 idiom already shipping
in ShowRecipeQueryHandler.
Recipe.RecipeData · required
PUT /v1/recipes/{recipe}/steps — full-replace ordered step list. Steps are translatable jsonb; the request body carries `{nl: [...], en: [...]}`
PUT
https://api.happklaar.nl/v1
/recipes/{recipe}/steps
path Parameters
recipePUT /v1/recipes/{recipe}/steps — full-replace ordered step list. Steps are translatable jsonb; the request body carries `{nl: [...], en: [...]}` › Request Body
array[] · required
PUT /v1/recipes/{recipe}/steps — full-replace ordered step list. Steps are translatable jsonb; the request body carries `{nl: [...], en: [...]}` › Responses
Recipe.RecipeData · required