Skip to content
aerandil.com
GitHub

Validate Publish federated output (dry-run)

POST
/v1/actions/hospitality.action.publish_federated_output/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.publish_federated_output/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "applicability_statement": "example", "artifact_hash": "example", "artifact_reference": "example", "cohort_summary": {}, "confidence_intervals": "example", "datasheet_reference": "example", "downstream_use_restrictions": "example", "expires_at": "2026-04-15T12:00:00Z", "metric_values": "example", "model_card_reference": "example", "noise_parameters": {}, "output_kind": "benchmark_report", "output_schema_version": "example", "privacy_budget_spend": "example", "privacy_guarantee_summary": {}, "published_to_scope": "program_owner", "review_gate_id": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.federated_output" } }'

Dry-run of apply_hospitality_action_publish_federated_output’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
applicability_statement
required
What the output can and cannot support
string
artifact_hash
Required when artifact_reference is set
string
artifact_reference
Model artifact / report / card if stored externally
string
cohort_summary
required
Buckets; not named participants unless internal portfolio (JSON)
object
key
additional properties
any
confidence_intervals
Required where output is statistical (JSON)
datasheet_reference
Required for model artifacts and benchmark exports
string
downstream_use_restrictions
required
Required
string
expires_at
Required for model artifacts unless waived
string format: date-time
metric_values
Bounded aggregate values (JSON)
model_card_reference
Required for model artifacts and signal packages
string
noise_parameters
Bounded mechanism metadata (JSON)
object
key
additional properties
any
output_kind
required
Output kind
string
Allowed values: benchmark_report calibration_curve aggregate_metric model_artifact signal_package governance_card
output_schema_version
required
Required
string
privacy_budget_spend
required
Committed budget spend (JSON)
privacy_guarantee_summary
required
Mechanisms, epsilon / delta, thresholds (JSON)
object
key
additional properties
any
published_to_scope
required
Output access scope
string
Allowed values: program_owner participants public_aggregate specific_recipients
review_gate_id
Required when output review is required
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.federated_output

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