floraachy
/
gitlink-forgeplus
mirror of https://gitlink.org.cn/Gitlink/forgeplus.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Update api document

This commit is contained in:
Jasder 2020-05-18 18:26:19 +08:00
parent 0e390ca912
commit 97c1d77705
1 changed files with 46 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -440,6 +440,9 @@ http://localhost:3000/api/projects/migrate | jq
|repository_name |是|string |仓库名称, 只含有数字、字母、下划线不能以下划线开头和结尾，且唯一 | |repository_name |是|string |仓库名称, 只含有数字、字母、下划线不能以下划线开头和结尾，且唯一 |
|project_category_id|是|int |项目类别id | |project_category_id|是|int |项目类别id |
|project_language_id|是|int |项目语言id | |project_language_id|是|int |项目语言id |
|is_mirror |否|boolean|是否设置为镜像， true：是， false：否，默认为否 |
|auth_username |否|string|镜像源仓库的登录用户名 |
|auth_password |否|string|镜像源仓库的登录秘密 |
|private |否|boolean|项目是否私有, true：为私有，false: 非私有，默认为公开 | |private |否|boolean|项目是否私有, true：为私有，false: 非私有，默认为公开 |
@ -458,6 +461,49 @@ http://localhost:3000/api/projects/migrate | jq
"name": "ni项目" "name": "ni项目"
} }
``` ```
#### 手动同步镜像
```
POST api/repositories/:id/sync_mirror
```
*示例*
```
curl -X POST \
-d "user_id=36401" \
http://localhost:3000/api/repositories/1244/sync_mirror | jq
```
*请求参数说明:*
|参数名|必选|类型|说明|
|-|-|-|-|
|user_id |是|int |用户id或者组织id |
|name |是|string |项目名称 |
|clone_addr |是|string |镜像项目clone地址 |
|description |否|string |项目描述 |
|repository_name |是|string |仓库名称, 只含有数字、字母、下划线不能以下划线开头和结尾，且唯一 |
|project_category_id|是|int |项目类别id |
|project_language_id|是|int |项目语言id |
|is_mirror |否|boolean|是否设置为镜像， true：是， false：否，默认为否 |
|auth_username |否|string|镜像源仓库的登录用户名 |
|auth_password |否|string|镜像源仓库的登录秘密 |
|private |否|boolean|项目是否私有, true：为私有，false: 非私有，默认为公开 |
*返回参数说明:*
|参数名|类型|说明|
|-|-|-|
|status |int |状态码， 0:标识请求成功 |
|message |string|服务端返回的信息说明|
返回值
```
{
"status": 0,
"message": "success"
}
```
--- ---
#### 项目详情 #### 项目详情