Skip to content

Approve schema migrations

POST /api/v1/ontology/migrations/plans/{planId}/approve: request fields and declared response contract.

POST/api/v1/ontology/migrations/plans/{planId}/approve

Authorization
Permissionontology.migrations.approve
Workspace scoperequired
Scope targetworkspace

Parameters

Path parameters
FieldTypeRequiredNullableDefault
planIdstringrequirednon-null—

Query parameters: none.

Response

200

Response fields
FieldTypeRequiredNullableDefault
dataobjectrequirednon-null—
data.idstringrequirednon-null—
data.companyIdstringrequirednon-null—
data.workspaceIdstringrequirednon-null—
data.kindstringrequirednon-null—
data.diffFingerprintstringrequirednon-null—
data.changesarrayrequirednon-null—
data.impactsarrayrequirednon-null—
data.stepsarrayrequirednon-null—
data.status"draft" | "approved" | "applied" | "abandoned"requirednon-null—
data.createdByMemberIdstringoptionalnon-null—
data.approvedByMemberIdstringoptionalnon-null—
data.appliedAtstringoptionalnon-null—
data.createdAtstringrequirednon-null—
data.updatedAtstringrequirednon-null—

Declared failures

Declared failures
ONTOLOGY_MIGRATIONS_APPROVE_FAILED400 — not retryable

Readback

Read the result back with:

  • ontology.migrations.get

Request example

Schematic only. Replace placeholders with real values and include all required nested fields.

POST /api/v1/ontology/migrations/plans/{planId}/approve HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>