git.commits.compare

Diff two refs

GET /git/api/repositories/{repoId}/compareIAM git:PullRepositoryReadSensitive read, audited

Request syntax

GET /git/api/repositories/{repoId}/compare

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

Query parameters

  • baseRequired

    string

    The ref the change is measured against, e.g. the target branch

    Constraints: 1-255 chars

  • headRequired

    string

    The ref with the changes; the diff is what it adds since its merge base

    Constraints: 1-255 chars

Response

200 with `patch` (a unified diff), filesChanged, insertions, deletions, and `truncated`, true when the patch holds only the first files.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • patchAlways

    string

    A unified diff of what `head` adds since its merge base with `base`
  • filesChangedAlways

    number

    Files that differ
  • insertionsAlways

    number

    Lines added
  • deletionsAlways

    number

    Lines removed
  • truncatedAlways

    boolean

    true when the patch holds only the first files: the whole diff is over 4 MiB

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow git:PullRepository on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud git commits compare repoId --base example --head example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_git_commits_compare.