Skip to content
aerandil.com
GitHub

Validate Bind development pathway definition (dry-run)

POST
/v1/actions/hospitality.action.bind_development_pathway_definition/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.bind_development_pathway_definition/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "brand_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "discipline": "front_office", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "stages": [ { "code": "example", "display_name": "example", "expected_tenure_years_to_reach": "example", "required_certification_kind": "food_safety_manager", "sort_index": 1 } ] }, "return_modified": false }'

Dry-run of apply_hospitality_action_bind_development_pathway_definition’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
brand_id
Brand scope (exactly one of brand_id / property_id)
string format: uuid
discipline
required
Discipline
string
Allowed values: front_office food_beverage culinary bar housekeeping engineering spa wellness_clinical wellness_coaching sales revenue management other
property_id
Property scope (exactly one of brand_id / property_id)
string format: uuid
stages
required
Ordered pathway stages
Array<object>
object
code
required
string
display_name
required
string
expected_tenure_years_to_reach
string format: decimal
required_certification_kind
string
Allowed values: food_safety_manager food_safety_handler allergen_awareness alcohol_service haccp sommelier wset first_aid cpr pool_lifeguard massage_therapy_license cosmetology_license fire_safety other
sort_index
required
integer
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"
}