Skip to main content

Approve Diff

Approve a pending diff to promote proposed changes to the next live class version. Requires write scope.

Approve a pending diff to promote its proposed field changes into a new class version. Approving a diff updates the class's current_version_id and publishes a new version snapshot with the diff's added fields, removed fields, and type changes applied.

Approving a breaking diff (one that removes fields or changes types) may affect downstream extraction jobs. Review the removed_fields and type_changes arrays before approving.
POST/v1/schema-graph/diffs/{id}/approve

Response

Response fields

idstringDiff UUID.
review_statusstringAlways `approved` on success.

Response

{
  "id": "diff-uuid-1",
  "review_status": "approved"
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundNo diff with this ID exists for your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Approval is synchronous -- the new version is created and current_version_id is updated in the same request. After approving, call GET /v1/schema-graph/classes/{id}/versions to verify the new version appeared, or fetch the updated class via GET /v1/schema-graph/classes/{id} to confirm current_version_id advanced.

Related

List Diffs
Reject Diff