CompareResponse

Shape

• aheadinteger · int320–∞Commits on head not on base.
• base_shaCommitHash (string)Tip commit of the base (target) branch.
• behindinteger · int320–∞Commits on base not on head.
• commitsarray of CommitBounded, newest-first preview of the commits head adds over base.

  • The Commit schema
  • author_emailEmail (string)
  • author_namestring
  • authored_atstring
  • commit_shaCommitHash (string)
  • committed_atstring
  • committer_emailEmail (string)
  • committer_namestring
  • repository_idRepositoryId (string · uuid)
  • short_shaShortCommitHash (string)
  • titlestring
  • author_avatar_urlstring or nulloptional
  • committer_avatar_urlstring or nulloptional
  • messagestring or nulloptional
  • parent_shasarray of CommitHash (string)optional
  • tagsarray of TagName (string)optional
• commits_truncatedbooleantrue when there are more commits than the preview cap returned.
• diffDiffResponseThree-dot file diff. Note diff.base_sha is the merge base (or the base tip when histories are unrelated), not CompareResponse.base_sha.

  • The DiffResponse schema
  • base_shaCommitHash (string)
  • filesarray of DiffFile

    • The DiffFile schema
    • additionsinteger0–∞
    • collapsedbooleanThe patch was intentionally withheld (generated or oversized) to save bytes but is fetchable in full on demand via GET .../diff-file. Only ever set when patches were requested (include_patch=true).
    • deletionsinteger0–∞
    • generatedbooleanDetected generated/lock/minified file. Always computed from the path, independent of collapsed, so a client can badge or auto-fold it.
    • is_binaryboolean
    • patch_truncatedbooleanThe patch exceeds the hard per-file size cap and is omitted. Unlike collapsed, this file is not expandable in place — a client reads it piece-by-piece via GET .../file-lines instead.
    • pathstring
    • statusDiffFileStatusaddedmodifieddeletedrenamedcopied
    • collapse_reasonCollapseReasongeneratedlargeor nulloptionalWhy a file's patch body was withheld from a DiffFile (see collapsed). Distinct from patch_truncated, which marks a patch too large to ever send; a collapsed file's patch is fetchable on demand via GET .../diff-file.
    • old_pathstring or nulloptional
    • patchstring or nulloptional
  • has_morebooleanAnother page follows this one.
  • head_shaCommitHash (string)
  • pageinteger0–∞The page returned, from 0.
  • statsDiffStats

    • The DiffStats schema
    • additionsinteger0–∞Lines added across the whole change.
    • deletionsinteger0–∞Lines deleted across the whole change.
    • files_changedinteger0–∞Every file the change touches.
  • total_filesinteger0–∞How many files the pages can reach — every changed file, unless truncated.
  • truncatedbooleanThe change touches more files than any page can reach. stats still counts all of them.
• head_shaCommitHash (string)Tip commit of the head (source) branch.
• total_commitsinteger · int320–∞Total commits the comparison contains (== ahead, uncapped).
• merge_base_shaCommitHash (string) or nulloptionalCommon ancestor of base and head. null when the two branches have unrelated histories (no common ancestor); the diff then degrades to a direct two-dot comparison against the base tip.

Graph

Used by