diff --git a/app/docs/slate/source/includes/_repositories.md b/app/docs/slate/source/includes/_repositories.md index c27243da6..eaae10746 100644 --- a/app/docs/slate/source/includes/_repositories.md +++ b/app/docs/slate/source/includes/_repositories.md @@ -924,6 +924,71 @@ await octokit.request('GET /api/yystopf/csfjkkj/readme.json') Success Data. +## 获取仓库贡献者 +获取仓库贡献者 + +> 示例: + +```shell +curl -X GET \ +-d "ref=master" \ +-d "filepath=lib" \ +http://localhost:3000/api/yystopf/csfjkkj/contributors.json +``` + +```javascript +await octokit.request('GET /api/yystopf/csfjkkj/contributors.json') +``` + +### HTTP 请求 +`GET /api/:owner/:repo/contributors.json` + +### 请求参数: +参数 | 必选 | 默认 | 类型 | 字段说明 +--------- | ------- | ------- | -------- | ---------- +|owner |是| |string |用户登录名 | +|repo |是| |string |项目标识identifier | +|ref |否| | string |分支名称、tag名称或是提交记录id，默认为整个仓库 | +|filepath |否| | string |子目录名称，默认为空 | + +### 返回字段说明: +参数 | 类型 | 字段说明 +--------- | ----------- | ----------- +|total_count |integer|贡献者数量| +|contributions |integer|贡献数量| +|login |string |用户登录名 | +|type |string|用户类型 | +|name |string|用户昵称| +|image_url |string|用户头像| + + +> 返回的JSON示例: + +```json +{ + "contributors": [ + { + "contributions": 5, + "login": "testforge2", + "type": "User", + "name": "testforge2", + "image_url": "system/lets/letter_avatars/2/T/236_177_85/120.png" + }, + { + "contributions": 79, + "login": "yystopf", + "type": "User", + "name": "yystopf", + "image_url": "system/lets/letter_avatars/2/Y/241_125_89/120.png" + } + ], + "total_count": 2 +} +``` + + ## 获取仓库webhooks列表 获取仓库webhooks列表 diff --git a/public/docs/api.html b/public/docs/api.html index 5e3baed1c..4ec491b4f 100644 --- a/public/docs/api.html +++ b/public/docs/api.html @@ -502,6 +502,9 @@
  • 获取仓库README文件
    • +
  • + 获取仓库贡献者 +
  • 获取仓库webhooks列表
    • @@ -7363,17 +7366,19 @@ http://localhost:3000/api/yystopf/csfjkkj/readme.json -

    获取仓库webhooks列表

    -

    获取仓库webhooks列表

    +

    获取仓库贡献者

    +

    获取仓库贡献者

    示例:

    curl -X GET \
-http://localhost:3000/api/yystopf/ceshi/webhooks.json
-
    await octokit.request('GET /api/yystopf/ceshi/webhooks.json')
+-d "ref=master" \
+-d "filepath=lib" \
+http://localhost:3000/api/yystopf/csfjkkj/contributors.json
+
    await octokit.request('GET /api/yystopf/csfjkkj/contributors.json')

    HTTP 请求

    -

    GET /api/:owner/:repo/webhooks.json

    +

    GET /api/:owner/:repo/contributors.json

    请求参数:

    @@ -7398,6 +7403,20 @@ http://localhost:3000/api/yystopf/ceshi/webhooks.json + + + + + + + + + + + + + +
    string 项目标识identifier
    ref否string分支名称、tag名称或是提交记录id，默认为整个仓库
    filepath否string子目录名称，默认为空

    返回字段说明:

    @@ -7408,6 +7427,108 @@ http://localhost:3000/api/yystopf/ceshi/webhooks.json + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    total_countinteger贡献者数量
    contributionsinteger贡献数量
    loginstring用户登录名
    typestring用户类型
    namestring用户昵称
    image_urlstring用户头像
    + +
    +

    返回的JSON示例:

    +
    +
    {
+    "contributors": [
+        {
+            "contributions": 5,
+            "login": "testforge2",
+            "type": "User",
+            "name": "testforge2",
+            "image_url": "system/lets/letter_avatars/2/T/236_177_85/120.png"
+        },
+        {
+            "contributions": 79,
+            "login": "yystopf",
+            "type": "User",
+            "name": "yystopf",
+            "image_url": "system/lets/letter_avatars/2/Y/241_125_89/120.png"
+        }
+    ],
+    "total_count": 2
+}
+
    + +

    获取仓库webhooks列表

    +

    获取仓库webhooks列表

    + +
    +

    示例:

    +
    +
    curl -X GET \
+http://localhost:3000/api/yystopf/ceshi/webhooks.json
+
    await octokit.request('GET /api/yystopf/ceshi/webhooks.json')
+

    HTTP 请求

    +

    GET /api/:owner/:repo/webhooks.json

    +

    请求参数:

    + + + + + + + + + + + + + + + + + + + + + + + +
    参数必选默认类型字段说明
    owner是string用户登录名
    repo是string项目标识identifier
    +

    返回字段说明:

    + + + + + + + + @@ -7501,9 +7622,9 @@ http://localhost:3000/api/yystopf/ceshi/webhooks.json 
    curl -X GET \
 http://localhost:3000/api/yystopf/ceshi/webhooks/3/edit.json
 
    await octokit.request('GET /api/yystopf/ceshi/webhooks/3/edit.json')
-

    HTTP 请求

    +

    HTTP 请求

    GET /api/:owner/:repo/webhooks/:id/edit.json

    -

    请求参数:

    +

    请求参数:

    参数类型字段说明
    id int id
    @@ -7535,7 +7656,7 @@ http://localhost:3000/api/yystopf/ceshi/webhooks/3/edit.json
    参数webhook ID
    -

    返回字段说明:

    +

    返回字段说明:

    @@ -7736,266 +7857,8 @@ http://localhost:3000/api/yystopf/ceshi/webhooks/3/edit.json 
    curl -X POST \
 http://localhost:3000/api/yystopf/ceshi/webhooks.json
 
    await octokit.request('POST /api/yystopf/ceshi/webhooks.json')
-

    HTTP 请求

    -

    POST /api/:owner/:repo/webhooks.json

    -

    请求参数:

    -
    参数
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    参数必选默认类型字段说明
    owner是string用户登录名
    repo是string项目标识identifier
    webhook.url是string目标url
    webhook.type否string类型
    webhook.http_method是stringhttp方法, POST和GET
    webhook.content_type是stringPOST Content Type
    webhook.secret否string密钥文本
    webhook.active是bool是否激活
    webhook.branch_filter否string分支过滤
    webhook.events否array触发事件
    - -

    触发事件字段说明

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    参数含义
    create创建分支或标签
    delete分支或标签删除
    fork仓库被fork
    pushgit仓库推送
    issue易修已打开、已关闭、已重新打开或编辑
    issue_assign易修被指派
    issue_label易修标签被更新或删除
    issue_milestone易修被收入里程碑
    issue_comment易修评论
    pull_request合并请求
    pull_request_assign合并请求被指派
    pull_request_label合并请求被贴上标签
    pull_request_milestone合并请求被记录于里程碑中
    pull_request_comment合并请求被评论
    pull_request_review_approved合并请求被批准
    pull_request_review_rejected合并请求被拒绝
    pull_request_review_comment合并请求被提出审查意见
    pull_request_sync合并请求被同步
    repository创建或删除仓库
    release版本发布
    - -
    -

    请求的JSON示例:

    -
    -
    {
-    "active": true, 
-    "content_type": "json",
-    "http_method": "GET",
-    "secret": "123456",
-    "url": "http://localhost:10000",
-    "branch_filter": "*",
-    "events": ["push"]
-}
-

    返回字段说明:

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    参数类型字段说明
    idintid
    urlstring地址
    content_typestringPOST Content Type
    is_activebool是否激活
    typestring类型
    eventsarray触发事件
    create_timestring创建时间
    - -
    -

    返回的JSON示例:

    -
    -
    {
-    "id": 18,
-    "type": "gitea",
-    "content_type": "json",
-    "url": "http://localhost:10000",
-    "events": [
-        "push"
-    ],
-    "active": true,
-    "create_time": "2021-07-26 18:53:43"
-}
-
    - -

    更新仓库webhook

    -

    更新仓库webhook

    - -
    -

    示例:

    -
    -
    curl -X PATCH \
-http://localhost:3000/api/yystopf/ceshi/webhooks/7.json
-
    await octokit.request('PATCH /api/yystopf/ceshi/webhooks/7.json')

    HTTP 请求

    -

    PATCH /api/:owner/:repo/webhooks/:id.json

    +

    POST /api/:owner/:repo/webhooks.json

    请求参数:

    @@ -8021,13 +7884,6 @@ http://localhost:3000/api/yystopf/ceshi/webhooks/7.json - - - - - - - @@ -8188,28 +8044,79 @@ http://localhost:3000/api/yystopf/ceshi/webhooks/7.json "events": ["push"] }

    返回字段说明:

    +
    项目标识identifier
    id是stringwebhook id
    webhook.url 是
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    参数类型字段说明
    idintid
    urlstring地址
    content_typestringPOST Content Type
    is_activebool是否激活
    typestring类型
    eventsarray触发事件
    create_timestring创建时间
    +

    返回的JSON示例:

    {
-    "status": 0,
-    "message": "success"
+    "id": 18,
+    "type": "gitea",
+    "content_type": "json",
+    "url": "http://localhost:10000",
+    "events": [
+        "push"
+    ],
+    "active": true,
+    "create_time": "2021-07-26 18:53:43"
 }
    -

    删除仓库webhook

    -

    删除仓库webhook

    +

    更新仓库webhook

    +

    更新仓库webhook

    示例:

    -
    curl -X DELETE \
+
    curl -X PATCH \
 http://localhost:3000/api/yystopf/ceshi/webhooks/7.json
-
    await octokit.request('DELETE /api/yystopf/ceshi/webhooks/7.json')
+
    await octokit.request('PATCH /api/yystopf/ceshi/webhooks/7.json')
 
    HTTP 请求
    
-
    DELETE /api/:owner/:repo/webhooks/:id.json
    
+
    PATCH /api/:owner/:repo/webhooks/:id.json
    
 
    请求参数:
    
 
@@ -8241,8 +8148,222 @@ http://localhost:3000/api/yystopf/ceshi/webhooks/7.json
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    
 
    string
 webhook id
 
    webhook.url是string目标url
    webhook.type否string类型
    webhook.http_method是stringhttp方法, POST和GET
    webhook.content_type是stringPOST Content Type
    webhook.secret否string密钥文本
    webhook.active是bool是否激活
    webhook.branch_filter否string分支过滤
    webhook.events否array触发事件
    
 
    
-
    返回字段说明:
    
+
+
    触发事件字段说明 
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    参数含义
    create创建分支或标签
    delete分支或标签删除
    fork仓库被fork
    pushgit仓库推送
    issue易修已打开、已关闭、已重新打开或编辑
    issue_assign易修被指派
    issue_label易修标签被更新或删除
    issue_milestone易修被收入里程碑
    issue_comment易修评论
    pull_request合并请求
    pull_request_assign合并请求被指派
    pull_request_label合并请求被贴上标签
    pull_request_milestone合并请求被记录于里程碑中
    pull_request_comment合并请求被评论
    pull_request_review_approved合并请求被批准
    pull_request_review_rejected合并请求被拒绝
    pull_request_review_comment合并请求被提出审查意见
    pull_request_sync合并请求被同步
    repository创建或删除仓库
    release版本发布
    
+
+
    
+
    请求的JSON示例:
    
+
    
+
    {
+    "active": true, 
+    "content_type": "json",
+    "http_method": "GET",
+    "secret": "123456",
+    "url": "http://localhost:10000",
+    "branch_filter": "*",
+    "events": ["push"]
+}
+
    返回字段说明:
    
+
    
+
    返回的JSON示例:
    
+
    
+
    {
+    "status": 0,
+    "message": "success"
+}
+
    
+
+
    删除仓库webhook
    
+
    删除仓库webhook
    
+
+
    
+
    示例:
    
+
    
+
    curl -X DELETE \
+http://localhost:3000/api/yystopf/ceshi/webhooks/7.json
+
    await octokit.request('DELETE /api/yystopf/ceshi/webhooks/7.json')
+
    HTTP 请求
    
+
    DELETE /api/:owner/:repo/webhooks/:id.json
    
+
    请求参数:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    参数必选默认类型字段说明
    owner是string用户登录名
    repo是string项目标识identifier
    id是stringwebhook id
    
+
    返回字段说明:
    
 
    
 
    返回的JSON示例:
    
 
    
@@ -8263,9 +8384,9 @@ http://localhost:3000/api/yystopf/ceshi/webhooks/7.json
 
    curl -X GET \
 http://localhost:3000/api/yystopf/ceshi/webhooks/3/tasks.json
 
    await octokit.request('GET /api/yystopf/ceshi/webhooks/3/tasks.json')
-
    HTTP 请求
    
+

    HTTP 请求

    GET /api/:owner/:repo/webhooks/:id/tasks.json

    -

    请求参数:

    +

    请求参数:

    @@ -8297,7 +8418,7 @@ http://localhost:3000/api/yystopf/ceshi/webhooks/3/tasks.json
    参数webhook ID
    -

    返回字段说明:

    +

    返回字段说明:

    @@ -8534,9 +8655,9 @@ http://localhost:3000/api/yystopf/ceshi/webhooks/3/tasks.json 
    curl -X POST \
 http://localhost:3000/api/yystopf/ceshi/webhooks/3/test.json
 
    await octokit.request('POST /api/yystopf/ceshi/webhooks/3/test.json')
-

    HTTP 请求

    +

    HTTP 请求

    POST /api/:owner/:repo/webhooks/:id/test.json

    -

    请求参数:

    +

    请求参数:

    参数
    @@ -8568,7 +8689,7 @@ http://localhost:3000/api/yystopf/ceshi/webhooks/3/test.json
    参数webhook ID
    -

    返回字段说明:

    +

    返回字段说明:

    返回的JSON示例: