Skip to content
Olivares AI docs

A bounded content diff between two refs of one repository owned by a configured source (501 when no git-host diff reader is wired; 422 when the diff exceeds the read cap)

GET
/v1/console/sources/diff
 
curl --request GET \
  --url 'https://example.com/v1/console/sources/diff?source=example&host=github&repository=example&base=example&head=example' \
  --header 'Authorization: Bearer <token>'

Returns one bounded content diff between two refs of a repository owned by a configured source, on GitHub or GitLab. 501 when no git-host diff reader is wired, 422 when the diff exceeds the read cap, 503 with Retry-After when the host rate-limits the read.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “ Query Parameters ”
source
required
string
>= 1 characters

The configured source’s name.

host
required
string
Allowed values: github gitlab

The git host.

repository
required
string
>= 1 characters

The repository (owner/name).

base
required
string
>= 1 characters

The base ref.

head
required
string
>= 1 characters

The head ref.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
files
required
Array<object>
object
binary
required
boolean
hunks
required
Array<string>
path
required
string
previous_path

Set on a rename.

string
status
required
string
truncated
required
boolean
head_commit
required
string
head_tree
string
truncated
required

The diff exceeded the read cap and was cut.

boolean
Example generated 
{
  "files": [
    {
      "binary": true,
      "hunks": [
        "example"
      ],
      "path": "example",
      "previous_path": "example",
      "status": "example",
      "truncated": true
    }
  ],
  "head_commit": "example",
  "head_tree": "example",
  "truncated": true
}

400

Section titled “ 400 ”

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Section titled “ 401 ”

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Section titled “ 403 ”

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Section titled “ 404 ”

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Section titled “ 409 ”

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Section titled “ 429 ”

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}