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.

Deprecated: Use /api/repos/{repo_name}/branches/diff instead.

GET /api/v1/repos/branches/diff

Get Branch Diff

cURL

curl --request GET \
  --url https://api.{cluster}.code.storage/api/v1/repos/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"
    }
  ],
  "stats": {
    "additions": 50,
    "changes": 60,
    "deletions": 10,
    "files": 3
  }
}

Authorizations

Authorization · string · header · required

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

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, suitable for pre-merge review.

Diff between a branch and its base, including 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

stats · object · required

Aggregate diff statistics.

Show child attributes