Help Center/ CodeArts Repo/ API Reference/ APIs/ Project/ Obtains the list of repositories that can be set to the public state in a project.
Updated on 2023-09-12 GMT+08:00

Obtains the list of repositories that can be set to the public state in a project.

Function

Obtains the list of repositories that can be set to the public state in a project.

URI

GET /v2/projects/{project_uuid}/repositories/template-status

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_uuid

Yes

String

Project ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

page_no

No

Integer

Indicates the page number.

page_size

No

Integer

Number of data records on each page

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling an IAM API. 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

TemplateListInfo object

Result

status

String

Status code in a response

Table 5 Error

Parameter

Type

Description

code

String

Error Codes

message

String

Error message

Table 6 TemplateListInfo

Parameter

Type

Description

repos

Array of DevstarRepoInfo objects

Repository list

total_count

Integer

Total number of repositories.

Table 7 DevstarRepoInfo

Parameter

Type

Description

uuid

String

UUID of the repository.

repo_id

String

Warehouse ID

repo_name

String

Repository name.

ssh_url

String

SSH address of the repository

code_url

String

Repository HTTPS Address

detail_url

String

Repository Preview Address

Example Requests

GET https://{endpoint}/v2/projects/{project_uuid}/repositories/template-status

Example Responses

Status code: 200

OK

{
  "result" : {
    "repos" : [ {
      "uuid" : "36f532939c4b4e2191c10f5353ccf34c",
      "repo_id" : 487773,
      "repo_name" : "DDDDDDDD",
      "ssh_url" : "git@repo.alpha.devcloud.inhuawei.com:CHEN_TEST00001/DDDDDDDD.git",
      "code_url" : "https://repo.alpha.devcloud.inhuawei.com/CHEN_TEST00001/DDDDDDDD.git",
      "detail_url" : "https://alpha.devcloud.inhuawei.com/repo/487773/home"
    } ],
    "total_count" : 100
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.