更新时间:2024-10-26 GMT+08:00
分享

创建仓库

功能介绍

用指定的名称在指定项目上创建仓库。传入参数:仓库名、模板id、是否导入项目成员、归属项目

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/repositories

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

import_members

Integer

参数解释

是否导入项目成员。

约束限制

不涉及。

取值范围:

  • 0,不导入项目成员
  • 1,导入项目成员

默认取值:

0

name

String

参数解释

仓库名称

约束限制

必传

取值范围:

  • 以大小写字母、数字、下划线开头,可包含大小写字母、数字、中划线、下划线、英文句点,但不能以.git、.atom或.结尾
  • 长度[1-256]

默认取值:

不涉及

project_uuid

String

参数解释

指定项目ID

约束限制

必传

取值范围:

32位字符串

默认取值:

不涉及

template_id

String

参数解释

复制模板的ID

约束限制

不涉及

取值范围:

字符串

默认取值:

不涉及

visibility_level

Integer

参数解释

仓库可见性

约束限制

不涉及

取值范围:

  • 0,私有
  • 20,公开只读

默认取值:

0

import_url

String

参数解释

模板仓库的https地址的base64加密

约束限制

不涉及

取值范围:

URL长度[10-512]

默认取值:

不涉及

description

String

参数解释

仓库描述信息

约束限制

不涉及

取值范围:

[0-2000]

默认取值:

不涉及

gitignore_id

String

参数解释

根据编程语言生成.gitignore文件

约束限制

不涉及

取值范围:

Actionscript,Ada,Agda,Android,Ansible,AppceleratorTitanium,AppEngine,ArchLinuxPackages,Autotools,C#,C++,C,CakePHP,CFWheels,ChefCookbook,Clojure,CMake,CodeIgniter,CommonLisp,Composer,Concrete5,Coq,CraftCMS,CUDA,D,Dart,Delphi,DM,Dreamweaver,Dropbox,Drupal,Eagle,Eclipse,Elisp,Elixir,Elm,Emacs,EPiServer,Erlang,ExpressionEngine,ExtJs,Fancy,Finale,ForceDotCom,Fortran,FuelPHP,Gcov,GitBook,Go,Godot,GPG,Gradle,Grails,GWT,Haskell,Idris,IGORPro,Java,JavaScript,Jboss,Jekyll,JetBrains,Joomla,Julia,KiCad,Kohana,Kotlin,LabVIEW,Laravel,Leiningen,LemonStand,Lilypond,Lithium,Lua,Magento,Maven,Mercury,MetaProgrammingSystem,Nanoc,NetBeans,Nim,Node,NotepadPP,Objective-C,OCaml,Opa,OpenCart,OracleForms,Packer,Perl,Phalcon,PlayFramework,Plone,Prestashop,Processing,PureScript,Python,Qooxdoo,Qt,R,Rails,RhodesRhomobile,ROS,Ruby,Rust,Sass,Scala,Scheme,SCons,Scrivener,Sdcc,SeamGen,SketchUp,Smalltalk,Stella,SublimeText,SugarCRM,SVN,Swift,Symfony,SymphonyCMS,Terraform,TeX,Textpattern,TortoiseGit,TurboGears2,Typo3,Umbraco,Unity,UnrealEngine,VisualStudio,VisualStudioCode,VVVV,Waf,WordPress,Xojo,Yeoman,Yii,ZendFramework,Zephir

默认取值:

不涉及

license_id

Integer

参数解释

开源许可证id

约束限制

不涉及

取值范围:

  • 1,Apache_License_v2.0
  • 2,MIT_License,,BSD_3Clause
  • 3,Eclipse_Public_License_v1.0
  • 4,BSD_2Clause
  • 5,GNU_General_Public_License_v2.0
  • 6,GNU_General_Public_License_v3.0
  • 7,GNU_Affero_General_Public_License_v3.0
  • 8,GNU_Lesser_General_Public_License_v2.1
  • 9,GNU_Lesser_General_Public_License_v3.0
  • 10,Mozilla_Public_License_v2.0
  • 11,The_Unlicense

默认取值:

不涉及

enable_readme

Integer

参数解释

是否允许生成README文件

约束限制

不涉及

取值范围:

  • true:创建
  • false:不创建

默认取值:

不涉及

caller

String

参数解释

调用者

约束限制

不涉及

取值范围:

字符串

默认取值:

不涉及

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

error

Error object

参数解释

响应错误:

result

Repository object

参数解释

响应结果

status

String

参数解释

响应状态

取值范围:

  • success
  • fail
表4 Error

参数

参数类型

描述

code

String

参数解释

错误码

取值范围:

请参见错误码

message

String

参数解释

错误信息

取值范围:

字符串

表5 Repository

参数

参数类型

描述

repository_uuid

String

参数解释

指定项目ID

取值范围:

32位字符串

请求示例

POST https://{endpoint}/v1/repositories

{
	"project_uuid": "4838955a48e2492bbe44b31bc4c272f6", 
	"name": "demotest1", 
	"import_members": "0", 
	"visibility_level": "20", 
 }

响应示例

状态码: 200

OK

{
  "result" : {
    "repository_uuid" : "d161fd00d9194816a455cb3c1d6a783e"
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档