Skip to content
aerandil.com
GitHub

Validate Request approval gate (dry-run)

POST
/v1/actions/hospitality.action.request_approval_gate/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.request_approval_gate/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "approval_strategy": "any_one", "context_snapshot": "example", "eligible_principal_ids": [ "example" ], "eligible_role_refs": [ "example" ], "excluded_principal_ids": [ "example" ], "expires_at": "2026-04-15T12:00:00Z", "external_reference": "example", "gate_key": "example", "notification_target": "in_product", "required_approval_count": 1, "risk_tier": "read_only" }, "return_modified": false }'

Dry-run of apply_hospitality_action_request_approval_gate’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_strategy
required
How the gate combines decisions
string
Allowed values: any_one all quorum role_based ordered_chain separation_of_duties
context_snapshot
required
Frozen, redacted facts shown to approvers
eligible_principal_ids
Exact eligible principals (Principal::stable_id() shape)
Array<string>
eligible_role_refs
Staff roles / groups that may approve
Array<string>
excluded_principal_ids
Requesting agent / author / conflicted principals
Array<string>
expires_at
Gate timeout
string format: date-time
external_reference
Slack ts, Linear issue id, PMS task id, email thread id, etc.
string
gate_key
required
Stable within the workflow run or action correlation id
string
notification_target
Where the gate notification surfaced
string
Allowed values: in_product slack linear email pms_task webhook other
required_approval_count
Required for approval_strategy = quorum
integer
risk_tier
required
Risk tier of the guarded step / action
string
Allowed values: read_only internal_write guest_message money_movement identity_or_fraud clinical_or_regulated other_high_risk
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"
}