Skip to content
aerandil.com
GitHub

Validate Bind ingredient (dry-run)

POST
/v1/actions/hospitality.action.bind_ingredient/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.bind_ingredient/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "allergen_flags": [ "gluten" ], "brand_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "category": "spirit", "code": "example", "name": "example", "par_quantity": "example", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "unit_canonical": "ml" }, "return_modified": false }'

Dry-run of apply_hospitality_action_bind_ingredient’s parameter checks. No side effects, no idempotency reservation, no handler dispatch — just the schema pass plus action-level shape (target presence, target type, unknown-parameter rejection). return_modified is meaningless here and ignored.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid
params
required
object
allergen_flags
Allergen flags (EU 14 list)
Array<string>
Allowed values: gluten crustaceans eggs fish peanuts soybeans milk nuts celery mustard sesame sulphites lupin molluscs
brand_id
Brand scope (exactly one of brand_id / property_id)
string format: uuid
category
required
Category
string
Allowed values: spirit wine beer liqueur bitters syrup juice garnish_fruit garnish_herb dairy protein produce dry_good spice other
code
required
Operator-assigned SKU / code (natural key)
string
name
required
Display name
string
par_quantity
Par stock level
string format: decimal
property_id
Property scope (exactly one of brand_id / property_id)
string format: uuid
unit_canonical
required
Canonical unit
string
Allowed values: ml cl oz g kg each dash drop rim float scoop other
return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean

Responses

Section titled “Responses”

200

Section titled “200”

Validation outcome. result is valid or invalid; per-parameter diagnostics are always populated for every declared parameter so a UI can render the action’s full surface.

Media typeapplication/json
object
action
required
string
errors

Action-level errors not tied to a single parameter (missing target, target type mismatch, unknown parameter names). Absent when empty.

Array<string>
parameters
required

Per-parameter diagnostics keyed by api_name.

object
key
additional properties
object
errors
Array<string>
result
required
Allowed values: valid invalid
value
required

The serialised value the server interpreted, or null if the parameter was not supplied.

result
required
Allowed values: valid invalid
Example
{
  "parameters": {
    "additionalProperty": {
      "result": "valid"
    }
  },
  "result": "valid"
}