Skip to main content

SemanticDiffResult

Result of comparing two versions of a definition, returned by GET /registry/definitions/{id}/semantic-diff.

equivalence_status values: equivalent — same semantic_hash; meaning is identical; safe to promote. compatible — meaning changed but backward-compatible; review recommended. breaking — downstream conditions/actions may be invalidated; governance required before promotion. unknown — could not determine; treat as breaking.

The caller should block on 'breaking' status before promoting to a higher namespace. See py-instructions.md for the governance pattern.

definition_idDefinition Id (string)required
version_fromVersion From (string)required
version_toVersion To (string)required
equivalence_statusEquivalence Status (string)required
summarySummary (string)required
changesobject[]
SemanticDiffResult
{
  "definition_id": "string",
  "version_from": "string",
  "version_to": "string",
  "equivalence_status": "string",
  "summary": "string",
  "changes": [
    {}
  ]
}