Skip to content
aerandil.com
GitHub

Validate Define automation (dry-run)

POST
/v1/actions/hospitality.action.define_automation/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.define_automation/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "approval_policy_ref": "example", "condition_kind": "object_set_added", "cron_expression": "example", "description_text": "example", "display_name": "example", "effect_action": "example", "effect_function": "example", "effect_kind": "apply_action", "effect_notification_template": "example", "effect_params_template": {}, "event_type_ref": "example", "execution_mode": "per_object", "max_cascade_depth": 1, "modified_property_watch": "example", "object_set_filter": "example", "object_type_ref": "example", "requires_approval": true }, "return_modified": false }'

Dry-run of apply_hospitality_action_define_automation’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
approval_policy_ref
Approval policy the staged gate opens under (required when requires_approval)
string
condition_kind
required
Trigger-predicate class
string
Allowed values: object_set_added object_set_removed object_set_modified object_set_all time_cron event_named
cron_expression
Schedule for time_cron (5-field cron)
string
description_text
What this automation is for
string
display_name
required
Human-readable name shown in the operator console
string
effect_action
Registered action to fire (for apply_action)
string
effect_function
Read-only function to invoke (for call_function)
string
effect_kind
required
Effect fired when the condition is met
string
Allowed values: apply_action call_function send_notification
effect_notification_template
Templated notification body/target (for send_notification, JSON)
effect_params_template
Template mapping triggering-object fields → effect input (JSON)
object
key
additional properties
any
event_type_ref
Named domain event watched (required for event_named)
string
execution_mode
Per-object vs batch effect firing (default per_object)
string
Allowed values: per_object batch
max_cascade_depth
Loop guard: max trigger-chain depth before suppression (default 3)
integer
modified_property_watch
Property api-names whose change trips object_set_modified (JSON array)
object_set_filter
Search-filter predicate defining the watched object set (JSON)
object_type_ref
Watched object type (required for object_set_* kinds)
string
requires_approval
Route the effect through a 0020 approval_gate instead of applying
boolean
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"
}