Validate Publish federated analysis definition (dry-run)

POST

/v1/actions/hospitality.action.publish_federated_analysis_definition/validate

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.publish_federated_analysis_definition/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "aggregation_method": "plain_aggregate_reviewed", "algorithm_family": "secure_sum", "analysis_kind": "federated_analytics", "cohort_policy": {}, "composition_group": "example", "contribution_bounds": {}, "datasheet_template_ref": "example", "definition_api_name": "example", "delta_per_run": "example", "dpia_reference": "example", "epsilon_per_run": "example", "forbidden_field_classes": [ "example" ], "input_field_allowlist": [ "example" ], "input_object_types": [ "example" ], "local_code_digest": "example", "local_code_reference": "example", "local_execution_requirements": {}, "local_feature_contract": {}, "minimum_local_runner_version": "example", "model_card_template_ref": "example", "objective": "example", "output_review_required": true, "output_schema": {}, "privacy_mechanisms": [ "cohort_threshold" ], "publish_status": "draft", "recommended_local_runner_version": "example", "threat_model_ref": "example", "version": "example", "weighting_method": "unweighted" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.federated_intelligence_program" } }'

• Production API

Dry-run of apply_hospitality_action_publish_federated_analysis_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

• aerandil_oauth
  objects:read

Request Body^required

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

aggregation_method

required

Aggregation method

string

Allowed values: plain_aggregate_reviewed secure_sum noisy_count noisy_sum noisy_mean noisy_histogram noisy_quantile trimmed_mean weighted_average fedavg external_clean_room reviewed_custom

algorithm_family

required

Algorithm family

string

Allowed values: secure_sum count_rate histogram quantile calibration_curve outcome_decay fedavg fedxgb reviewed_custom

analysis_kind

required

Analysis kind

string

Allowed values: federated_analytics federated_learning private_set_intersection clean_room_query benchmark_export

cohort_policy

required

Minimums and suppression rules; may inherit from program (JSON)

object

key

additional properties

any

composition_group

Groups related definitions for privacy-budget composition

string

contribution_bounds

required

Min / max / clipping norms / per-participant caps (JSON)

object

key

additional properties

any

datasheet_template_ref

Required for benchmark exports and model artifacts

string

definition_api_name

required

Stable slug within program

string

delta_per_run

Required for approximate DP mechanisms

string format: decimal

dpia_reference

Required when program or definition is high-risk

string

epsilon_per_run

Required if DP applies

string format: decimal

forbidden_field_classes

required

Defaults applied if empty

Array<string>

input_field_allowlist

required

Fully qualified field paths or named derived features

Array<string>

input_object_types

required

Aerandil object types eligible for local reads

Array<string>

local_code_digest

Required when local_code_reference is set

string

local_code_reference

Optional code package / container / runner ref

string

local_execution_requirements

required

Runner version, memory / timeout bounds, offline mode, network policy (JSON)

object

key

additional properties

any

local_feature_contract

required

Bounded schema for local features and aggregate vectors (JSON)

object

key

additional properties

any

minimum_local_runner_version

Optional per-definition hard floor; effective floor is max of program-pin and this value (semver)

string

model_card_template_ref

Required for model artifacts

string

objective

required

What question the run answers

string

output_review_required

required

True by default for cross-tenant and model outputs

boolean

output_schema

required

Bounded output shape (JSON)

object

key

additional properties

any

privacy_mechanisms

required

Required; at least cohort_threshold for cross-tenant outputs

Array<string>

Allowed values: cohort_threshold contribution_bounding differential_privacy secure_aggregation secure_multiparty_computation homomorphic_encryption private_set_intersection trusted_execution_environment manual_statistical_disclosure_control none_internal_portfolio_only

publish_status

draft (default) or reviewing

string

Allowed values: draft reviewing approved deprecated revoked

recommended_local_runner_version

Optional per-definition soft baseline; effective baseline is max of program-pin and this value (semver)

string

threat_model_ref

Required for cross-tenant programs

string

version

required

Semver-like

string

weighting_method

required

Weighting method

string

Allowed values: unweighted room_nights available_rooms eligible_events revenue reviewed_custom

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_intelligence_program

Responses

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