Preview Publish federated analysis definition (dry-run)
const url = 'https://api.aerandil.com/v1/actions/hospitality.action.publish_federated_analysis_definition/preview';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"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"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.aerandil.com/v1/actions/hospitality.action.publish_federated_analysis_definition/preview \ --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" } }'Scenario preview of apply_hospitality_action_publish_federated_analysis_definition — runs the action exactly as apply would (validation, handler dispatch, modified-object projection, commit-time cross-link validation) then rolls the transaction back. Returns the modified_objects / modified_links / warnings the apply would have produced without persisting anything or firing any outward effect. Requires the same actions:hospitality.action.publish_federated_analysis_definition:apply scope as apply. No Idempotency-Key.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
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).
object
object
object
object
object
object
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.
object
Responses
Section titled “Responses”Preview computed and rolled back. modified_objects and modified_links carry the effect set the apply would produce; preview is always true.
Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.
object
Per-invocation correlation id; matches events.correlation_id for every event this action appended.
Links established or removed by this invocation. Empty when the caller did not request return_modified.
object
Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.
object
Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.
object
Human-readable summary, suitable for logging or operator-UI surfacing.
Object type the warning was raised against.
Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.
Stable kebab-case rule identifier (e.g. comp-authority-over-limit).
Example
{ "modified_links": [ { "kind": "linked", "link_type": "hospitality.link.federated_program_has_definition" } ], "modified_objects": [ { "kind": "created", "object_type": "hospitality.federated_analysis_definition" } ]}Headers
Section titled “Headers”Always no-store — uncommitted live data.
Conflict — concurrent modification or unique constraint violation the apply would hit.
Validation error — the apply would be rejected.