Fetch the diff for a commit artefact

v1.0.0

Fetch the unified diff of a commit artefact's branch against the repository default branch via the team's GitHub integration — using the branch's current tip so the diff reflects the latest state of the work, not just the single recorded commit.

Input

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "project_id": {
      "type": "string"
    },
    "report_id": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "id",
    "project_id",
    "report_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Response for the `commit` artefact diff endpoint — the commit's branch rendered against the\nrepository default branch.",
  "required": [
    "diff",
    "truncated"
  ],
  "properties": {
    "diff": {
      "type": "string",
      "description": "Unified diff (patch) text of the branch against the repository default branch, from the GitHub compare API."
    },
    "truncated": {
      "type": "boolean",
      "description": "True when the diff was too large to return in full and has been truncated."
    }
  }
}