Klineo/Docs
Open app ↗

API schemas

MigrationPlan

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
plannerVersion Yes Constant liquidity-migration-v1 —
stateMachineVersion Yes Constant liquidity-migration-state-v1 —
executionVaultId No string Required for AUDITED_TYPED_ADAPTER plans and omitted for PREVIEW_ONLY plans.
sourceVenueId Yes string —
targetVenueId Yes string —
sourceVenueBinding Yes MigrationVenueProfileBinding —
targetVenueBinding Yes MigrationVenueProfileBinding —
capitalQuote Yes AtomicAmount —
temporaryDepthReductionQuote Yes AtomicAmount —
expectedPriceImpactPips Yes Pips —
migrationCostQuote Yes AtomicAmount —
expectedMarketQualityImprovement Yes integer —
executionClass Yes string Allowed: PREVIEW_ONLY, AUDITED_TYPED_ADAPTER
legs Yes Array of MigrationPlanLeg —
rollbackLegs Yes Array of MigrationPlanLeg —
rollbackReason Yes string —
assumptions Yes Array of string —

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/MigrationPlan in the OpenAPI contract.