获取当前登陆用户信息
@@ -622,183 +649,182 @@ Success — a happy kitten is an authenticated kitten! -获取项目列表，也可以更加相关条件过滤搜素
+待办事项-用户通知信息
-示例:
curl -X GET \
--d "page=1" \
--d "limit=5" \
-http://localhost:3000/api/projects | jq
-await octokit.request('GET /api/projects')
-GET api/projects
curl -X GET http://localhost:3000/api/users/yystopf/applied_messages.json
+await octokit.request('GET /api/users/:login/applied_messages.json')
+GET /api/users/:login/applied_messages.json
| 参数 | -必选 | -默认 | 类型 | 字段说明 | ||
|---|---|---|---|---|---|---|
| page | -false | -1 | +login | string | -页数，第几页 | +用户标识 | +
| 参数 | +类型 | +字段说明 | |||||
|---|---|---|---|---|---|---|---|
| limit | -false | -15 | -string | -每页多少条数据，默认15条 | +applied | +object | +通知主体 |
| sort_by | -false | -- | string | -排序类型, 取值：updated_on、created_on、forked_count、praises_count; updated_on: 更新时间排序，created_on: 创建时间排序，forked_count: fork数据排序，praises_count: 点赞数量排序，默认为updated_on更新时间排序 | +applied.id | +int | +通知主体的迁移id |
| sort_direction | -false | -+ | applied.status | string | -排序方式,取值为: desc、asc; desc: 降序排序， asc: 升序排序， 默认为：desc | +通知主体的迁移状态，canceled:取消,common:正在迁移, accept:已接受,refuse:已拒绝 | |
| search | -false | -+ | applied.time_ago | string | -按照项目名称搜索 | +通知主体的迁移创建的时间 | |
| category_id | -false | -+ | applied.project.id | int | -项目类别id | +通知主体的迁移项目的id | |
| language_id | -false | -- | int | -项目语言id | +applied.project.identifier | +string | +通知主体的迁移项目的标识 |
| project_type | -false | -+ | applied.project.name | string | -项目类型， 取值为：common、mirror; common:开源托管项目, mirror:开源镜像项目 | +通知主体的迁移项目的名称 |
| 参数 | -类型 | -字段说明 | +applied.project.description | +string | +通知主体的迁移项目的描述 |
|---|---|---|---|---|---|
| total_count | -int | -项目总条数 | +applied.project.is_public | +bool | +通知主体的迁移项目是否公开 |
| id | +applied.project.owner.id | +bool | +通知主体的迁移项目拥有者id | +||
| applied.project.owner.type | string | -项目id | +通知主体的迁移项目拥有者类型 | ||
| name | +applied.project.owner.name | string | -项目名称 | +通知主体的迁移项目拥有者昵称 | |
| description | +applied.project.owner.login | string | -项目简介 | +通知主体的迁移项目拥有者标识 | |
| visits | -int | -流量数 | +applied.project.owner.image_url | +string | +通知主体的迁移项目拥有者头像 |
| forked_count | +applied.user.id | int | -被fork的数量 | +通知主体的迁移创建者的id | |
| praises_count | -int | -star数量 | +applied.user.type | +string | +通知主体的迁移创建者的类型 |
| is_public | -boolean | -是否公开， true:公开，false:未公开 | +applied.user.name | +string | +通知主体的迁移创建者的名称 |
| mirror_url | +applied.user.login | string | -镜像url | +通知主体的迁移创建者的标识 | |
| last_update_time | +applied.user.image_url | +string | +通知主体的迁移创建者头像 | +||
| applied.owner.id | int | -最后更新时间，为UNIX格式的时间戳 | +通知主体的迁移接受者的id | ||
| author | -object | -项目创建者 | +applied.owner.type | +string | +通知主体的迁移接受者的类型 |
| -- name | +applied.owner.name | string | -用户名，也是用户标识 | +通知主体的迁移接受者的名称 | |
| category | -object | -项目类别 | +applied.owner.login | +string | +通知主体的迁移接受者的标识 |
| -- id | -int | -项目类型id | +applied.owner.image_url | +string | +通知主体的迁移接受者头像 |
| -- name | +applied_type | string | -项目类型名称 | +通知类型 | |
| language | -object | -项目语言 | +name | +string | +通知内容 |
| -- id | -int | -项目语言id | +viewed | +string | +是否已读，waiting:未读,viewed:已读 |
| -- name | +status | string | -项目语言名称 | +通知状态, canceled:已取消,common: 正常,successed:成功,failure:失败 | +|
| time_ago | +string | +通知时间 |
返回的JSON示例:
{
- "total_count": 3096,
- "projects": [
- {
- "id": 1400794,
- "repo_id": 1402452,
- "identifier": "cscw_2021_sponsor",
- "name": "Sponsor机制下的开源贡献",
- "description": "CSCW 2021 sponsor机制研究",
- "visits": 5,
- "praises_count": 0,
- "forked_count": 0,
- "is_public": true,
- "mirror_url": null,
- "type": 0,
- "last_update_time": 1611971671,
- "time_ago": "2天前",
- "forked_from_project_id": null,
- "open_devops": false,
- "platform": "forge",
- "author": {
- "name": "张迅晖",
- "login": "Nigel",
- "image_url": "images/avatars/User/3675?t=1611832880"
- },
- "category": {
- "id": 13,
- "name": "云计算和大数据"
- },
- "language": {
- "id": 34,
- "name": "Python3.6"
- }
- }
- ]
+ "total_count": 5,
+ "applied_messages": [
+ {
+ "applied": {
+ "project": {
+ "id": 86,
+ "identifier": "ceshi_repo1",
+ "name": "测试项目啊1",
+ "description": "二十多",
+ "is_public": true,
+ "owner": {
+ "id": 52,
+ "type": "Organization",
+ "name": "身份卡手动阀",
+ "login": "ceshi1",
+ "image_url": "images/avatars/Organization/52?t=1618805056"
+ }
+ },
+ "user": {
+ "id": 6,
+ "type": "User",
+ "name": "yystopf",
+ "login": "yystopf",
+ "image_url": "system/lets/letter_avatars/2/Y/241_125_89/120.png"
+ },
+ "owner": {
+ "id": 9,
+ "type": "Organization",
+ "name": "测试组织",
+ "login": "ceshi_org",
+ "image_url": "images/avatars/Organization/9?t=1612706073"
+ },
+ "id": 4,
+ "status": "common",
+ "created_at": "2021-04-26 09:54",
+ "time_ago": "35分钟前"
+ },
+ "applied_user": {
+ "id": 6,
+ "type": "User",
+ "name": "yystopf",
+ "login": "yystopf",
+ "image_url": "system/lets/letter_avatars/2/Y/241_125_89/120.png"
+ },
+ "applied_type": "AppliedTransferProject",
+ "name": "正在将【测试项目啊1】仓库转移给【测试组织】",
+ "viewed": "viewed",
+ "status": "common",
+ "created_at": "2021-04-26 09:54",
+ "time_ago": "35分钟前"
+ },
+ ...
+ ]
}
-获取推荐项目列表
+待办事项-接受仓库
-示例:
curl -X GET \
-http://localhost:3000/api/projects/recommend | jq
-await octokit.request('GET /api/projects/recommend.json')
-GET api/projects/recommend
curl -X GET http://localhost:3000/api/users/yystopf/applied_transfer_projects.json
+await octokit.request('GET /api/users/:login/applied_transfer_projects.json')
+GET /api/users/:login/applied_transfer_projects.json
| 参数 | @@ -865,134 +905,1298 @@ http://localhost:3000/api/projects/recommend | jq|||||
|---|---|---|---|---|---|
| total_count | -int | -项目总条数 | +login | +string | +用户标识 |
| id | -string | -项目id | +参数 | +类型 | +字段说明 |
|---|---|---|---|---|---|
| name | -string | -项目名称 | +id | +int | +迁移id |
| description | +status | string | -项目简介 | +迁移状态，canceled:取消,common:正在迁移, accept:已接受,refuse:已拒绝 | |
| visits | -int | -流量数 | +time_ago | +string | +迁移创建的时间 |
| forked_count | +project.id | int | -被fork的数量 | +迁移项目的id | |
| praises_count | -int | -star数量 | +project.identifier | +string | +迁移项目的标识 |
| is_public | -boolean | -是否公开， true:公开，false:未公开 | +project.name | +string | +迁移项目的名称 |
| mirror_url | +project.description | string | -镜像url | +迁移项目的描述 | |
| last_update_time | -int | -最后更新时间，为UNIX格式的时间戳 | +project.is_public | +bool | +迁移项目是否公开 |
| author | -object | -项目创建者 | +project.owner.id | +bool | +迁移项目拥有者id |
| -- name | +project.owner.type | string | -用户名，也是用户标识 | +迁移项目拥有者类型 | |
| category | -object | -项目类别 | +project.owner.name | +string | +迁移项目拥有者昵称 |
| -- id | -int | -项目类型id | +project.owner.login | +string | +迁移项目拥有者标识 | +
| project.owner.image_url | +string | +迁移项目拥有者头像 | +|||
| user.id | +int | +迁移创建者的id | +|||
| user.type | +string | +迁移创建者的类型 | +|||
| user.name | +string | +迁移创建者的名称 | +|||
| user.login | +string | +迁移创建者的标识 | +|||
| user.image_url | +string | +迁移创建者头像 | +|||
| owner.id | +int | +迁移接受者的id | +|||
| owner.type | +string | +迁移接受者的类型 | +|||
| owner.name | +string | +迁移接受者的名称 | +|||
| owner.login | +string | +迁移接受者的标识 | +|||
| owner.image_url | +string | +迁移接受者头像 | +
++返回的JSON示例:
+
{
+ "total_count": 4,
+ "applied_transfer_projects": [
+ {
+ "project": {
+ "id": 86,
+ "identifier": "ceshi_repo1",
+ "name": "测试项目啊1",
+ "description": "二十多",
+ "is_public": true,
+ "owner": {
+ "id": 52,
+ "type": "Organization",
+ "name": "身份卡手动阀",
+ "login": "ceshi1",
+ "image_url": "images/avatars/Organization/52?t=1618805056"
+ }
+ },
+ "user": {
+ "id": 6,
+ "type": "User",
+ "name": "yystopf",
+ "login": "yystopf",
+ "image_url": "system/lets/letter_avatars/2/Y/241_125_89/120.png"
+ },
+ "owner": {
+ "id": 52,
+ "type": "Organization",
+ "name": "身份卡手动阀",
+ "login": "ceshi1",
+ "image_url": "images/avatars/Organization/52?t=1618805056"
+ },
+ "id": 1,
+ "status": "canceled",
+ "created_at": "2021-04-25 18:06",
+ "time_ago": "16小时前"
+ },
+ ...
+ ]
+}
+用户接受迁移
+ +++示例:
+
curl -X POST http://localhost:3000/api/users/yystopf/applied_transfer_projects/2/accept.json
+await octokit.request('GET /api/users/:login/applied_transfer_projects/:id/accept.json')
+GET /api/users/:login/applied_transfer_projects/:id/accept.json
| 参数 | +类型 | +字段说明 | +
|---|---|---|
| login | +string | +用户标识 | +
| id | +int | +迁移id | +
| 参数 | +类型 | +字段说明 | +
|---|---|---|
| id | +int | +迁移id | +
| status | +string | +迁移状态，canceled:取消,common:正在迁移, accept:已接受,refuse:已拒绝 | +
| time_ago | +string | +迁移创建的时间 | +
| project.id | +int | +迁移项目的id | +
| project.identifier | +string | +迁移项目的标识 | +
| project.name | +string | +迁移项目的名称 | +
| project.description | +string | +迁移项目的描述 | +
| project.is_public | +bool | +迁移项目是否公开 | +
| project.owner.id | +bool | +迁移项目拥有者id | +
| project.owner.type | +string | +迁移项目拥有者类型 | +
| project.owner.name | +string | +迁移项目拥有者昵称 | +
| project.owner.login | +string | +迁移项目拥有者标识 | +
| project.owner.image_url | +string | +迁移项目拥有者头像 | +
| user.id | +int | +迁移创建者的id | +
| user.type | +string | +迁移创建者的类型 | +
| user.name | +string | +迁移创建者的名称 | +
| user.login | +string | +迁移创建者的标识 | +
| user.image_url | +string | +迁移创建者头像 | +
| owner.id | +int | +迁移接受者的id | +
| owner.type | +string | +迁移接受者的类型 | +
| owner.name | +string | +迁移接受者的名称 | +
| owner.login | +string | +迁移接受者的标识 | +
| owner.image_url | +string | +迁移接受者头像 | +
++返回的JSON示例:
+
{
+ "project": {
+ "id": 86,
+ "identifier": "ceshi_repo1",
+ "name": "测试项目啊1",
+ "description": "二十多",
+ "is_public": true,
+ "owner": {
+ "id": 52,
+ "type": "Organization",
+ "name": "身份卡手动阀",
+ "login": "ceshi1",
+ "image_url": "images/avatars/Organization/52?t=1618805056"
+ }
+ },
+ "user": {
+ "id": 6,
+ "type": "User",
+ "name": "yystopf",
+ "login": "yystopf",
+ "image_url": "system/lets/letter_avatars/2/Y/241_125_89/120.png"
+ },
+ "owner": {
+ "id": 52,
+ "type": "Organization",
+ "name": "身份卡手动阀",
+ "login": "ceshi1",
+ "image_url": "images/avatars/Organization/52?t=1618805056"
+ },
+ "id": 1,
+ "status": "canceled",
+ "created_at": "2021-04-25 18:06",
+ "time_ago": "16小时前"
+}
+用户拒绝迁移
+ +++示例:
+
curl -X POST http://localhost:3000/api/users/yystopf/applied_transfer_projects/2/refuse.json
+await octokit.request('GET /api/users/:login/applied_transfer_projects/:id/refuse.json')
+GET /api/users/:login/applied_transfer_projects/:id/refuse.json
| 参数 | +类型 | +字段说明 | +
|---|---|---|
| login | +string | +用户标识 | +
| id | +int | +迁移id | +
| 参数 | +类型 | +字段说明 | +
|---|---|---|
| id | +int | +迁移id | +
| status | +string | +迁移状态，canceled:取消,common:正在迁移, accept:已接受,refuse:已拒绝 | +
| time_ago | +string | +迁移创建的时间 | +
| project.id | +int | +迁移项目的id | +
| project.identifier | +string | +迁移项目的标识 | +
| project.name | +string | +迁移项目的名称 | +
| project.description | +string | +迁移项目的描述 | +
| project.is_public | +bool | +迁移项目是否公开 | +
| project.owner.id | +bool | +迁移项目拥有者id | +
| project.owner.type | +string | +迁移项目拥有者类型 | +
| project.owner.name | +string | +迁移项目拥有者昵称 | +
| project.owner.login | +string | +迁移项目拥有者标识 | +
| project.owner.image_url | +string | +迁移项目拥有者头像 | +
| user.id | +int | +迁移创建者的id | +
| user.type | +string | +迁移创建者的类型 | +
| user.name | +string | +迁移创建者的名称 | +
| user.login | +string | +迁移创建者的标识 | +
| user.image_url | +string | +迁移创建者头像 | +
| owner.id | +int | +迁移接受者的id | +
| owner.type | +string | +迁移接受者的类型 | +
| owner.name | +string | +迁移接受者的名称 | +
| owner.login | +string | +迁移接受者的标识 | +
| owner.image_url | +string | +迁移接受者头像 | +
++返回的JSON示例:
+
{
+ "project": {
+ "id": 86,
+ "identifier": "ceshi_repo1",
+ "name": "测试项目啊1",
+ "description": "二十多",
+ "is_public": true,
+ "owner": {
+ "id": 52,
+ "type": "Organization",
+ "name": "身份卡手动阀",
+ "login": "ceshi1",
+ "image_url": "images/avatars/Organization/52?t=1618805056"
+ }
+ },
+ "user": {
+ "id": 6,
+ "type": "User",
+ "name": "yystopf",
+ "login": "yystopf",
+ "image_url": "system/lets/letter_avatars/2/Y/241_125_89/120.png"
+ },
+ "owner": {
+ "id": 52,
+ "type": "Organization",
+ "name": "身份卡手动阀",
+ "login": "ceshi1",
+ "image_url": "images/avatars/Organization/52?t=1618805056"
+ },
+ "id": 1,
+ "status": "canceled",
+ "created_at": "2021-04-25 18:06",
+ "time_ago": "16小时前"
+}
+获取项目列表，也可以更加相关条件过滤搜素
+ +++示例:
+
curl -X GET \
+-d "page=1" \
+-d "limit=5" \
+http://localhost:3000/api/projects | jq
+await octokit.request('GET /api/projects')
+GET api/projects
| 参数 | +必选 | +默认 | +类型 | +字段说明 | +
|---|---|---|---|---|
| page | +false | +1 | +string | +页数，第几页 | +
| limit | +false | +15 | +string | +每页多少条数据，默认15条 | +
| sort_by | +false | ++ | string | +排序类型, 取值：updated_on、created_on、forked_count、praises_count; updated_on: 更新时间排序，created_on: 创建时间排序，forked_count: fork数据排序，praises_count: 点赞数量排序，默认为updated_on更新时间排序 | +
| sort_direction | +false | ++ | string | +排序方式,取值为: desc、asc; desc: 降序排序， asc: 升序排序， 默认为：desc | +
| search | +false | ++ | string | +按照项目名称搜索 | +
| category_id | +false | ++ | int | +项目类别id | +
| language_id | +false | ++ | int | +项目语言id | +
| project_type | +false | ++ | string | +项目类型， 取值为：common、mirror; common:开源托管项目, mirror:开源镜像项目 | +
| 参数 | +类型 | +字段说明 | +
|---|---|---|
| total_count | +int | +项目总条数 | +
| id | +string | +项目id | +
| name | +string | +项目名称 | +
| description | +string | +项目简介 | +
| visits | +int | +流量数 | +
| forked_count | +int | +被fork的数量 | +
| praises_count | +int | +star数量 | +
| is_public | +boolean | +是否公开， true:公开，false:未公开 | +
| mirror_url | +string | +镜像url | +
| last_update_time | +int | +最后更新时间，为UNIX格式的时间戳 | +
| author | +object | +项目创建者 | +
| -- name | +string | +用户名，也是用户标识 | +
| category | +object | +项目类别 | +
| -- id | +int | +项目类型id | +
| -- name | +string | +项目类型名称 | +
| language | +object | +项目语言 | +
| -- id | +int | +项目语言id | +
| -- name | +string | +项目语言名称 | +
++返回的JSON示例:
+
{
+ "total_count": 3096,
+ "projects": [
+ {
+ "id": 1400794,
+ "repo_id": 1402452,
+ "identifier": "cscw_2021_sponsor",
+ "name": "Sponsor机制下的开源贡献",
+ "description": "CSCW 2021 sponsor机制研究",
+ "visits": 5,
+ "praises_count": 0,
+ "forked_count": 0,
+ "is_public": true,
+ "mirror_url": null,
+ "type": 0,
+ "last_update_time": 1611971671,
+ "time_ago": "2天前",
+ "forked_from_project_id": null,
+ "open_devops": false,
+ "platform": "forge",
+ "author": {
+ "name": "张迅晖",
+ "login": "Nigel",
+ "image_url": "images/avatars/User/3675?t=1611832880"
+ },
+ "category": {
+ "id": 13,
+ "name": "云计算和大数据"
+ },
+ "language": {
+ "id": 34,
+ "name": "Python3.6"
+ }
+ }
+ ]
+}
+获取推荐项目列表
+ +++示例:
+
curl -X GET \
+http://localhost:3000/api/projects/recommend | jq
+await octokit.request('GET /api/projects/recommend.json')
+GET api/projects/recommend
| 参数 | +类型 | +字段说明 | +|
|---|---|---|---|
| total_count | +int | +项目总条数 | +|
| id | +string | +项目id | +|
| name | +string | +项目名称 | +|
| description | +string | +项目简介 | +|
| visits | +int | +流量数 | +|
| forked_count | +int | +被fork的数量 | +|
| praises_count | +int | +star数量 | +|
| is_public | +boolean | +是否公开， true:公开，false:未公开 | +|
| mirror_url | +string | +镜像url | +|
| last_update_time | +int | +最后更新时间，为UNIX格式的时间戳 | +|
| author | +object | +项目创建者 | +|
| -- name | +string | +用户名，也是用户标识 | +|
| category | +object | +项目类别 | +|
| -- id | +int | +项目类型id | +|
| -- name | +string | +项目类型名称 | +|
| language | +object | +项目语言 | +|
| -- id | +int | +项目语言id | |
| -- name | string | -项目类型名称 | +项目语言名称 | +
++返回的JSON示例:
+
[
+ {
+ "id": 20,
+ "repo_id": 2,
+ "identifier": "PNAekinmH",
+ "name": "FNILL",
+ "visits": 13567,
+ "author": {
+ "name": "王一达",
+ "login": "wangyida",
+ "image_url": "avatars/User/b"
+ },
+ "category": {
+ "id": 8,
+ "name": "其他"
+ }
+ }
+]
+获取项目导航信息
+ +++示例:
+
curl -X GET \
+http://localhost:3000/api/yystopf/ceshi/menu_list | jq
+await octokit.request('GET /api/yystopf/ceshi/menu_list')
+GET api/:owner/:repo/menu_list
| 参数 | +必选 | +默认 | +类型 | +字段说明 | +
|---|---|---|---|---|
| owner | +是 | ++ | string | +用户登录名 | +
| repo | +是 | ++ | string | +项目标识identifier | +
| 参数 | +类型 | +字段说明 | +
|---|---|---|
| menu_name | +string | +导航名称， home:主页,code:代码库,issues:易修,pulls:合并请求,devops:工作流,versions:里程碑,activity:动态,setting:仓库设置 | +
++返回的JSON示例:
+
[
+ {
+ "menu_name": "home"
+ },
+ {
+ "menu_name": "code"
+ },
+ {
+ "menu_name": "pulls"
+ },
+ {
+ "menu_name": "activity"
+ }
+]
+获取项目主页信息
+ +++示例:
+
curl -X GET \
+http://localhost:3000/api/jasder/forgeplus/about | jq
+await octokit.request('GET /api/jasder/forgeplus/about')
+GET api/:owner/:repo/about
| 参数 | +必选 | +默认 | +类型 | +字段说明 | +
|---|---|---|---|---|
| owner | +是 | ++ | string | +用户登录名 | +
| repo | +是 | ++ | string | +项目标识identifier | +
| 参数 | +类型 | +字段说明 | +
|---|---|---|
| identifier | +string | +project's identifier | +
| content | +string | +主页内容 | +
| attachments | +array | +附件 | +
++返回的JSON示例:
+
{
+ "content": "",
+ "identifier": "forgeplus",
+ attachments: []
+}
+项目模块信息
+ +++示例:
+
curl -X GET \
+http://localhost:3000/api/yystopf/ceshi/project_units.json
+await octokit.request('GET /api/yystopf/ceshi/project_units')
+GET /api/yystopf/ceshi/project_units
| 参数 | +类型 | +字段说明 | +
|---|---|---|
| type | +string | +模块名称 | +
++返回的JSON示例:
+
[
+ {
+ "type": "code"
+ },
+ {
+ "type": "pulls"
+ },
+ {
+ "type": "issues"
+ }
+]
+更改项目模块展示
+ +++示例:
+
curl -X POST \
+-H "accept: application/json" \
+-H "Content-Type: application/json" \
+-d "{ \"unit_typs\": [\"code\", \"pulls\"]}" \
+http://localhost:3000/api/yystopf/ceshi/project_units.json
+await octokit.request('POST /api/yystopf/ceshi/project_units')
+POST /api/yystopf/ceshi/project_units
| 参数 | +必选 | +默认 | +类型 | +字段说明 | +
|---|---|---|---|---|
| unit_types | +是 | ++ | array | +项目模块内容， 支持以下参数:code:代码库,issues:易修,pulls:合并请求,devops:工作流,versions:里程碑 | +
| 参数 | +类型 | +字段说明 | +
|---|---|---|
| status | +int | +返回状态， 0: 表示操作成功 | +
| message | +string | +返回信息说明 |
++返回的JSON示例:
+
{
+ "status": 0,
+ "message": "success"
+}
+创建项目
+ +++示例:
+
curl -X POST \
+-d "user_id=36401" \
+-d "name=hnfl_demo" \
+-d "description=my first project" \
+-d "repository_name=hnfl_demo" \
+-d "project_category_id=1" \
+-d "project_language_id=2" \
+-d "ignore_id=2" \
+-d "license_id=1" \
+http://localhost:3000/api/projects.json
+await octokit.request('GET /api/projects.json')
+POST api/projects
| language | -object | -项目语言 | +参数 | +必选 | +默认 | +类型 | +字段说明 |
|---|---|---|---|---|---|---|---|
| -- id | +user_id | +是 | ++ | int | +用户id或者组织id | +||
| name | +是 | ++ | string | +项目名称 | +|||
| description | +是 | ++ | string | +项目描述 | +|||
| repository_name | +是 | ++ | string | +仓库名称, 只含有数字、字母、下划线不能以下划线开头和结尾，且唯一 | +|||
| project_category_id | +是 | ++ | int | +项目类别id | +|||
| project_language_id | +是 | +int | 项目语言id | ||||
| -- name | +ignore_id | +否 | ++ | int | +gitignore相关id | +||
| license_id | +否 | ++ | int | +开源许可证id | +|||
| private | +否 | ++ | boolean | +项目是否私有, true：为私有，false: 公开，默认为公开 | +
| 参数 | +类型 | +字段说明 | +|
|---|---|---|---|
| id | +int | +id | +|
| name | string | -项目语言名称 | +项目名称 |
-返回的JSON示例:
[
- {
- "id": 20,
- "repo_id": 2,
- "identifier": "PNAekinmH",
- "name": "FNILL",
- "visits": 13567,
- "author": {
- "name": "王一达",
- "login": "wangyida",
- "image_url": "avatars/User/b"
- },
- "category": {
- "id": 8,
- "name": "其他"
- }
- }
-]
-获取项目导航信息
+{
+ "id": 3240,
+ "name": "好项目"
+}
+创建镜像项目
-示例:
curl -X GET \
-http://localhost:3000/api/yystopf/ceshi/menu_list | jq
-await octokit.request('GET /api/yystopf/ceshi/menu_list')
-GET api/:owner/:repo/menu_list
curl -X POST \
+-d "user_id=36408" \
+-d "clone_addr=https://gitea.com/mx8090alex/golden.git" \
+-d "name=golden_mirror1" \
+-d "description=golden_mirror" \
+-d "project_category_id=1" \
+-d "project_language_id=2" \
+http://localhost:3000/api/projects/migrate.json
+await octokit.request('GET /api/projects/migrate.json')
+POST api/projects/migrate.json
| 参数 | @@ -1003,21 +2207,84 @@ http://localhost:3000/api/yystopf/ceshi/menu_list | jq||||||||
|---|---|---|---|---|---|---|---|---|
| owner | +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 | -用户登录名 | +镜像源仓库的登录秘密 | ||||
| repo | -是 | +private | +否 | - | string | -项目标识identifier | +boolean | +项目是否私有, true：为私有，false: 非私有，默认为公开 |
| 参数 | @@ -1026,41 +2293,35 @@ http://localhost:3000/api/yystopf/ceshi/menu_list | jq|||
|---|---|---|---|
| menu_name | +id | +int | +id | +
| name | string | -导航名称， home:主页,code:代码库,issues:易修,pulls:合并请求,devops:工作流,versions:里程碑,activity:动态,setting:仓库设置 | +项目名称 |
-返回的JSON示例:
[
- {
- "menu_name": "home"
- },
- {
- "menu_name": "code"
- },
- {
- "menu_name": "pulls"
- },
- {
- "menu_name": "activity"
- }
-]
-获取项目主页信息
+{
+ "id": 3241,
+ "name": "这是一个镜像项目"
+}
+手动同步镜像
-示例:
curl -X GET \
-http://localhost:3000/api/jasder/forgeplus/about | jq
-await octokit.request('GET /api/jasder/forgeplus/about')
-GET api/:owner/:repo/about
curl -X POST http://localhost:3000/api/repositories/1244/sync_mirror.json
+await octokit.request('POST /api/repositories/1244/sync_mirror.json')
+POST api/repositories/:id/sync_mirror.json
| 参数 | @@ -1071,21 +2332,14 @@ http://localhost:3000/api/jasder/forgeplus/about | jq|||||||
|---|---|---|---|---|---|---|---|
| owner | -是 | -- | string | -用户登录名 | -|||
| repo | +id | 是 | - | string | -项目标识identifier | +int | +仓库id |
| 参数 | @@ -1094,19 +2348,14 @@ http://localhost:3000/api/jasder/forgeplus/about | jq|||||
|---|---|---|---|---|---|
| identifier | -string | -project's identifier | +status | +int | +状态码， 0:标识请求成功 |
| content | +message | string | -主页内容 | -||
| attachments | -array | -附件 | +服务端返回的信息说明 |
返回的JSON示例:
{
- "content": "",
- "identifier": "forgeplus",
- attachments: []
+ "status": 0,
+ "message": "success"
}
-项目模块信息
+fork项目
-示例:
curl -X GET \
-http://localhost:3000/api/yystopf/ceshi/project_units.json
-await octokit.request('GET /api/yystopf/ceshi/project_units')
-GET /api/yystopf/ceshi/project_units
curl -X POST http://localhost:3000/api/jasder/forgeplus/forks.json
+await octokit.request('POST /api/jaser/jasder_test/forks.json')
+POST api/:owner/:repo/forks.json
| 参数 | +必选 | +默认 | 类型 | 字段说明 | |
|---|---|---|---|---|---|
| type | +owner | +是 | +string | -模块名称 | -
--返回的JSON示例:
-
[
- {
- "type": "code"
- },
- {
- "type": "pulls"
- },
- {
- "type": "issues"
- }
-]
-更改项目模块展示
- ---示例:
-
curl -X POST \
--H "accept: application/json" \
--H "Content-Type: application/json" \
--d "{ \"unit_typs\": [\"code\", \"pulls\"]}" \
-http://localhost:3000/api/yystopf/ceshi/project_units.json
-await octokit.request('POST /api/yystopf/ceshi/project_units')
-POST /api/yystopf/ceshi/project_units
| 参数 | -必选 | -默认 | -类型 | -字段说明 | +用户登录名 | ||
|---|---|---|---|---|---|---|---|
| unit_types | +repo | 是 | - | array | -项目模块内容， 支持以下参数:code:代码库,issues:易修,pulls:合并请求,devops:工作流,versions:里程碑 | +string | +项目标识identifier |
| 参数 | @@ -1203,14 +2410,14 @@ http://localhost:3000/api/yystopf/ceshi/project_units.json||||
|---|---|---|---|---|
| status | +id | int | -返回状态， 0: 表示操作成功 | +项目id |
| message | +identifier | string | -返回信息说明 | +项目标识 |
返回的JSON示例:
{
- "status": 0,
- "message": "success"
+ "id": 3290,
+ "identifier": "newadm"
}
-创建项目
+用户管理的组织列表
-示例:
curl -X POST \
--d "user_id=36401" \
--d "name=hnfl_demo" \
--d "description=my first project" \
--d "repository_name=hnfl_demo" \
--d "project_category_id=1" \
--d "project_language_id=2" \
--d "ignore_id=2" \
--d "license_id=1" \
-http://localhost:3000/api/projects.json
-await octokit.request('GET /api/projects.json')
-POST api/projects
curl -X GET \
+http://localhost:3000/api/ceshi1/ceshi_repo1/applied_transfer_projects/organizations.json | jq
+await octokit.request('GET /api/:owner/:repo/applied_transfer_projects/organizations')
+GET api/:owner/:repo/applied_transfer_projects/organizations
| 参数 | @@ -1251,86 +2450,47 @@ http://localhost:3000/api/projects.json||||||
|---|---|---|---|---|---|---|
| user_id | -是 | -- | int | -用户id或者组织id | -||
| name | -是 | -- | string | -项目名称 | -||
| description | +owner | 是 | string | -项目描述 | +用户登录名 | |
| repository_name | +repo | 是 | string | -仓库名称, 只含有数字、字母、下划线不能以下划线开头和结尾，且唯一 | -||
| project_category_id | -是 | -- | int | -项目类别id | -||
| project_language_id | -是 | -- | int | -项目语言id | -||
| ignore_id | -否 | -- | int | -gitignore相关id | -||
| license_id | -否 | -- | int | -开源许可证id | -||
| private | -否 | -- | boolean | -项目是否私有, true：为私有，false: 公开，默认为公开 | +项目标识identifier |
| 参数 | 类型 | 字段说明 | |||
|---|---|---|---|---|---|
| name | +string | +组织标识 | +|||
| id | -int | -id | +nickname | +string | +组织名称 |
| name | +description | string | -项目名称 | +组织描述 | +|
| avatar_url | +string｜组织头像 | +
返回的JSON示例:
{
- "id": 3240,
- "name": "好项目"
+ "total_count": 3,
+ "organizations": [
+ {
+ "id": 9,
+ "name": "ceshi_org",
+ "nickname": "测试组织",
+ "description": "测试组织",
+ "avatar_url": "images/avatars/Organization/9?t=1612706073"
+ },
+ {
+ "id": 51,
+ "name": "ceshi",
+ "nickname": "测试组织哈哈哈",
+ "description": "23212312",
+ "avatar_url": "images/avatars/Organization/51?t=1618800723"
+ },
+ {
+ "id": 52,
+ "name": "ceshi1",
+ "nickname": "身份卡手动阀",
+ "description": "1231手动阀是的",
+ "avatar_url": "images/avatars/Organization/52?t=1618805056"
+ }
+ ]
}
-创建镜像项目
+迁移项目，edit接口is_transfering为true表示正在迁移
-示例:
curl -X POST \
--d "user_id=36408" \
--d "clone_addr=https://gitea.com/mx8090alex/golden.git" \
--d "name=golden_mirror1" \
--d "description=golden_mirror" \
--d "project_category_id=1" \
--d "project_language_id=2" \
-http://localhost:3000/api/projects/migrate.json
-await octokit.request('GET /api/projects/migrate.json')
-POST api/projects/migrate.json
curl -X POST http://localhost:3000/api/ceshi1/ceshi_repo1/applied_transfer_projects.json
+await octokit.request('POST /api/:owner/:repo/applied_transfer_projects.json')
+POST /api/:owner/:repo/applied_transfer_projects.json
| 参数 | @@ -1369,155 +2544,149 @@ http://localhost:3000/api/projects/migrate.json|||||||
|---|---|---|---|---|---|---|---|
| user_id | +owner | 是 | - | int | -用户id或者组织id | +string | +用户登录名 |
| name | +repo | 是 | string | -项目名称 | +项目标识identifier | ||
| clone_addr | +owner_name | 是 | string | -镜像项目clone地址 | +迁移对象标识 |
| description | -否 | -+ | 参数 | +类型 | +字段说明 | +||
|---|---|---|---|---|---|---|---|
| id | +int | +项目id | +|||||
| status | string | -项目描述 | +项目迁移状态，canceled:取消,common:正在迁移, accept:已接受,refuse:已拒绝 | ||||
| repository_name | -是 | -+ | time_ago | string | -仓库名称, 只含有数字、字母、下划线不能以下划线开头和结尾，且唯一 | +项目迁移创建的时间 | |
| project_category_id | -是 | -+ | project.id | int | -项目类别id | +迁移项目的id | |
| project_language_id | -是 | -- | int | -项目语言id | +project.identifier | +string | +迁移项目的标识 |
| is_mirror | -否 | -- | boolean | -是否设置为镜像， true：是， false：否，默认为否 | +project.name | +string | +迁移项目的名称 |
| auth_username | -否 | -+ | project.description | string | -镜像源仓库的登录用户名 | +迁移项目的描述 | |
| auth_password | -否 | -+ | project.is_public | +bool | +迁移项目是否公开 | +||
| project.owner.id | +bool | +迁移项目拥有者id | +|||||
| project.owner.type | string | -镜像源仓库的登录秘密 | +迁移项目拥有者类型 | ||||
| private | -否 | -- | boolean | -项目是否私有, true：为私有，false: 非私有，默认为公开 | +project.owner.name | +string | +迁移项目拥有者昵称 |
| 参数 | -类型 | -字段说明 | +project.owner.login | +string | +迁移项目拥有者标识 |
|---|---|---|---|---|---|
| id | +project.owner.image_url | +string | +迁移项目拥有者头像 | +||
| user.id | int | -id | +迁移创建者的id | ||
| name | +user.type | string | -项目名称 | +迁移创建者的类型 |
--返回的JSON示例:
-
{
- "id": 3241,
- "name": "这是一个镜像项目"
-}
-手动同步镜像
- ---示例:
-
curl -X POST http://localhost:3000/api/repositories/1244/sync_mirror.json
-await octokit.request('POST /api/repositories/1244/sync_mirror.json')
-POST api/repositories/:id/sync_mirror.json
| 参数 | -必选 | -默认 | -类型 | -字段说明 | +user.name | +string | +迁移创建者的名称 |
|---|---|---|---|---|---|---|---|
| id | -是 | -- | int | -仓库id | +user.login | +string | +迁移创建者的标识 |
| 参数 | -类型 | -字段说明 | +user.image_url | +string | +迁移创建者头像 |
|---|---|---|---|---|---|
| status | +owner.id | int | -状态码， 0:标识请求成功 | +迁移接受者的id | |
| message | +owner.type | string | -服务端返回的信息说明 | +迁移接受者的类型 | +|
| owner.name | +string | +迁移接受者的名称 | +|||
| owner.login | +string | +迁移接受者的标识 | +|||
| owner.image_url | +string | +迁移接受者头像 |
返回的JSON示例:
{
- "status": 0,
- "message": "success"
+ "project": {
+ "id": 86,
+ "identifier": "ceshi_repo1",
+ "name": "测试项目啊1",
+ "description": "二十多",
+ "is_public": true,
+ "owner": {
+ "id": 52,
+ "type": "Organization",
+ "name": "身份卡手动阀",
+ "login": "ceshi1",
+ "image_url": "images/avatars/Organization/52?t=1618805056"
+ }
+ },
+ "user": {
+ "id": 6,
+ "type": "User",
+ "name": "yystopf",
+ "login": "yystopf",
+ "image_url": "system/lets/letter_avatars/2/Y/241_125_89/120.png"
+ },
+ "owner": {
+ "id": 9,
+ "type": "Organization",
+ "name": "测试组织",
+ "login": "ceshi_org",
+ "image_url": "images/avatars/Organization/9?t=1612706073"
+ },
+ "id": 4,
+ "status": "common",
+ "created_at": "2021-04-26 09:54",
+ "time_ago": "1分钟前"
}
-fork项目
+迁移项目，edit接口is_transfering为true表示正在迁移
-示例:
curl -X POST http://localhost:3000/api/jasder/forgeplus/forks.json
-await octokit.request('POST /api/jaser/jasder_test/forks.json')
-POST api/:owner/:repo/forks.json
curl -X POST http://localhost:3000/api/ceshi1/ceshi_repo1/applied_transfer_projects/cancel.json
+await octokit.request('POST /api/:owner/:repo/applied_transfer_projects/cancel.json')
+POST /api/:owner/:repo/applied_transfer_projects/cancel.json
| 参数 | @@ -1563,7 +2762,7 @@ http://localhost:3000/api/projects/migrate.json项目标识identifier |
|---|
| 参数 | @@ -1574,12 +2773,117 @@ http://localhost:3000/api/projects/migrate.json||||
|---|---|---|---|---|
| id | int | -项目id | +迁移id | |
| identifier | +status | string | -项目标识 | +迁移状态，canceled:取消,common:正在迁移, accept:已接受,refuse:已拒绝 | +
| time_ago | +string | +迁移创建的时间 | +||
| project.id | +int | +迁移项目的id | +||
| project.identifier | +string | +迁移项目的标识 | +||
| project.name | +string | +迁移项目的名称 | +||
| project.description | +string | +迁移项目的描述 | +||
| project.is_public | +bool | +迁移项目是否公开 | +||
| project.owner.id | +bool | +迁移项目拥有者id | +||
| project.owner.type | +string | +迁移项目拥有者类型 | +||
| project.owner.name | +string | +迁移项目拥有者昵称 | +||
| project.owner.login | +string | +迁移项目拥有者标识 | +||
| project.owner.image_url | +string | +迁移项目拥有者头像 | +||
| user.id | +int | +迁移创建者的id | +||
| user.type | +string | +迁移创建者的类型 | +||
| user.name | +string | +迁移创建者的名称 | +||
| user.login | +string | +迁移创建者的标识 | +||
| user.image_url | +string | +迁移创建者头像 | +||
| owner.id | +int | +迁移接受者的id | +||
| owner.type | +string | +迁移接受者的类型 | +||
| owner.name | +string | +迁移接受者的名称 | +||
| owner.login | +string | +迁移接受者的标识 | +||
| owner.image_url | +string | +迁移接受者头像 |
返回的JSON示例:
{
- "id": 3290,
- "identifier": "newadm"
+ "project": {
+ "id": 86,
+ "identifier": "ceshi_repo1",
+ "name": "测试项目啊1",
+ "description": "二十多",
+ "is_public": true,
+ "owner": {
+ "id": 52,
+ "type": "Organization",
+ "name": "身份卡手动阀",
+ "login": "ceshi1",
+ "image_url": "images/avatars/Organization/52?t=1618805056"
+ }
+ },
+ "user": {
+ "id": 6,
+ "type": "User",
+ "name": "yystopf",
+ "login": "yystopf",
+ "image_url": "system/lets/letter_avatars/2/Y/241_125_89/120.png"
+ },
+ "owner": {
+ "id": 9,
+ "type": "Organization",
+ "name": "测试组织",
+ "login": "ceshi_org",
+ "image_url": "images/avatars/Organization/9?t=1612706073"
+ },
+ "id": 4,
+ "status": "common",
+ "created_at": "2021-04-26 09:54",
+ "time_ago": "1分钟前"
}
仓库详情