获取项目主页信息
+获取项目导航信息
示例:
curl -X GET \
-http://localhost:3000/api/jasder/forgeplus/about | jq
-await octokit.request('GET /api/jasder/forgeplus/about')
+http://localhost:3000/api/yystopf/ceshi/menu_list | jq
+await octokit.request('GET /api/yystopf/ceshi/menu_list')
GET api/:owner/:repo/about
GET api/:owner/:repo/menu_list
| 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 | @@ -1039,7 +1122,106 @@ http://localhost:3000/api/jasder/forgeplus/about | jq -
| 参数 | +类型 | +字段说明 | +
|---|---|---|
| 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"
+}
+创建项目
@@ -1056,9 +1238,9 @@ Remember — a happy kitten is an authenticated kitten! -d "license_id=1" \ http://localhost:3000/api/projects.jsonawait octokit.request('GET /api/projects.json') -HTTP 请求
+HTTP 请求
-
POST api/projects请求参数
+请求参数
-
参数 @@ -1132,7 +1314,7 @@ http://localhost:3000/api/projects.json项目是否私有, true：为私有，false: 公开，默认为公开 返回字段说明
+返回字段说明
参数 @@ -1174,9 +1356,9 @@ http://localhost:3000/api/projects.json -d "project_language_id=2" \ http://localhost:3000/api/projects/migrate.jsonawait octokit.request('GET /api/projects/migrate.json') -HTTP 请求
+HTTP 请求
-
POST api/projects/migrate.json请求参数
+请求参数
-
参数 @@ -1264,7 +1446,7 @@ http://localhost:3000/api/projects/migrate.json项目是否私有, true：为私有，false: 非私有，默认为公开 返回字段说明
+返回字段说明
参数 @@ -1299,9 +1481,9 @@ http://localhost:3000/api/projects/migrate.jsoncurl -X POST http://localhost:3000/api/repositories/1244/sync_mirror.jsonawait octokit.request('POST /api/repositories/1244/sync_mirror.json') -HTTP 请求
+HTTP 请求
-
POST api/repositories/:id/sync_mirror.json请求参数
+请求参数
-
参数 @@ -1319,7 +1501,7 @@ http://localhost:3000/api/projects/migrate.json仓库id 返回字段说明
+返回字段说明
参数 @@ -1354,9 +1536,9 @@ http://localhost:3000/api/projects/migrate.jsoncurl -X POST http://localhost:3000/api/jasder/forgeplus/forks.jsonawait octokit.request('POST /api/jaser/jasder_test/forks.json') -HTTP 请求
+HTTP 请求
-
POST api/:owner/:repo/forks.json请求参数
+请求参数
-
参数 @@ -1381,7 +1563,7 @@ http://localhost:3000/api/projects/migrate.json项目标识identifier 返回字段说明
+返回字段说明
参数 @@ -1590,16 +1772,16 @@ http://localhost:3000/api/projects/migrate.json "repo_id": 75073, "repo_identifier": "mirror_demo" } -编辑仓库信息
-编辑仓库信息
+仓库详情(新版)
+仓库详情
-示例:
curl -X GET http://localhost:3000/api/jasder/jasder_test/edit.json -await octokit.request('GET /api/jasder/jasder_test/edit.json') +curl -X GET http://localhost:3000/api/yystopf/ceshi/detail.json +await octokit.request('GET /api/yystopf/ceshi/detail.json')HTTP 请求
-+
GET /api/:owner/:repo/edit.json
GET /api/:owner/:repo/detail请求参数:
+ +
@@ -1634,6 +1816,379 @@ http://localhost:3000/api/projects/migrate.json + +content +string +仓库简介 ++ +website +string +仓库网址 ++ +readme +string +readme文件｜ ++ +identifier +string +项目标识 ++ +name +string +项目名称 ++ +issues_count +int +项目issue数量 ++ +pull_requests_count +int +项目合并请求数量 ++ +project_identifier +int +项目标识 ++ +praises_count +int +项目点赞数量 ++ +forked_count +int +项目复刻数量 ++ +watchers_count +int +项目关注数量 ++ +versions_count +int +项目里程碑数量 ++ +version_releases_count +int +项目发行版数量 ++ +version_releasesed_count +int +项目发行版已发行数量 ++ +permission +string +项目权限 ++ +mirror_url +string +镜像地址 ++ +mirror +bool +是否为镜像项目 ++ +type +int +项目类型 0 普通项目 1 普通镜像项目 2 同步镜像项目 ++ +open_devops +int +是否开启devops ++ +watched +bool +是否关注 ++ +praised +bool +是否点赞 ++ +status +int +项目状态 ++ +forked_from_project_id +int +fork项目id ++ +fork_info +object +fork项目信息 ++ +size +string +仓库大小 ++ +ssh_url +string +项目ssh地址 ++ +clone_url +string +项目克隆地址 ++ +default_branch +string +仓库默认分支 ++ +empty +bool +仓库是否为空 ++ +full_name +string +仓库全称 ++ +private +bool +仓库是否为私有项目 ++ +license_name +string +许可证名称 ++ +release_versions.list.name +string +项目issue数量 ++ +release_versions.list.tag_name +string +发行版标签名称 ++ +release_versions.list.created_at +string +发行版创建时间 ++ +release_versions.total_count +int +发行版数量 ++ +branches.list.name +string +分支名称 ++ +branches.total_count +int +分支数量 ++ +tags.list.name +string +标签名称 ++ +tags.total_count +int +标签数量 ++ +contributors.list.contributions +int +贡献数量 ++ +contributors.list.login +string +贡献者登录名 ++ +contributors.list.name +string +贡献者用户名称 ++ +contributors.list.image_url +string +贡献者头像 ++ +languages +object +项目语言占比 +++返回的JSON示例:
+{ + "content": "仓库简介", + "website": "仓库网址", + "readme": { + "type": "file", + "encoding": "base64", + "size": 9, + "name": "README.md", + "path": "README.md", + "content": "# ceshi\n\n", + "sha": "" + }, + "identifier": "ceshi", + "name": "测试项目", + "project_id": 2, + "repo_id": 2, + "issues_count": 0, + "pull_requests_count": 0, + "project_identifier": "ceshi", + "praises_count": 0, + "forked_count": 0, + "watchers_count": 0, + "versions_count": 0, + "version_releases_count": 0, + "version_releasesed_count": 0, + "permission": "Reporter", + "mirror_url": null, + "mirror": false, + "type": 0, + "open_devops": false, + "watched": false, + "praised": false, + "status": 1, + "forked_from_project_id": 1, + "fork_info": { + "fork_form_name": "测试项目", + "fork_project_user_login": "ceshi_org", + "fork_project_identifier": "ceshi", + "fork_project_user_name": "ceshi_org" + }, + "size": "25.0 KB", + "ssh_url": "virus@localhost:yystopf/ceshi.git", + "clone_url": "http://localhost:10080/yystopf/ceshi.git", + "default_branch": "master", + "empty": false, + "full_name": "yystopf/ceshi", + "private": false, + "license_name": "gnu-javamail-exception", + "release_versions": { + "list": [ + { + "id": 2, + "name": "vvvv", + "tag_name": "v1.1", + "created_at": "2019-07-18 10:16" + } + ], + "total_count": 1 + }, + "branches": { + "list": [ + { + "name": "master" + } + ], + "total_count": 1 + }, + "tags": { + "list": [ + { + "name": "v1.1" + }, + { + "name": "v1.0" + } + ], + "total_count": 2 + }, + "contributors": { + "list": [ + { + "contributions": 1, + "gid": 2, + "login": "yystopf", + "type": "User", + "name": "yystopf", + "image_url": "avatars/User/b" + } + ], + "total_count": 1 + }, + "languages": { + "HTML": "50.9%", + "Ruby": "25.6%", + "JavaScript": "21.4%", + "CSS": "1.3%", + "CoffeeScript": "0.7%", + "Shell": "0.1%" + } +} +编辑仓库信息
+编辑仓库信息
+ +++示例:
+curl -X GET http://localhost:3000/api/jasder/jasder_test/edit.json +await octokit.request('GET /api/jasder/jasder_test/edit.json') +HTTP 请求
++
GET /api/:owner/:repo/edit.json请求参数:
++
++ + +参数 +必选 +默认 +类型 +字段说明 ++ +owner +是 ++ string +用户登录名 ++ +repo +是 ++ string +项目标识identifier +返回字段说明:
++
+ + +参数 +类型 +字段说明 +identifier string 仓库标识 @@ -1702,9 +2257,9 @@ http://localhost:3000/api/projects/migrate.json -d "private=true" \ http://localhost:3000/api/jasder/jasder_test.jsonawait octokit.request('PATCH /api/jasder/jasder_test.json') -HTTP 请求
+HTTP 请求
-
PATCH /api/:owner/:repo请求参数:
+请求参数:
-
参数 @@ -1764,7 +2319,7 @@ http://localhost:3000/api/jasder/jasder_test.json项目是否私有, true：为私有，false: 公开，默认为公开 返回字段说明:
+返回字段说明:
参数 @@ -1829,9 +2384,9 @@ http://localhost:3000/api/jasder/jasder_test.jsoncurl -X DELETE http://localhost:3000/api/jasder/jasder_test.jsonawait octokit.request('DELETE /api/jasder/jasder_test.json') -HTTP 请求
+HTTP 请求
-
PATCH /api/:owner/:repo请求参数:
+请求参数:
-
参数 @@ -1856,7 +2411,7 @@ http://localhost:3000/api/jasder/jasder_test.json项目标识identifier 返回字段说明:
+返回字段说明:
参数 @@ -1897,83 +2452,8 @@ http://localhost:3000/api/jasder/jasder_test.json -d "user_id=12" \ http://localhost:3000/api/jasder/jasder_test/collaborators.jsonawait octokit.request('POST /api/jasder/jasder_test/collaborators.json') -HTTP 请求
--
POST /api/:owner/:repo/collaborators.json请求参数:
--
-- - -参数 -必选 -默认 -类型 -字段说明 -- -owner -是 -- string -用户登录名 -- -repo -是 -- string -项目标识identifier -- -user_id -是 -int -- 用户id -返回字段说明:
--
- -- - -参数 -类型 -字段说明 -- -status -int -返回状态， 0: 表示操作成功 -- -message -string -返回信息说明 ---返回的JSON示例:
-- -{ - "status": 0, - "message": "success" -} -删除仓库成员
-仓库中删除成员操作
- ---示例:
-curl -X DELETE \ --d "user_id=12" \ -http://localhost:3000/api/jasder/jasder_test/collaborators.json -await octokit.request('DELETE /api/jasder/jasder_test/collaborators.json')HTTP 请求
-+
DELETE /api/:owner/:repo/collaborators.json
POST /api/:owner/:repo/collaborators.json请求参数:
+
@@ -2026,6 +2506,81 @@ http://localhost:3000/api/jasder/jasder_test/collaborators.json ++返回的JSON示例:
++ +{ + "status": 0, + "message": "success" +} +删除仓库成员
+仓库中删除成员操作
+ +++示例:
+curl -X DELETE \ +-d "user_id=12" \ +http://localhost:3000/api/jasder/jasder_test/collaborators.json +await octokit.request('DELETE /api/jasder/jasder_test/collaborators.json') +HTTP 请求
++
DELETE /api/:owner/:repo/collaborators.json请求参数:
++
++ + +参数 +必选 +默认 +类型 +字段说明 ++ +owner +是 ++ string +用户登录名 ++ +repo +是 ++ string +项目标识identifier ++ +user_id +是 +int ++ 用户id +返回字段说明:
++
++ + +参数 +类型 +字段说明 ++ +status +int +返回状态， 0: 表示操作成功 ++ +message +string +返回信息说明 +@@ -2048,9 +2603,9 @@ http://localhost:3000/api/jasder/jasder_test/collaborators.json -d "role=Developer" \ http://localhost:3000/api/jasder/jasder_test/change_role.json返回的JSON示例:
await octokit.request('PUT /api/jasder/jasder_test/change_role.json') -HTTP 请求
+HTTP 请求
-
PUT /api/:owner/:repo/change_role.json请求参数:
+请求参数:
-
参数 @@ -2089,7 +2644,7 @@ http://localhost:3000/api/jasder/jasder_test/change_role.json取值范围："Manager", "Developer", "Reporter"；分别为项目管理人员(拥有所有操作权限)、项目开发人员(只拥有读写权限)、项目报告人员(只拥有读权限) 返回字段说明:
+返回字段说明:
参数 @@ -2131,9 +2686,9 @@ http://localhost:3000/api/jasder/jasder_test/change_role.json -d "limit=5" \ http://localhost:3000/api/jasder/jasder_test/collaborators.jsonawait octokit.request('GET /api/jasder/jasder_test/collaborators.json') -HTTP 请求
+HTTP 请求
-
GET /api/:owner/:repo/collaborators.json请求参数:
+请求参数:
-
参数 @@ -2172,7 +2727,7 @@ http://localhost:3000/api/jasder/jasder_test/collaborators.json每页多少条数据，默认15条 返回字段说明:
+返回字段说明:
参数 @@ -2250,7 +2805,130 @@ http://localhost:3000/api/jasder/jasder_test/collaborators.json -获取仓库代码目录
+获取仓库所有文件
+获取仓库所有文件
+ +++示例:
+curl -X GET \ +-d "ref=develop" \ +http://localhost:3000/api/yystopf/ceshi/files.json +await octokit.request('GET /api/yystopf/ceshi/files.json') +HTTP 请求
++
GET /api/:owner/:repo/files请求参数:
++
++ + +参数 +必选 +默认 +类型 +字段说明 ++ +owner +是 ++ string +用户登录名 ++ +repo +是 ++ string +项目标识identifier ++ +search +否 ++ string +文件搜索关键词 ++ +ref +是 ++ string +分支名，默认为仓库默认分支 +返回字段说明:
++
+ ++ + +参数 +类型 +字段说明 ++ +name +string +文件名称 ++ +path +string +文件路径 ++ +sha +string +文件标识 ++ +type +string +文件类型 ++ +size +int +文件大小 ++ +url +string +文件地址 +++返回的JSON示例:
+[ + { + "name": ".gitignore", + "path": ".gitignore", + "sha": "f83922d01ae60f6e637a1a2b9f08871b4f87dfc8", + "type": "file", + "size": 63, + "url": "http://localhost:10080/api/v1/repos/yystopf/ceshi/contents/.gitignore?ref=master", + "html_url": "http://localhost:10080/yystopf/ceshi/src/branch/master/.gitignore" + }, + { + "name": "LICENSE", + "path": "LICENSE", + "sha": "8f3b9ab0d08afd3a624d822e3971a2f42b3bc2b9", + "type": "file", + "size": 341, + "url": "http://localhost:10080/api/v1/repos/yystopf/ceshi/contents/LICENSE?ref=master", + "html_url": "http://localhost:10080/yystopf/ceshi/src/branch/master/LICENSE" + }, + { + "name": "README.md", + "path": "README.md", + "sha": "1bc8a60ac6ddc876ebc4b60fc68991435bfad93e", + "type": "file", + "size": 9, + "url": "http://localhost:10080/api/v1/repos/yystopf/ceshi/contents/README.md?ref=master", + "html_url": "http://localhost:10080/yystopf/ceshi/src/branch/master/README.md" + } +] +获取仓库代码目录
获取仓库代码目录
@@ -2260,9 +2938,9 @@ http://localhost:3000/api/jasder/jasder_test/collaborators.json -d "ref=develop" \ http://localhost:3000//api/jasder/jasder_test/entries.jsonawait octokit.request('GET /api/jasder/jasder_test/entries.json') -HTTP 请求
+HTTP 请求
-
GET /api/:owner/:repo/entries.json请求参数:
+请求参数:
-
参数 @@ -2294,7 +2972,7 @@ http://localhost:3000//api/jasder/jasder_test/entries.json分支名称、tag名称或是提交记录id，默认为master分支 返回字段说明:
+返回字段说明:
参数 @@ -2408,9 +3086,9 @@ http://localhost:3000//api/jasder/jasder_test/entries.json -d "filepath=file" \ http://localhost:3000//api/jasder/jasder_test/sub_entries.jsonawait octokit.request('GET /api/jasder/jasder_test/sub_entries.json') -HTTP 请求
+HTTP 请求
-
GET /api/:owner/:repo/sub_entries.json请求参数:
+请求参数:
-
参数 @@ -2449,7 +3127,7 @@ http://localhost:3000//api/jasder/jasder_test/sub_entries.json分支名称、tag名称或是提交记录id，默认为master分支 返回字段说明:
+返回字段说明:
参数 diff --git a/spec/models/project_unit_spec.rb b/spec/models/project_unit_spec.rb new file mode 100644 index 00000000..d95607ca --- /dev/null +++ b/spec/models/project_unit_spec.rb @@ -0,0 +1,5 @@ +require 'rails_helper' + +RSpec.describe ProjectUnit, type: :model do + pending "add some examples to (or delete) #{__FILE__}" +end