Skip to content
aerandil.com
GitHub

Validate Record federated privacy incident (dry-run)

POST
/v1/actions/hospitality.action.record_federated_privacy_incident/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.record_federated_privacy_incident/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "description": "example", "external_incident_reference": "example", "immediate_actions": "example", "incident_kind": "disclosure_control_failure", "pause_program": true, "severity": "informational", "target_object_id": "example", "target_object_type": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.federated_intelligence_program" } }'

Dry-run of apply_hospitality_action_record_federated_privacy_incident’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
Bounded text
string
external_incident_reference
External incident ref
string
immediate_actions
Bounded text describing immediate response (e.g. paused program X, quarantined output Y)
string
incident_kind
required
Incident kind
string
Allowed values: disclosure_control_failure small_cohort_singling_out max_contributor_share_breach differencing_attack_suspected model_inversion_suspected membership_inference_suspected secure_aggregation_protocol_failure data_quality_poisoning_suspected legal_basis_change output_inference_attack other_reviewed
pause_program
If true, transitions program status to paused
boolean
severity
required
informational | low | medium | high | critical
string
Allowed values: informational low medium high critical
target_object_id
required
Target object id
string
target_object_type
required
Program / run / contribution / output
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_intelligence_program

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