Skip to main content
GET
/
api
/
v1
/
architecture
/
{design_id}
/
diff
Get Architecture Diff
curl --request GET \
  --url https://api.example.com/api/v1/architecture/{design_id}/diff \
  --header 'Authorization: Bearer <token>'
{
  "design_id": "<string>",
  "from_version": 123,
  "to_version": 123,
  "breaking_change_flag": false,
  "changed_fields": [
    "<string>"
  ],
  "layout_changes": [
    {}
  ],
  "requires_arch_review": false,
  "semantic_changes": [
    {}
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
design_id
string
required

Query Parameters

​
from_version
integer
required
Required range: x >= 1
​
to_version
integer
required
Required range: x >= 1

Response

Successful Response

Structural diff between two architecture design versions.

​
design_id
string
required
​
from_version
integer
required
​
to_version
integer
required
​
breaking_change_flag
boolean
default:false
​
changed_fields
string[]
​
layout_changes
Layout Changes · object[]
​
requires_arch_review
boolean
default:false
​
semantic_changes
Semantic Changes · object[]
Last modified on May 17, 2026