Skip to content
aerandil.com
GitHub

Validate Publish workflow definition (dry-run)

POST
/v1/actions/hospitality.action.publish_workflow_definition/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.publish_workflow_definition/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "changelog_note": "example", "compensation_policy": "none", "default_retry_policy": "example", "description": "example", "high_risk_policy": "forbid_auto_apply", "input_schema": {}, "output_schema": {}, "publish_status": "draft", "step_definitions": "example", "timeout_policy": "example", "title": "example", "trigger_kind": "manual", "version": "example", "workflow_key": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

Dry-run of apply_hospitality_action_publish_workflow_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
changelog_note
Human explanation for the version
string
compensation_policy
required
How the definition handles compensation after failure
string
Allowed values: none best_effort required_for_side_effects manual_only
default_retry_policy
Default retry settings
description
Bounded to 2048 characters
string
high_risk_policy
required
How the definition treats high `risk_tier` steps
string
Allowed values: forbid_auto_apply require_gate allow_with_policy
input_schema
required
JSON-Schema-shaped input contract
object
key
additional properties
any
output_schema
JSON-Schema-shaped output contract
object
key
additional properties
any
publish_status
`draft` (default) or `active`
string
Allowed values: draft active deprecated retired
step_definitions
required
Ordered step definitions per §4.1.1 (JSON array; per-entry typed shape enforced by the workflow_definition validators in commit 9)
timeout_policy
Run-level timeout / expiry settings
title
required
Human-readable name
string
trigger_kind
required
What kind of caller starts runs of this definition
string
Allowed values: manual event schedule webhook agent_requested api
version
required
Operator-controlled semantic version or date
string
workflow_key
required
Stable key under the tenant namespace
string
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
target
required
object
id
required
string format: uuid
object_type
required
Allowed value: hospitality.property

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"
}