Preview schema migrations
POST /api/v1/ontology/migrations/preview: request fields and declared response contract.
POST/api/v1/ontology/migrations/preview
| Permission | parties.declareKind |
|---|---|
| Workspace scope | required |
| Scope target | workspace |
Request body
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| kind | string | required | non-null | — |
| fields | array | required | non-null | — |
| implements | array | optional | non-null | — |
Response
201
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| data | object | required | non-null | — |
| data.kind | string | required | non-null | — |
| data.diffFingerprint | string | required | non-null | — |
| data.changes | array | required | non-null | — |
| data.impacts | array | required | non-null | — |
| data.classification | "safe" | "warning" | "breaking" | required | non-null | — |
| data.proposedSteps | array | required | non-null | — |
Declared failures
| ONTOLOGY_MIGRATIONS_PREVIEW_FAILED | 400 — not retryable |
|---|
Readback
This method returns the current state it read.
- ontology.migrations.preview
Request example
Schematic only. Replace placeholders with real values and include all required nested fields.
POST /api/v1/ontology/migrations/preview HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>
Content-Type: application/json
{
"kind": "<kind>",
"fields": []
}