m52mxtq3o
/
educoder
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.md

Browse Source
dev_forge
Jasder 6 years ago
parent 98fa2bbb99
commit c00a5bc5ca
1 changed files with 161 additions and 32 deletions
Show Stats Download Patch File Download Diff File

193
README.md
Unescape View File

@ -292,8 +292,8 @@ POST api/projects/migrate
``` ```
curl -X POST \ curl -X POST \
-d "user_id=36401" \ -d "user_id=36401" \
-d "clone_addr=https://gitea.com/CasperVector/slew.git" \ -d "clone_addr=https://gitee.com/openeuler/A-Tune.git" \
-d "name=ni项目" \ -d "name=A-Tune" \
-d "description=my first project" \ -d "description=my first project" \
-d "repository_name=mirror_demo" \ -d "repository_name=mirror_demo" \
-d "project_category_id=1" \ -d "project_category_id=1" \
@ -365,36 +365,36 @@ http://localhost:3000/api/18816895620/mirror_demo/entries | jq
返回值 返回值
``` ```
[ [
{ {
"name": "Manual", "name": "Manual",
"path": "Manual", "path": "Manual",
"sha": "c2f18765235076b4c835b3e31262b3ee65176a75", "sha": "c2f18765235076b4c835b3e31262b3ee65176a75",
"type": "file", "type": "file",
"size": 12579, "size": 12579,
"content": null, "content": null,
"target": null, "target": null,
"commit": null "commit": null
}, },
{ {
"name": "README", "name": "README",
"path": "README", "path": "README",
"sha": "91a29176828eba5c5598f5d4a95458e861f271ec", "sha": "91a29176828eba5c5598f5d4a95458e861f271ec",
"type": "file", "type": "file",
"size": 1767, "size": 1767,
"content": null, "content": null,
"target": null, "target": null,
"commit": null "commit": null
}, },
{ {
"name": "base", "name": "base",
"path": "base", "path": "base",
"sha": "7adbe5698e02dba062216333d5e1d16b36ae1cbd", "sha": "7adbe5698e02dba062216333d5e1d16b36ae1cbd",
"type": "dir", "type": "dir",
"size": 0, "size": 0,
"content": null, "content": null,
"target": null, "target": null,
"commit": null "commit": null
} }
] ]
``` ```
--- ---
@ -751,6 +751,9 @@ curl -X GET http://localhost:3000/api/projects/mirror_demo/branches | jq
|user_can_push |boolean|用户是否可push| |user_can_push |boolean|用户是否可push|
|user_can_merge |boolean|用户是否客merge| |user_can_merge |boolean|用户是否客merge|
|protected |boolean|是否为保护分支| |protected |boolean|是否为保护分支|
|http_url |boolean|http链接|
|zip_url |boolean|zip包下载链接|
|tar_url |boolean|tar.gz下载链接|
|last_commit |object|最后提交记录| |last_commit |object|最后提交记录|
|-- id |string|提交记录id| |-- id |string|提交记录id|
|-- message |string|提交的说明信息| |-- message |string|提交的说明信息|
@ -769,6 +772,9 @@ curl -X GET http://localhost:3000/api/projects/mirror_demo/branches | jq
"user_can_push": true, "user_can_push": true,
"user_can_merge": true, "user_can_merge": true,
"protected": false, "protected": false,
"http_url": "http://localhost:3003/18816895620/mirror_demo.git",
"zip_url": "http://localhost:3003/18816895620/mirror_demo/develop.zip",
"tar_url": "http://localhost:3003/18816895620/mirror_demo/develop.tar.gz",
"last_commit": { "last_commit": {
"id": "735674d6696bddbafa993db9c67b40c41246c77f", "id": "735674d6696bddbafa993db9c67b40c41246c77f",
"message": "FIX test branch content\n", "message": "FIX test branch content\n",
@ -785,6 +791,9 @@ curl -X GET http://localhost:3000/api/projects/mirror_demo/branches | jq
"user_can_push": true, "user_can_push": true,
"user_can_merge": true, "user_can_merge": true,
"protected": false, "protected": false,
"http_url": "http://localhost:3003/18816895620/mirror_demo.git",
"zip_url": "http://localhost:3003/18816895620/mirror_demo/master.zip",
"tar_url": "http://localhost:3003/18816895620/mirror_demo/master.tar.gz",
"last_commit": { "last_commit": {
"id": "19ac3bc45f62cc87a94b8ecce61101d8fd2dafd2", "id": "19ac3bc45f62cc87a94b8ecce61101d8fd2dafd2",
"message": "合并pull request测试\n\n该功能很不错，感谢你的建议\n", "message": "合并pull request测试\n\n该功能很不错，感谢你的建议\n",
@ -927,6 +936,126 @@ http://localhost:3000/api/praise_tread/unlike | jq
|status |int|0:点赞成功，-1:操作失败，2:表示还未点赞| |status |int|0:点赞成功，-1:操作失败，2:表示还未点赞|
返回值
```
{
"status": 0,
"message": "响应成功"
}
```
---
### 仓库新建文件
```
DELETE /api/:login/:repo_identifier/contents
```
*示例*
```
curl -X DELETE \
-d 'filepath=1' \
-d 'object_type=project' \
http://localhost:3000/api/118816895620/mirror_demo/contents | jq
```
*请求参数说明:*
|参数名|必选|类型|说明|
-|-|-|-
|login |是|string |用户标识 |
|repo_identifier|是|string |仓库标识 |
|filepath |是|string |文件相对于仓库的路径 |
|content |否|string |内容 |
|message |否|string |提交说明 |
|branch |否|string |分支名称, branch和new_branch必须存在一个 |
|new_branch |否|string |新的分支名称 |
*返回参数说明:*
|参数名|类型|说明|
-|-|-
|status |int|0:点赞成功，-1:操作失败，2:表示还未点赞|
返回值
```
{
"status": 0,
"message": "响应成功"
}
```
---
### 更新仓库中的文件
```
DELETE /api/:login/:repo_identifier/contents/files/update
```
*示例*
```
curl -X DELETE \
-d 'filepath=1' \
-d 'object_type=project' \
http://localhost:3000/api/118816895620/mirror_demo/contents | jq
```
*请求参数说明:*
|参数名|必选|类型|说明|
-|-|-|-
|login |是|string |用户标识 |
|repo_identifier|是|string |仓库标识 |
|filepath |是|string |文件相对于仓库的路径 |
|content |否|string |内容 |
|message |否|string |提交说明 |
|branch |否|string |分支名称, branch和new_branch必须存在一个 |
|new_branch |否|string |新的分支名称 |
*返回参数说明:*
|参数名|类型|说明|
-|-|-
|status |int|0:点赞成功，-1:操作失败，2:表示还未点赞|
返回值
```
{
"status": 0,
"message": "响应成功"
}
```
---
### 删除仓库中的文件
```
DELETE /api/:login/:repo_identifier/contents/files/delete
```
*示例*
```
curl -X DELETE \
-d 'filepath=1' \
-d 'object_type=project' \
http://localhost:3000/api/118816895620/mirror_demo/contents | jq
```
*请求参数说明:*
|参数名|必选|类型|说明|
-|-|-|-
|login |是|string |用户标识 |
|repo_identifier|是|string |仓库标识 |
|filepath |是|string |文件相对于仓库的路径 |
|content |否|string |内容 |
|message |否|string |提交说明 |
|branch |否|string |分支名称, branch和new_branch必须存在一个 |
|new_branch |否|string |新的分支名称 |
*返回参数说明:*
|参数名|类型|说明|
-|-|-
|status |int|0:点赞成功，-1:操作失败，2:表示还未点赞|
返回值 返回值
``` ```
{ {

Write Preview
Loading…
Cancel
Save