Querying a Commit of a Branch by Repository or Repository Group Name

Description

This API is used to obtain the commit list by repository or repository group name and branch.

URI

GET /v1/repositories/{group_name}/{repository_name}/commits

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
group_name	Yes	String	Repository group name (Segment following the domain name and before the repository name in the clone address. Example: git@repo.alpha.devcloud.test.com:Demo00228/testword.git. Repository group name: Demo00228.)
repository_name	Yes	String	Repository name

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
page_index	No	Integer	Page index
page_size	No	Integer	Number of records on each page
ref_name	Yes	String	Branch or tag name, in SHA format

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
error	Error object	Response error
result	CommitList object	Response result
status	String	Response status

**Table 5** Error
Parameter	Type	Description
code	String	Error codes
message	String	Error message

**Table 6** CommitList
Parameter	Type	Description
commits	Array of Commit objects	Commit list
total	Integer	Total commits

**Table 7** Commit
Parameter	Type	Description
author_email	String	Author email
author_name	String	Author
authored_date	String	Author commit time
committed_date	String	Commit time
committer_email	String	Committer email
committer_name	String	Committer
format	Object	File change details. The format is determined by the stat_format parameter.
id	String	SHA ID of a commit
message	String	Commit message
parent_ids	Array of strings	Parent commit ID

Request Examples

GET https://{endpoint}/v1/repositories/{group_name}/{repository_name}/commits

Response Examples

Status code: 200

Request succeeded

{
  "result" : {
    "total" : 1,
    "commits" : [ {
      "id" : "a27fafa7d8da2dd55f691bef989226d22f50d8ce",
      "message" : "Initial commit",
      "parent_ids" : [ ],
      "authored_date" : null,
      "author_name" : "repo",
      "author_email" : "repo@test.com",
      "committed_date" : "2019-10-15 09:40:29",
      "committer_name" : "repo",
      "committer_email" : "repo@test.com"
    } ]
  },
  "status" : "success"
}