CreateRepository - 创建代码库

创建代码库。

适用版本

企业标准版

服务接入点与授权信息

请求语法

POST https://{domain}/oapi/v1/codeup/organizations/{organizationId}/repositories

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

组织 ID。

99d1****71d4

-

object

body

avatarUrl

string

body

代码库头像地址。

https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100

description

string

body

代码库描述内容,最长不超过65535个字符。

codeup repo description

name

string

body

代码库名称。

Demo库

namespaceId

integer

body

代码库父路径 ID,若为空,则创建在组织路径下。

2022(需要保证当前用户在父路径下有创建代码库的权限;若需要创建父路径,那么namespaceId需要设置为组织的空间ID)

path

string

body

代码库路径。

Demo库(与name保持同层级,name与path的值可以不同,若带上了父路径,那么需要设置createParentPath字段为true,且父路径前面不加斜杠,如 parentPath/demo)

readMeType

string

body

自动创建 readme 类型: EMPTY - 空,USER_GUIDE - 引导 readme 文件。

USER_GUIDE

templateProject

object

body

syncAllBranches

boolean

body

是否导入模板库所有分支。

false

templateProjectId

integer

body

模板库 ID。

1

templateType

integer

body

模板类型,1-自定义模板,2-系统预置模板。

1

visibility

string

body

代码库的可见性: private - 私有,internal - 组织内公开,public:公开。

private

请求示例

curl -X 'POST' \
  'https://test.rdc.aliyuncs.com/oapi/v1/codeup/organizations/{organizationId}/repositories' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
        "description": "codeup repo description",
        "name": "Demo库",
        "namespaceId": 0,
        "path": "",
        "readMeType": "",
        "templateProject": {
            "syncAllBranches": false,
            "templateProjectId": 1,
            "templateType": 1
        },
        "visibility": "private"
    }'

返回参数

参数

类型

描述

示例值

-

object

accessLevel

integer

当前用户在该代码库上的权限类型。

archived

boolean

代码库是否归档。

false

avatarUrl

string

头像地址。

""

createdAt

string

创建时间。

2022-01-14T21:08:26+08:00

creatorId

integer

代码库创建者。

1233

demoProject

boolean

是否是 demo 库。

false

description

string

代码库描述。

线下测试

encrypted

boolean

是否加密。

false

id

integer

代码库 ID。

2959

lastActivityAt

string

最后活跃时间。

2022-01-14T21:08:26+08:00

name

string

代码库名称。

codeupTest

nameWithNamespace

string

代码库完整名称(含完整组名称)。

codeup-test-org / test-codeup

namespaceId

integer

上级路径的 ID。

path

string

代码库路径。

test-codeup

pathWithNamespace

string

代码库完整路径(含完整组路径)。

codeup-test-org/test-codeup

repositorySize

string

代码库大小(MB)。

10

starCount

integer

被收藏的数量。

5

starred

boolean

是否被当前用户收藏。

false

updatedAt

string

最近更新时间。

2022-01-14T21:08:26+08:00

visibility

string

可见性,private 标识私有的,internal 标识组织内公开,public 表示全平台公开。

private

webUrl

string

页面访问时的 URL。

""

返回示例

{
    "accessLevel": 0,
    "archived": false,
    "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
    "createdAt": "2022-01-14T21:08:26+08:00",
    "creatorId": 0,
    "demoProject": false,
    "description": "描述信息的具体内容",
    "encrypted": false,
    "id": 0,
    "lastActivityAt": "2022-01-14T21:08:26+08:00",
    "name": "codeupTest",
    "nameWithNamespace": "codeup-test-org / test-create-group (斜杠两侧有空格)",
    "namespaceId": 0,
    "path": "test-codeup",
    "pathWithNamespace": "codeup-test-org/test-codeup",
    "repositorySize": "10",
    "starCount": 5,
    "starred": false,
    "updatedAt": "2022-01-14T21:08:26+08:00",
    "visibility": "private",
    "webUrl": "\"\""
}

错误码

访问错误码中心查看 API 相关错误码。