Get Commit Diff

Get the diff for a commit, optionally relative to a specific base commit. Repeated path parameters narrow the diff to selected files or directories.

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

GET /api/v1/repos/diff

Get Commit Diff

cURL

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

200

{
  "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"
    }
  ],
  "sha": "b003fc78805954584e1ee364a4ad39d7c79e819a",
  "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

sha · string · required

Commit SHA to diff.

baseSha · string

Optional base commit SHA to diff against. When omitted, the diff is generated against the commit's parent.

path · string[]

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

Response

200

application/json

Full diff for the requested commit, including file-level stats and line-level hunks.

Diff for a single commit, including aggregate stats and per-file changes.

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

sha · string · required

The commit SHA to diff.

Example:

"b003fc78805954584e1ee364a4ad39d7c79e819a"

stats · object · required

Aggregate diff statistics.

Show child attributes