Skip to content
aerandil.com
GitHub

Validate Define metric (dry-run)

POST
/v1/actions/hospitality.action.define_metric/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.define_metric/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "description": "example", "display_name": "example", "formula_expression": "example", "grain": "property_day", "name": "example", "owner": "example", "referenced_fields": [ "example" ], "referenced_object_types": [ "example" ], "unit": "money" }, "return_modified": false }'

Dry-run of apply_hospitality_action_define_metric’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
description
required
Disambiguating prose — the definition operators sign off on
string
display_name
required
Display name
string
formula_expression
required
Canonical formula expression (governed prose, not executed)
string
grain
required
Organisational-unit × period grain
string
Allowed values: property_day property_month venue_day venue_month outlet_day brand_month portfolio_month tenant_month
name
required
Stable metric name (snake_case)
string
owner
required
Accountable team / principal for the definition
string
referenced_fields
required
Registered `<object_type>.<property>` fields the formula reads
Array<string>
referenced_object_types
required
Registered object-type names the formula reads
Array<string>
unit
required
Unit the metric's value carries
string
Allowed values: money ratio percent count hours native_unit
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"
}