Compare refs

Compare two refs (commit/branch/workspace/tag/tree) in this repo

GET /repos/{repo_id}/compare

Compare two refs (commit/branch/workspace/tag/tree) in this repo

cURL

curl --request GET \
  --url https://api.diversion.dev/v0/repos/{repo_id}/compare \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "base_item": {
        "path": "hello.cc",
        "prev_path": "<string>",
        "mtime": "2023-11-07T05:31:56Z",
        "blob": {
          "storage_uri": "repo_id/2aae6c35c94fcfb415dbe95f408b9ce91ee846ed",
          "size": 123,
          "sha": "<string>"
        }
      },
      "other_item": {
        "path": "hello.cc",
        "prev_path": "<string>",
        "mtime": "2023-11-07T05:31:56Z",
        "blob": {
          "storage_uri": "repo_id/2aae6c35c94fcfb415dbe95f408b9ce91ee846ed",
          "size": 123,
          "sha": "<string>"
        }
      }
    }
  ],
  "cascaded_changes_count": 123
}

Authorizations

Authorization · string · header · required

This API uses OAuth 2 with the implicit grant flow

Path Parameters

repo_id · string · required

The repo ID of the repository. Repo name can be used instead of the ID, but usage of ID for permanent linking and API requests is preferred.

Required string length: 3 - 128

Example:

"example_id"

Query Parameters

base_id · string · default: ""

A workspace_id, branch_id, commit_id or tag_id. If omitted, assuming the empty tree, unless other_id is a workspace, in which case base_id is assumed to be the workspace base ref.

Maximum string length: 128

other_id · string

A reference to a source version from which changes will be taken

Required string length: 3 - 128

Example:

"example_id"

Response

200 - application/json

A list of tree comparison objects

object · enum<string> · required

Available options: ComparisonItem

items · object[] · required

Show child attributes

cascaded_changes_count · integer<int64> · required

Number of cascaded changes, for insight of total compare size