Klineo/Docs
Open app ↗

API schemas

MigrationPlanLeg

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
index Yes integer Minimum: 0
legId Yes string —
route Yes string Allowed: FORWARD, ROLLBACK
kind Yes string Allowed: WITHDRAW, HOLD_CHECKPOINT, DEPLOY, VERIFY, ROLLBACK_CHECKPOINT, ROLLBACK_WITHDRAW_TARGET, ROLLBACK_REDEPLOY_SOURCE, ROLLBACK_VERIFY_SOURCE
venueId Yes string —
capitalQuote Yes AtomicAmount —
minimumDepthAfterQuote Yes AtomicAmount —
maximumSlippagePips Yes Pips —
dependsOnLegId No string —
requiresPreviousLegFinalizedAndReconciled Yes boolean —
conditional Yes boolean —
controllerExecution No ControllerExecutionBindingV2 —
economicBinding No MigrationLegEconomicBindingV2 —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Exact definition: #/components/schemas/MigrationPlanLeg in the OpenAPI contract.