Get Branch Diff

GET

api

repos

branches

diff

Get Branch Diff

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

import requests

url = "https://api.{cluster}.code.storage/api/v1/repos/branches/diff"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.{cluster}.code.storage/api/v1/repos/branches/diff', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.{cluster}.code.storage/api/v1/repos/branches/diff",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.{cluster}.code.storage/api/v1/repos/branches/diff"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.{cluster}.code.storage/api/v1/repos/branches/diff")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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
  }
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

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

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

Get CommitResolve a branch name, short SHA, or full SHA to a commit and return the same metadata shape used in commit listings. Use this when you need commit details without computing a diff. #### JWT claims Required scopes: `git:read` Requires per repo scope: Yes Deprecated: Use `/api/repos/{repo_name}/commit` instead.

Get Branch Diff

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

import requests

url = "https://api.{cluster}.code.storage/api/v1/repos/branches/diff"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.{cluster}.code.storage/api/v1/repos/branches/diff', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.{cluster}.code.storage/api/v1/repos/branches/diff",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.{cluster}.code.storage/api/v1/repos/branches/diff"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.{cluster}.code.storage/api/v1/repos/branches/diff")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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
  }
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

Getting Started

Guides

Reference

JWT claims

Authorizations

Query Parameters

Response