Skip to navigation
API referencecontexts

Compare

Authorizes both revisions and returns their manifests, per-file statuses, and one selected file preview. Target defaults to latest; base defaults to the target’s parent, or an empty snapshot for the first revision. The returned IDs are immutable; use them for subsequent file selections. UTF-8 previews verify file digests and are capped at 128000 bytes per side. reason is null, too_large, binary, or too_complex. Omitted previews have empty content and zero counts, which must not be displayed as no changes.

Authentication

AuthorizationBearer

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

Path parameters

trunkIdstringRequiredformat: "^trunk_[A-Za-z0-9]+$"
contextKeystringRequiredformat: "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$"

Query parameters

basestringOptional<=128 characters
targetstringOptional<=128 charactersDefaults to latest
pathstringOptional<=512 characters

Response

{base, target, files: [{path, status, before, after}], preview: {path, before, after, additions, deletions, reason} | null}. File statuses are added, removed, modified, unchanged.

Errors

400
Bad Request Error
404
Not Found Error