Get Branch Diff

Compare a feature branch to its base branch and return every change that would be reviewed before a merge. Repeated path filters limit the diff to selected files and bypass the usual large-file filtering for those requested paths.

JWT claims

Required scopes: git:read
Requires per repo scope: Yes

GET /api/repos/{repo_name}/branches/diff

Get Branch Diff

cURL

curl --request GET \
  --url https://api.{cluster}.code.storage/api/repos/{repo_name}/branches/diff \
  --header 'Authorization: Bearer <token>'

200

{
  "base": "main",
  "branch": "feature/new-feature",
  "files": [
    {
      "bytes": 2048,
      "is_eof": true,
      "path": "src/main.go",
      "raw": "diff --git a/src/main.go b/src/main.go\n...",
      "state": "M"
    }
  ],
  "filtered_files": [
    {
      "bytes": 50000,
      "is_eof": true,
      "path": "package-lock.json",
      "state": "M"
    }
  ],
  "merge_base_sha": "a2d127e6a4d54bb7390de828a99e36411f0c84df",
  "stats": {
    "additions": 50,
    "changes": 60,
    "deletions": 10,
    "files": 3
  }
}

Authorizations

Authorization · string · header · required

JWT bearer token signed with your organization's registered signing key. There is no OAuth authorization server; you mint tokens yourself and the token's scopes claim carries the granted permission scopes. Public scopes: git:read (read repository contents), git:write (write branches, commits, tags, and notes), repo:write (create and manage repositories), org:read (list an organization's repositories). Each operation's security requirement names the scopes it requires. See https://code.storage/docs/getting-started/authentication for how to mint tokens.

Path Parameters

repo_name · string · required

Repository name. Names that contain / or any other character that is not safe in a URL path segment must be URL encoded so the value occupies a single path segment. For example pierre/example is sent as pierre%2Fexample. Plain names such as example can be sent as-is. The server URL-decodes the value before resolving the repository.

Query Parameters

branch · string · required

Branch name to diff.

base · string

Optional base branch or ref to diff against.

ephemeral · boolean

Whether branch should be resolved from the ephemeral namespace.

ephemeral_base · boolean

Whether base should be resolved from the ephemeral namespace.

path · string[]

Optional repeated path filter. Provide multiple path query values to restrict the diff to specific files or directories.

Response

200

application/json

Diff between a source branch and its base, including the merge base used for the three-dot comparison.

Diff between a branch and its base, including merge base, aggregate stats, and per-file changes.

base · string · required

The base branch or ref used for comparison.

Example:

"main"

branch · string · required

The branch name being diffed.

Example:

"feature/new-feature"

files · object[] · required

Files returned with inline diff content.

Show child attributes

filtered_files · object[] · required

Files filtered out of inline diff output because of size or file-type rules.

Show child attributes

merge_base_sha · string · required

Merge base SHA used for the three-dot branch diff.

Example:

"a2d127e6a4d54bb7390de828a99e36411f0c84df"

stats · object · required

Aggregate diff statistics.

Show child attributes