mirror of
https://gitlink.org.cn/Gitlink/forgeplus.git
synced 2026-05-02 19:30:48 +08:00
新增: 获取单文件blame信息
This commit is contained in:
2
Gemfile
2
Gemfile
@@ -135,4 +135,4 @@ gem 'doorkeeper'
|
||||
|
||||
gem 'doorkeeper-jwt'
|
||||
|
||||
gem 'gitea-client', '~> 0.10.1'
|
||||
gem 'gitea-client', '~> 0.10.2'
|
||||
@@ -1,5 +1,5 @@
|
||||
class Api::V1::ProjectsController < Api::V1::BaseController
|
||||
before_action :require_public_and_member_above, only: [:show, :compare]
|
||||
before_action :require_public_and_member_above, only: [:show, :compare, :blame]
|
||||
|
||||
def index
|
||||
render_ok
|
||||
@@ -12,4 +12,9 @@ class Api::V1::ProjectsController < Api::V1::BaseController
|
||||
def compare
|
||||
@result_object = Api::V1::Projects::CompareService.call(@project, params[:from], params[:to], current_user&.gitea_token)
|
||||
end
|
||||
|
||||
def blame
|
||||
@result_object = Api::V1::Projects::BlameService.call(@project, params[:sha], params[:filepath], current_user&.gitea_token)
|
||||
puts @result_object
|
||||
end
|
||||
end
|
||||
@@ -1614,6 +1614,203 @@ await octokit.request('GET /api/v1/yystopf/csfjkkj/commits/80dd40214a58622312393
|
||||
Success Data.
|
||||
</aside>
|
||||
|
||||
## 获取单个文件的blame信息
|
||||
根据分支、标签、commitID获取某个文件的blame信息
|
||||
|
||||
> 示例:
|
||||
|
||||
```shell
|
||||
curl -X GET \
|
||||
-d "sha=master" \
|
||||
-d "filepath=hd.txt" \
|
||||
http://localhost:3000/api/v1/yystopf/csfjkkj/blame.json
|
||||
```
|
||||
|
||||
```javascript
|
||||
await octokit.request('GET /api/v1/yystopf/csfjkkj/blame.json')
|
||||
```
|
||||
|
||||
### HTTP 请求
|
||||
`GET /api/v1/:owner/:repo/blame.json`
|
||||
|
||||
### 请求参数:
|
||||
参数 | 必选 | 默认 | 类型 | 字段说明
|
||||
--------- | ------- | ------- | -------- | ----------
|
||||
|owner |是| | string |用户登录名 |
|
||||
|repo |是| | string |项目标识identifier |
|
||||
|sha |是| | string |分支、标签或提交记录id |
|
||||
|filepath|是| | string |文件路径|
|
||||
### 返回字段说明:
|
||||
参数 | 类型 | 字段说明
|
||||
--------- | ----------- | -----------
|
||||
|file_size|int|文件大小|
|
||||
|file_name|string|文件名称|
|
||||
|num_lines|int|文件总行数|
|
||||
|blame_parts.commit|object|提交|
|
||||
|blame_parts.current_number|int|当前行数|
|
||||
|blame_parts.effect_line|int|影响的行数|
|
||||
|blame_parts.lines|array|行内容|
|
||||
|
||||
> 返回的JSON示例:
|
||||
|
||||
```json
|
||||
{
|
||||
"file_size": 32,
|
||||
"file_name": "hd.txt",
|
||||
"num_lines": 12,
|
||||
"blame_parts": [
|
||||
{
|
||||
"commit": {
|
||||
"sha": "40f76e80bf5bc41fcc94c28ca8a6eab506c15215",
|
||||
"author": {
|
||||
"id": null,
|
||||
"login": "viletyy",
|
||||
"name": "viletyy",
|
||||
"type": null,
|
||||
"image_url": "system/lets/letter_avatars/2/V/39_141_222/120.png"
|
||||
},
|
||||
"committer": {
|
||||
"id": null,
|
||||
"login": "viletyy",
|
||||
"name": "viletyy",
|
||||
"type": null,
|
||||
"image_url": "system/lets/letter_avatars/2/V/39_141_222/120.png"
|
||||
},
|
||||
"commit_message": "fix\n",
|
||||
"authored_time": "2022-07-04 18:41:25",
|
||||
"committed_time": "2022-07-04 18:41:25",
|
||||
"created_time": "2022-07-04 18:41:25"
|
||||
},
|
||||
"current_number": 1,
|
||||
"effect_line": 5,
|
||||
"lines": [
|
||||
"dkfj",
|
||||
"s",
|
||||
"324",
|
||||
"234",
|
||||
"2"
|
||||
]
|
||||
},
|
||||
{
|
||||
"commit": {
|
||||
"sha": "86c62a1e91c07b58b8aa6c89b94856d89c0f7e55",
|
||||
"author": {
|
||||
"id": null,
|
||||
"login": "viletyy",
|
||||
"name": "viletyy",
|
||||
"type": null,
|
||||
"image_url": "system/lets/letter_avatars/2/V/39_141_222/120.png"
|
||||
},
|
||||
"committer": {
|
||||
"id": null,
|
||||
"login": "viletyy",
|
||||
"name": "viletyy",
|
||||
"type": null,
|
||||
"image_url": "system/lets/letter_avatars/2/V/39_141_222/120.png"
|
||||
},
|
||||
"commit_message": "fix\n",
|
||||
"authored_time": "2022-07-05 11:00:45",
|
||||
"committed_time": "2022-07-05 11:00:45",
|
||||
"created_time": "2022-07-05 11:00:45"
|
||||
},
|
||||
"current_number": 6,
|
||||
"effect_line": 1,
|
||||
"lines": [
|
||||
"dd"
|
||||
]
|
||||
},
|
||||
{
|
||||
"commit": {
|
||||
"sha": "40f76e80bf5bc41fcc94c28ca8a6eab506c15215",
|
||||
"author": {
|
||||
"id": null,
|
||||
"login": "viletyy",
|
||||
"name": "viletyy",
|
||||
"type": null,
|
||||
"image_url": "system/lets/letter_avatars/2/V/39_141_222/120.png"
|
||||
},
|
||||
"committer": {
|
||||
"id": null,
|
||||
"login": "viletyy",
|
||||
"name": "viletyy",
|
||||
"type": null,
|
||||
"image_url": "system/lets/letter_avatars/2/V/39_141_222/120.png"
|
||||
},
|
||||
"commit_message": "fix\n",
|
||||
"authored_time": "2022-07-04 18:41:25",
|
||||
"committed_time": "2022-07-04 18:41:25",
|
||||
"created_time": "2022-07-04 18:41:25"
|
||||
},
|
||||
"current_number": 7,
|
||||
"effect_line": 3,
|
||||
"lines": [
|
||||
"23",
|
||||
"4",
|
||||
"23"
|
||||
]
|
||||
},
|
||||
{
|
||||
"commit": {
|
||||
"sha": "86c62a1e91c07b58b8aa6c89b94856d89c0f7e55",
|
||||
"author": {
|
||||
"id": null,
|
||||
"login": "viletyy",
|
||||
"name": "viletyy",
|
||||
"type": null,
|
||||
"image_url": "system/lets/letter_avatars/2/V/39_141_222/120.png"
|
||||
},
|
||||
"committer": {
|
||||
"id": null,
|
||||
"login": "viletyy",
|
||||
"name": "viletyy",
|
||||
"type": null,
|
||||
"image_url": "system/lets/letter_avatars/2/V/39_141_222/120.png"
|
||||
},
|
||||
"commit_message": "fix\n",
|
||||
"authored_time": "2022-07-05 11:00:45",
|
||||
"committed_time": "2022-07-05 11:00:45",
|
||||
"created_time": "2022-07-05 11:00:45"
|
||||
},
|
||||
"current_number": 10,
|
||||
"effect_line": 1,
|
||||
"lines": [
|
||||
"s1"
|
||||
]
|
||||
},
|
||||
{
|
||||
"commit": {
|
||||
"sha": "40f76e80bf5bc41fcc94c28ca8a6eab506c15215",
|
||||
"author": {
|
||||
"id": null,
|
||||
"login": "viletyy",
|
||||
"name": "viletyy",
|
||||
"type": null,
|
||||
"image_url": "system/lets/letter_avatars/2/V/39_141_222/120.png"
|
||||
},
|
||||
"committer": {
|
||||
"id": null,
|
||||
"login": "viletyy",
|
||||
"name": "viletyy",
|
||||
"type": null,
|
||||
"image_url": "system/lets/letter_avatars/2/V/39_141_222/120.png"
|
||||
},
|
||||
"commit_message": "fix\n",
|
||||
"authored_time": "2022-07-04 18:41:25",
|
||||
"committed_time": "2022-07-04 18:41:25",
|
||||
"created_time": "2022-07-04 18:41:25"
|
||||
},
|
||||
"current_number": 11,
|
||||
"effect_line": 1,
|
||||
"lines": [
|
||||
""
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
<aside class="success">
|
||||
Success Data.
|
||||
</aside>
|
||||
## 获取比较提交blame
|
||||
根据分支名、标签、commit ID来获取代码对比blame
|
||||
|
||||
|
||||
38
app/services/api/v1/projects/blame_service.rb
Normal file
38
app/services/api/v1/projects/blame_service.rb
Normal file
@@ -0,0 +1,38 @@
|
||||
class Api::V1::Projects::BlameService < ApplicationService
|
||||
include ActiveModel::Model
|
||||
|
||||
attr_reader :project, :sha, :filepath, :owner, :repo, :token
|
||||
attr_accessor :gitea_data
|
||||
|
||||
validates :sha, :filepath, presence: true
|
||||
|
||||
def initialize(project, sha, filepath, token=nil)
|
||||
@project = project
|
||||
@owner = project&.owner.login
|
||||
@repo = project&.identifier
|
||||
@sha = sha
|
||||
@filepath = filepath
|
||||
@token = token
|
||||
end
|
||||
|
||||
def call
|
||||
raise Error, errors.full_messages.join(",") unless valid?
|
||||
load_gitea_data
|
||||
|
||||
gitea_data
|
||||
end
|
||||
|
||||
private
|
||||
def request_params
|
||||
{
|
||||
access_token: token,
|
||||
sha: sha,
|
||||
filepath: filepath
|
||||
}
|
||||
end
|
||||
|
||||
def load_gitea_data
|
||||
@gitea_data = $gitea_client.get_repos_blame_by_owner_repo(owner, repo, {query: request_params})
|
||||
raise Error, '获取项目blame失败！' unless @gitea_data.is_a?(Hash)
|
||||
end
|
||||
end
|
||||
22
app/views/api/v1/projects/blame.json.jbuilder
Normal file
22
app/views/api/v1/projects/blame.json.jbuilder
Normal file
@@ -0,0 +1,22 @@
|
||||
json.file_size @result_object['file_size']
|
||||
json.file_name @result_object['file_name']
|
||||
json.num_lines @result_object['num_lines']
|
||||
json.blame_parts @result_object['blame_parts'] do |part|
|
||||
json.commit do
|
||||
json.sha part['commit']['id']
|
||||
json.author do
|
||||
json.partial! 'api/v1/users/commit_user', locals: { user: render_cache_commit_author(part['commit']['author']), name: part['commit']['author']['Name'] }
|
||||
end
|
||||
|
||||
json.committer do
|
||||
json.partial! 'api/v1/users/commit_user', locals: { user: render_cache_commit_author(part['commit']['commiter']), name: part['commit']['commiter']['Name'] }
|
||||
end
|
||||
json.commit_message part['commit']['commit_message']
|
||||
json.authored_time part['commit']['authored_time'].to_time.strftime("%Y-%m-%d %H:%M:%S")
|
||||
json.committed_time part['commit']['committed_time'].to_time.strftime("%Y-%m-%d %H:%M:%S")
|
||||
json.created_time part['commit']['created_time'].to_time.strftime("%Y-%m-%d %H:%M:%S")
|
||||
end
|
||||
json.current_number part['current_number']
|
||||
json.effect_line part['effect_line']
|
||||
json.lines part['lines']
|
||||
end
|
||||
@@ -12,6 +12,7 @@ defaults format: :json do
|
||||
resource :projects, path: '/', only: [:show, :update, :edit, :destroy] do
|
||||
collection do
|
||||
get :compare
|
||||
get :blame
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -560,7 +560,10 @@
|
||||
<a href="#blame" class="toc-h2 toc-link" data-title="获取单个提交的blame信息">获取单个提交的blame信息</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#blame-2" class="toc-h2 toc-link" data-title="获取比较提交blame">获取比较提交blame</a>
|
||||
<a href="#blame-2" class="toc-h2 toc-link" data-title="获取单个文件的blame信息">获取单个文件的blame信息</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#blame-3" class="toc-h2 toc-link" data-title="获取比较提交blame">获取比较提交blame</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#webhooks" class="toc-h2 toc-link" data-title="获取仓库webhooks列表">获取仓库webhooks列表</a>
|
||||
@@ -10084,7 +10087,264 @@ http://localhost:3000/api/v1/yystopf/csfjkkj/commits.json
|
||||
<aside class="success">
|
||||
Success Data.
|
||||
</aside>
|
||||
<h2 id='blame-2'>获取比较提交blame</h2>
|
||||
<h2 id='blame-2'>获取单个文件的blame信息</h2>
|
||||
<p>根据分支、标签、commitID获取某个文件的blame信息</p>
|
||||
|
||||
<blockquote>
|
||||
<p>示例:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> GET <span class="se">\</span>
|
||||
<span class="nt">-d</span> <span class="s2">"sha=master"</span> <span class="se">\</span>
|
||||
<span class="nt">-d</span> <span class="s2">"filepath=hd.txt"</span> <span class="se">\</span>
|
||||
http://localhost:3000/api/v1/yystopf/csfjkkj/blame.json
|
||||
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="k">await</span> <span class="nx">octokit</span><span class="p">.</span><span class="nx">request</span><span class="p">(</span><span class="dl">'</span><span class="s1">GET /api/v1/yystopf/csfjkkj/blame.json</span><span class="dl">'</span><span class="p">)</span>
|
||||
</code></pre></div><h3 id='http-24'>HTTP 请求</h3>
|
||||
<p><code>GET /api/v1/:owner/:repo/blame.json</code></p>
|
||||
<h3 id='2eb6f47757-24'>请求参数:</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
<th>必选</th>
|
||||
<th>默认</th>
|
||||
<th>类型</th>
|
||||
<th>字段说明</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>owner</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>用户登录名</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>repo</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>项目标识identifier</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sha</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>分支、标签或提交记录id</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>filepath</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>文件路径</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='7447e4874e-24'>返回字段说明:</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
<th>类型</th>
|
||||
<th>字段说明</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>file_size</td>
|
||||
<td>int</td>
|
||||
<td>文件大小</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>file_name</td>
|
||||
<td>string</td>
|
||||
<td>文件名称</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>num_lines</td>
|
||||
<td>int</td>
|
||||
<td>文件总行数</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>blame_parts.commit</td>
|
||||
<td>object</td>
|
||||
<td>提交</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>blame_parts.current_number</td>
|
||||
<td>int</td>
|
||||
<td>当前行数</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>blame_parts.effect_line</td>
|
||||
<td>int</td>
|
||||
<td>影响的行数</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>blame_parts.lines</td>
|
||||
<td>array</td>
|
||||
<td>行内容</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
|
||||
<blockquote>
|
||||
<p>返回的JSON示例:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"file_size"</span><span class="p">:</span><span class="w"> </span><span class="mi">32</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"file_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"hd.txt"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"num_lines"</span><span class="p">:</span><span class="w"> </span><span class="mi">12</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"blame_parts"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"commit"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"sha"</span><span class="p">:</span><span class="w"> </span><span class="s2">"40f76e80bf5bc41fcc94c28ca8a6eab506c15215"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"author"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"login"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"system/lets/letter_avatars/2/V/39_141_222/120.png"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nl">"committer"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"login"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"system/lets/letter_avatars/2/V/39_141_222/120.png"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nl">"commit_message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fix</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"authored_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-07-04 18:41:25"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"committed_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-07-04 18:41:25"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"created_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-07-04 18:41:25"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nl">"current_number"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"effect_line"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"dkfj"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"s"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"324"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"234"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"2"</span><span class="w">
|
||||
</span><span class="p">]</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"commit"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"sha"</span><span class="p">:</span><span class="w"> </span><span class="s2">"86c62a1e91c07b58b8aa6c89b94856d89c0f7e55"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"author"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"login"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"system/lets/letter_avatars/2/V/39_141_222/120.png"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nl">"committer"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"login"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"system/lets/letter_avatars/2/V/39_141_222/120.png"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nl">"commit_message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fix</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"authored_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-07-05 11:00:45"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"committed_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-07-05 11:00:45"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"created_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-07-05 11:00:45"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nl">"current_number"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"effect_line"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"dd"</span><span class="w">
|
||||
</span><span class="p">]</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"commit"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"sha"</span><span class="p">:</span><span class="w"> </span><span class="s2">"40f76e80bf5bc41fcc94c28ca8a6eab506c15215"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"author"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"login"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"system/lets/letter_avatars/2/V/39_141_222/120.png"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nl">"committer"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"login"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"system/lets/letter_avatars/2/V/39_141_222/120.png"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nl">"commit_message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fix</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"authored_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-07-04 18:41:25"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"committed_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-07-04 18:41:25"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"created_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-07-04 18:41:25"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nl">"current_number"</span><span class="p">:</span><span class="w"> </span><span class="mi">7</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"effect_line"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"23"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"4"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"23"</span><span class="w">
|
||||
</span><span class="p">]</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"commit"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"sha"</span><span class="p">:</span><span class="w"> </span><span class="s2">"86c62a1e91c07b58b8aa6c89b94856d89c0f7e55"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"author"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"login"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"system/lets/letter_avatars/2/V/39_141_222/120.png"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nl">"committer"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"login"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"system/lets/letter_avatars/2/V/39_141_222/120.png"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nl">"commit_message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fix</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"authored_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-07-05 11:00:45"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"committed_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-07-05 11:00:45"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"created_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-07-05 11:00:45"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nl">"current_number"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"effect_line"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"s1"</span><span class="w">
|
||||
</span><span class="p">]</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"commit"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"sha"</span><span class="p">:</span><span class="w"> </span><span class="s2">"40f76e80bf5bc41fcc94c28ca8a6eab506c15215"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"author"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"login"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"system/lets/letter_avatars/2/V/39_141_222/120.png"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nl">"committer"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"login"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viletyy"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"system/lets/letter_avatars/2/V/39_141_222/120.png"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nl">"commit_message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fix</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"authored_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-07-04 18:41:25"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"committed_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-07-04 18:41:25"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"created_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-07-04 18:41:25"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nl">"current_number"</span><span class="p">:</span><span class="w"> </span><span class="mi">11</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"effect_line"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">""</span><span class="w">
|
||||
</span><span class="p">]</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">]</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div>
|
||||
<aside class="success">
|
||||
Success Data.
|
||||
</aside>
|
||||
<h2 id='blame-3'>获取比较提交blame</h2>
|
||||
<p>根据分支名、标签、commit ID来获取代码对比blame</p>
|
||||
|
||||
<blockquote>
|
||||
@@ -10095,9 +10355,9 @@ http://localhost:3000/api/v1/yystopf/csfjkkj/commits.json
|
||||
<span class="nt">-d</span> <span class="s2">"to=master"</span> <span class="se">\</span>
|
||||
http://localhost:3000/api/v1/yystopf/csfjkkj/compare.json
|
||||
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="k">await</span> <span class="nx">octokit</span><span class="p">.</span><span class="nx">request</span><span class="p">(</span><span class="dl">'</span><span class="s1">GET /api/v1/yystopf/csfjkkj/compare.json</span><span class="dl">'</span><span class="p">)</span>
|
||||
</code></pre></div><h3 id='http-24'>HTTP 请求</h3>
|
||||
</code></pre></div><h3 id='http-25'>HTTP 请求</h3>
|
||||
<p><code>GET /api/v1/:owner/:repo/compare.json</code></p>
|
||||
<h3 id='2eb6f47757-24'>请求参数:</h3>
|
||||
<h3 id='2eb6f47757-25'>请求参数:</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
@@ -10136,7 +10396,7 @@ http://localhost:3000/api/v1/yystopf/csfjkkj/compare.json
|
||||
<td>目标分支、标签、commitID</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='7447e4874e-24'>返回字段说明:</h3>
|
||||
<h3 id='7447e4874e-25'>返回字段说明:</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
@@ -10421,9 +10681,9 @@ http://localhost:3000/api/v1/yystopf/csfjkkj/compare.json
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> GET <span class="se">\</span>
|
||||
http://localhost:3000/api/v1/yystopf/ceshi/webhooks.json
|
||||
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="k">await</span> <span class="nx">octokit</span><span class="p">.</span><span class="nx">request</span><span class="p">(</span><span class="dl">'</span><span class="s1">GET /api/v1/yystopf/ceshi/webhooks.json</span><span class="dl">'</span><span class="p">)</span>
|
||||
</code></pre></div><h3 id='http-25'>HTTP 请求</h3>
|
||||
</code></pre></div><h3 id='http-26'>HTTP 请求</h3>
|
||||
<p><code>GET /api/v1/:owner/:repo/webhooks.json</code></p>
|
||||
<h3 id='2eb6f47757-25'>请求参数:</h3>
|
||||
<h3 id='2eb6f47757-26'>请求参数:</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
@@ -10448,7 +10708,7 @@ http://localhost:3000/api/v1/yystopf/ceshi/webhooks.json
|
||||
<td>项目标识identifier</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='7447e4874e-25'>返回字段说明:</h3>
|
||||
<h3 id='7447e4874e-26'>返回字段说明:</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
@@ -10541,9 +10801,9 @@ http://localhost:3000/api/v1/yystopf/ceshi/webhooks.json
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> GET <span class="se">\</span>
|
||||
http://localhost:3000/api/v1/yystopf/ceshi/webhooks/3.json
|
||||
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="k">await</span> <span class="nx">octokit</span><span class="p">.</span><span class="nx">request</span><span class="p">(</span><span class="dl">'</span><span class="s1">GET /api/v1/yystopf/ceshi/webhooks/3.json</span><span class="dl">'</span><span class="p">)</span>
|
||||
</code></pre></div><h3 id='http-26'>HTTP 请求</h3>
|
||||
</code></pre></div><h3 id='http-27'>HTTP 请求</h3>
|
||||
<p><code>GET /api/v1/:owner/:repo/webhooks/:id.json</code></p>
|
||||
<h3 id='2eb6f47757-26'>请求参数:</h3>
|
||||
<h3 id='2eb6f47757-27'>请求参数:</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
@@ -10575,7 +10835,7 @@ http://localhost:3000/api/v1/yystopf/ceshi/webhooks/3.json
|
||||
<td>webhook ID</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='7447e4874e-26'>返回字段说明:</h3>
|
||||
<h3 id='7447e4874e-27'>返回字段说明:</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
@@ -10698,214 +10958,8 @@ http://localhost:3000/api/v1/yystopf/ceshi/webhooks/3.json
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST <span class="se">\</span>
|
||||
http://localhost:3000/api/v1/yystopf/ceshi/webhooks.json
|
||||
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="k">await</span> <span class="nx">octokit</span><span class="p">.</span><span class="nx">request</span><span class="p">(</span><span class="dl">'</span><span class="s1">POST /api/v1/yystopf/ceshi/webhooks.json</span><span class="dl">'</span><span class="p">)</span>
|
||||
</code></pre></div><h3 id='http-27'>HTTP 请求</h3>
|
||||
<p><code>POST /api/v1/:owner/:repo/webhooks.json</code></p>
|
||||
<h3 id='2eb6f47757-27'>请求参数:</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
<th>必选</th>
|
||||
<th>默认</th>
|
||||
<th>类型</th>
|
||||
<th>字段说明</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>owner</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>用户登录名</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>repo</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>项目标识identifier</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>webhook.url</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>目标url</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>webhook.http_method</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>http方法, POST和GET</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>webhook.content_type</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>POST Content Type</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>webhook.secret</td>
|
||||
<td>否</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>密钥文本</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>webhook.active</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>bool</td>
|
||||
<td>是否激活</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>webhook.branch_filter</td>
|
||||
<td>否</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>分支过滤</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>webhook.events</td>
|
||||
<td>否</td>
|
||||
<td></td>
|
||||
<td>array</td>
|
||||
<td>触发事件</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
|
||||
<p>触发事件字段说明 </p>
|
||||
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
<th>含义</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>create</td>
|
||||
<td>创建分支或标签</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>delete</td>
|
||||
<td>分支或标签删除</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>push</td>
|
||||
<td>git仓库推送</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pull_request</td>
|
||||
<td>合并请求</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pull_request_assign</td>
|
||||
<td>合并请求被指派</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pull_request_review_approved</td>
|
||||
<td>合并请求被批准</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pull_request_review_rejected</td>
|
||||
<td>合并请求被拒绝</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
|
||||
<blockquote>
|
||||
<p>请求的JSON示例:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"active"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"content_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"json"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"http_method"</span><span class="p">:</span><span class="w"> </span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"secret"</span><span class="p">:</span><span class="w"> </span><span class="s2">"123456"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:10000"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"branch_filter"</span><span class="p">:</span><span class="w"> </span><span class="s2">"*"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"events"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"push"</span><span class="p">]</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div><h3 id='7447e4874e-27'>返回字段说明:</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
<th>类型</th>
|
||||
<th>字段说明</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>int</td>
|
||||
<td>id</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>url</td>
|
||||
<td>string</td>
|
||||
<td>地址</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>content_type</td>
|
||||
<td>string</td>
|
||||
<td>POST Content Type</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>is_active</td>
|
||||
<td>bool</td>
|
||||
<td>是否激活</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>type</td>
|
||||
<td>string</td>
|
||||
<td>类型</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>events</td>
|
||||
<td>array</td>
|
||||
<td>触发事件</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>create_time</td>
|
||||
<td>string</td>
|
||||
<td>创建时间</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
|
||||
<blockquote>
|
||||
<p>返回的JSON示例:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">68</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"content_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"json"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"http_method"</span><span class="p">:</span><span class="w"> </span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://127.0.0.1:3000"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"events"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"create"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"delete"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"push"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"pull_request"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"pull_request_assign"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"pull_request_review_approved"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"pull_request_review_rejected"</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nl">"active"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"branch_filter"</span><span class="p">:</span><span class="w"> </span><span class="s2">"*"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-06-23 15:52"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div>
|
||||
<aside class="success">
|
||||
Success Data.
|
||||
</aside>
|
||||
<h2 id='webhook-3'>更新仓库webhook</h2>
|
||||
<p>更新仓库webhook</p>
|
||||
|
||||
<blockquote>
|
||||
<p>示例:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PATCH <span class="se">\</span>
|
||||
http://localhost:3000/api/v1/yystopf/ceshi/webhooks/7.json
|
||||
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="k">await</span> <span class="nx">octokit</span><span class="p">.</span><span class="nx">request</span><span class="p">(</span><span class="dl">'</span><span class="s1">PATCH /api/v1/yystopf/ceshi/webhooks/7.json</span><span class="dl">'</span><span class="p">)</span>
|
||||
</code></pre></div><h3 id='http-28'>HTTP 请求</h3>
|
||||
<p><code>PATCH /api/v1/:owner/:repo/webhooks/68.json</code></p>
|
||||
<p><code>POST /api/v1/:owner/:repo/webhooks.json</code></p>
|
||||
<h3 id='2eb6f47757-28'>请求参数:</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
@@ -10931,13 +10985,6 @@ http://localhost:3000/api/v1/yystopf/ceshi/webhooks/7.json
|
||||
<td>项目标识identifier</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>webhook id</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>webhook.url</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
@@ -11039,6 +11086,219 @@ http://localhost:3000/api/v1/yystopf/ceshi/webhooks/7.json
|
||||
</span><span class="nl">"events"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"push"</span><span class="p">]</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div><h3 id='7447e4874e-28'>返回字段说明:</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
<th>类型</th>
|
||||
<th>字段说明</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>int</td>
|
||||
<td>id</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>url</td>
|
||||
<td>string</td>
|
||||
<td>地址</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>content_type</td>
|
||||
<td>string</td>
|
||||
<td>POST Content Type</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>is_active</td>
|
||||
<td>bool</td>
|
||||
<td>是否激活</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>type</td>
|
||||
<td>string</td>
|
||||
<td>类型</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>events</td>
|
||||
<td>array</td>
|
||||
<td>触发事件</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>create_time</td>
|
||||
<td>string</td>
|
||||
<td>创建时间</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
|
||||
<blockquote>
|
||||
<p>返回的JSON示例:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">68</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"content_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"json"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"http_method"</span><span class="p">:</span><span class="w"> </span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://127.0.0.1:3000"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"events"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"create"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"delete"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"push"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"pull_request"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"pull_request_assign"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"pull_request_review_approved"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"pull_request_review_rejected"</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nl">"active"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"branch_filter"</span><span class="p">:</span><span class="w"> </span><span class="s2">"*"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-06-23 15:52"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div>
|
||||
<aside class="success">
|
||||
Success Data.
|
||||
</aside>
|
||||
<h2 id='webhook-3'>更新仓库webhook</h2>
|
||||
<p>更新仓库webhook</p>
|
||||
|
||||
<blockquote>
|
||||
<p>示例:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PATCH <span class="se">\</span>
|
||||
http://localhost:3000/api/v1/yystopf/ceshi/webhooks/7.json
|
||||
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="k">await</span> <span class="nx">octokit</span><span class="p">.</span><span class="nx">request</span><span class="p">(</span><span class="dl">'</span><span class="s1">PATCH /api/v1/yystopf/ceshi/webhooks/7.json</span><span class="dl">'</span><span class="p">)</span>
|
||||
</code></pre></div><h3 id='http-29'>HTTP 请求</h3>
|
||||
<p><code>PATCH /api/v1/:owner/:repo/webhooks/68.json</code></p>
|
||||
<h3 id='2eb6f47757-29'>请求参数:</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
<th>必选</th>
|
||||
<th>默认</th>
|
||||
<th>类型</th>
|
||||
<th>字段说明</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>owner</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>用户登录名</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>repo</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>项目标识identifier</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>webhook id</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>webhook.url</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>目标url</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>webhook.http_method</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>http方法, POST和GET</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>webhook.content_type</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>POST Content Type</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>webhook.secret</td>
|
||||
<td>否</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>密钥文本</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>webhook.active</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>bool</td>
|
||||
<td>是否激活</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>webhook.branch_filter</td>
|
||||
<td>否</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>分支过滤</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>webhook.events</td>
|
||||
<td>否</td>
|
||||
<td></td>
|
||||
<td>array</td>
|
||||
<td>触发事件</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
|
||||
<p>触发事件字段说明 </p>
|
||||
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
<th>含义</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>create</td>
|
||||
<td>创建分支或标签</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>delete</td>
|
||||
<td>分支或标签删除</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>push</td>
|
||||
<td>git仓库推送</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pull_request</td>
|
||||
<td>合并请求</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pull_request_assign</td>
|
||||
<td>合并请求被指派</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pull_request_review_approved</td>
|
||||
<td>合并请求被批准</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pull_request_review_rejected</td>
|
||||
<td>合并请求被拒绝</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
|
||||
<blockquote>
|
||||
<p>请求的JSON示例:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"active"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"content_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"json"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"http_method"</span><span class="p">:</span><span class="w"> </span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"secret"</span><span class="p">:</span><span class="w"> </span><span class="s2">"123456"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:10000"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"branch_filter"</span><span class="p">:</span><span class="w"> </span><span class="s2">"*"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"events"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"push"</span><span class="p">]</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div><h3 id='7447e4874e-29'>返回字段说明:</h3>
|
||||
<blockquote>
|
||||
<p>返回的JSON示例:</p>
|
||||
</blockquote>
|
||||
@@ -11073,9 +11333,9 @@ http://localhost:3000/api/v1/yystopf/ceshi/webhooks/7.json
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE <span class="se">\</span>
|
||||
http://localhost:3000/api/v1/yystopf/ceshi/webhooks/7.json
|
||||
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="k">await</span> <span class="nx">octokit</span><span class="p">.</span><span class="nx">request</span><span class="p">(</span><span class="dl">'</span><span class="s1">DELETE /api/v1/yystopf/ceshi/webhooks/7.json</span><span class="dl">'</span><span class="p">)</span>
|
||||
</code></pre></div><h3 id='http-29'>HTTP 请求</h3>
|
||||
</code></pre></div><h3 id='http-30'>HTTP 请求</h3>
|
||||
<p><code>DELETE /api/v1/:owner/:repo/webhooks/:id.json</code></p>
|
||||
<h3 id='2eb6f47757-29'>请求参数:</h3>
|
||||
<h3 id='2eb6f47757-30'>请求参数:</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
@@ -11107,7 +11367,7 @@ http://localhost:3000/api/v1/yystopf/ceshi/webhooks/7.json
|
||||
<td>webhook id</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='7447e4874e-29'>返回字段说明:</h3>
|
||||
<h3 id='7447e4874e-30'>返回字段说明:</h3>
|
||||
<blockquote>
|
||||
<p>返回的JSON示例:</p>
|
||||
</blockquote>
|
||||
@@ -11128,9 +11388,9 @@ http://localhost:3000/api/v1/yystopf/ceshi/webhooks/7.json
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> GET <span class="se">\</span>
|
||||
http://localhost:3000/api/v1/yystopf/ceshi/webhooks/3/hooktasks.json
|
||||
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="k">await</span> <span class="nx">octokit</span><span class="p">.</span><span class="nx">request</span><span class="p">(</span><span class="dl">'</span><span class="s1">GET /api/v1/yystopf/ceshi/webhooks/3/hooktasks.json</span><span class="dl">'</span><span class="p">)</span>
|
||||
</code></pre></div><h3 id='http-30'>HTTP 请求</h3>
|
||||
</code></pre></div><h3 id='http-31'>HTTP 请求</h3>
|
||||
<p><code>GET /api/v1/:owner/:repo/webhooks/:id/hooktasks.json</code></p>
|
||||
<h3 id='2eb6f47757-30'>请求参数:</h3>
|
||||
<h3 id='2eb6f47757-31'>请求参数:</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
@@ -11162,7 +11422,7 @@ http://localhost:3000/api/v1/yystopf/ceshi/webhooks/3/hooktasks.json
|
||||
<td>webhook ID</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='7447e4874e-30'>返回字段说明:</h3>
|
||||
<h3 id='7447e4874e-31'>返回字段说明:</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
@@ -11399,9 +11659,9 @@ http://localhost:3000/api/v1/yystopf/ceshi/webhooks/3/hooktasks.json
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST <span class="se">\</span>
|
||||
http://localhost:3000/api/v1/yystopf/ceshi/webhooks/3/tests.json
|
||||
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="k">await</span> <span class="nx">octokit</span><span class="p">.</span><span class="nx">request</span><span class="p">(</span><span class="dl">'</span><span class="s1">POST /api/v1/yystopf/ceshi/webhooks/3/tests.json</span><span class="dl">'</span><span class="p">)</span>
|
||||
</code></pre></div><h3 id='http-31'>HTTP 请求</h3>
|
||||
</code></pre></div><h3 id='http-32'>HTTP 请求</h3>
|
||||
<p><code>POST /api/v1/:owner/:repo/webhooks/:id/tests.json</code></p>
|
||||
<h3 id='2eb6f47757-31'>请求参数:</h3>
|
||||
<h3 id='2eb6f47757-32'>请求参数:</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
@@ -11433,7 +11693,7 @@ http://localhost:3000/api/v1/yystopf/ceshi/webhooks/3/tests.json
|
||||
<td>webhook ID</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='7447e4874e-31'>返回字段说明:</h3>
|
||||
<h3 id='7447e4874e-32'>返回字段说明:</h3>
|
||||
<blockquote>
|
||||
<p>返回的JSON示例:</p>
|
||||
</blockquote>
|
||||
|
||||
Reference in New Issue
Block a user