Help Center/ CodeArts Repo/ API Reference/ APIs/ Commit/ Querying the Commit Difference Information of a Repository

Updated on 2025-03-28 GMT+08:00

View PDF

Querying the Commit Difference Information of a Repository

Function

This API is used to query commit difference information by commit ID.

URI

GET /v2/projects/{repo_id}/repository/commits/{sha}/diff

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
repo_id	Yes	Integer	Explanation: Repository short ID. Constraints: Mandatory Range: 0–2147483647 Default value: None
sha	Yes	String	Explanation: Commit ID, which is the branch or tag name of the repository. Constraints: Mandatory Range: Minimum length: 40 characters Maximum length: 40 characters Default value: None

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Explanation: User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Constraints: Mandatory Range: 1–100,000 characters. Default value: None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
error	Error object	Explanation: Response error code.
result	Array of DiffCommitInfo objects	Explanation: Response result.
status	String	Explanation: Response status of the API. Range: success: The API call is successful. failed: The API call failed.

**Table 4** Error
Parameter	Type	Description
code	String	Explanation: Error code. Range: Max. 100 characters in the error code format.
message	String	Explanation: Error message. Range: None

**Table 5** DiffCommitInfo
Parameter	Type	Description
old_path	String	Explanation: Old file path.
new_path	String	Explanation: New file path.
a_mode	String	Explanation: Old file mode.
b_mode	String	Explanation: New file mode.
new_file	Boolean	Explanation: Whether to add files during the modification.
renamed_file	Boolean	Explanation: Whether to rename a file during the modification.
deleted_file	Boolean	Explanation: Whether to delete files during the modification.
diff	Boolean	Difference information.

Example Requests

GET https://{endpoint}/v2/projects/859341/repository/commits/master/diff

Example Responses

Status code: 200

{
  "result" : [ {
    "diff" : "@@ -1,4 +1,7 @@\n y_mr_0721\n+\n+![CloudIDE Executed successfully](./image/screenshot.PNG)\n+\n edwwd\n # css \n **hhrh**",
    "old_path" : "README.md",
    "new_path" : "README.md",
    "a_mode" : "100644",
    "b_mode" : "100644",
    "new_file" : false,
    "renamed_file" : false,
    "deleted_file" : false
  } ],
  "status" : "success"
}