floraachy/gitlink-forgeplus
1
0
Fork 0
mirror of https://gitlink.org.cn/Gitlink/forgeplus.git synced 2026-05-02 19:30:48 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

新增: 评论相关api根据需求重写

Browse Source
This commit is contained in:
yystopf
2022-07-27 14:52:49 +08:00
parent a35db9fe80
commit d6b5dc326a
18 changed files with 432 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

202
public/docs/api.html
View File

@@ -609,6 +609,9 @@
<li>
<a href="#6a019ede04" class="toc-h2 toc-link" data-title="获取合并请求列表">获取合并请求列表</a>
</li>
<li>
<a href="#035779233c" class="toc-h2 toc-link" data-title="创建一个合并请求">创建一个合并请求</a>
</li>
<li>
<a href="#12fc53a2d2" class="toc-h2 toc-link" data-title="获取合并请求版本列表">获取合并请求版本列表</a>
</li>
@@ -12229,6 +12232,11 @@ http://localhost:3000/api/v1/yystopf/ceshi/webhooks/3/tests.json
<td>审查创建人</td>
</tr>
<tr>
<td>reviewers</td>
<td>array</td>
<td>指定审查用户标识数组</td>
</tr>
<tr>
<td>conflict_files</td>
<td>array</td>
<td>有冲突的文件</td>
@@ -12291,6 +12299,9 @@ http://localhost:3000/api/v1/yystopf/ceshi/webhooks/3/tests.json
</span><span class="nl">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"system/lets/letter_avatars/2/H/188_239_142/120.png"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nl">"reviewers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="s2">"yystopf"</span><span class="w">
</span><span class="p">],</span><span class="w">
</span><span class="nl">"conflict_files"</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><h2 id='dd8282460a'>获取合并请求文件列表</h2>
@@ -13271,7 +13282,184 @@ http://localhost:3000/api/Jason/test-txt/compare/master...Jason/test-txt:develop
</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><h2 id='12fc53a2d2'>获取合并请求版本列表</h2>
</span></code></pre></div><h2 id='035779233c'>创建一个合并请求</h2>
<p>为仓库创建一个合并请求</p>
<blockquote>
<p>示例:</p>
</blockquote>
<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/yystopf/ceshi/pulls.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/yystopf/ceshi/pulls.json</span><span class="dl">'</span><span class="p">)</span>
</code></pre></div><h3 id='http-6'>HTTP 请求</h3>
<p><code>POST /api/:owner/:repo/pulls.json</code></p>
<h3 id='2eb6f47757-6'>请求参数:</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>title</td>
<td>是</td>
<td></td>
<td>string</td>
<td>合并请求标题</td>
</tr>
<tr>
<td>body</td>
<td>否</td>
<td></td>
<td>string</td>
<td>合并请求内容</td>
</tr>
<tr>
<td>base</td>
<td>是</td>
<td></td>
<td>string</td>
<td>目标分支</td>
</tr>
<tr>
<td>head</td>
<td>是</td>
<td></td>
<td>string</td>
<td>源分支</td>
</tr>
<tr>
<td>is_original</td>
<td>是</td>
<td></td>
<td>bool</td>
<td>是否为fork仓库发来的合并请求</td>
</tr>
<tr>
<td>fork_project_id</td>
<td>否</td>
<td></td>
<td>integer</td>
<td>fork仓库ID</td>
</tr>
<tr>
<td>reviewer_ids</td>
<td>否</td>
<td></td>
<td>array</td>
<td>审查人员id数组</td>
</tr>
<tr>
<td>assigned_to_id</td>
<td>否</td>
<td></td>
<td>integer</td>
<td>指派人员ID</td>
</tr>
<tr>
<td>fixed_version_id</td>
<td>否</td>
<td></td>
<td>integer</td>
<td>里程碑ID</td>
</tr>
<tr>
<td>issue_tag_ids</td>
<td>否</td>
<td></td>
<td>array</td>
<td>标记ID数组</td>
</tr>
<tr>
<td>priority_id</td>
<td>否</td>
<td></td>
<td>integer</td>
<td>优先级ID</td>
</tr>
<tr>
<td>receivers_login</td>
<td>否</td>
<td></td>
<td>array</td>
<td>@人员的login</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">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"324"</span><span class="p">,</span><span class="w">
</span><span class="nl">"assigned_to_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2"</span><span class="p">,</span><span class="w">
</span><span class="nl">"fixed_version_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
</span><span class="nl">"issue_tag_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
</span><span class="nl">"priority_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2"</span><span class="p">,</span><span class="w">
</span><span class="nl">"body"</span><span class="p">:</span><span class="w"> </span><span class="s2">"312"</span><span class="p">,</span><span class="w">
</span><span class="nl">"head"</span><span class="p">:</span><span class="w"> </span><span class="s2">"new_branch_1"</span><span class="p">,</span><span class="w">
</span><span class="nl">"base"</span><span class="p">:</span><span class="w"> </span><span class="s2">"master"</span><span class="p">,</span><span class="w">
</span><span class="nl">"is_original"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nl">"fork_project_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
</span><span class="nl">"files_count"</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">"commits_count"</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">"reviewer_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
</span><span class="nl">"receivers_login"</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>
<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">"status"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
</span><span class="nl">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"响应成功"</span><span class="p">,</span><span class="w">
</span><span class="nl">"pull_request_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">169</span><span class="p">,</span><span class="w">
</span><span class="nl">"pull_request_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">"pull_request_status"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
</span><span class="nl">"pull_request_head"</span><span class="p">:</span><span class="w"> </span><span class="s2">"new_branch_1"</span><span class="p">,</span><span class="w">
</span><span class="nl">"pull_request_base"</span><span class="p">:</span><span class="w"> </span><span class="s2">"master"</span><span class="p">,</span><span class="w">
</span><span class="nl">"pull_request_staus"</span><span class="p">:</span><span class="w"> </span><span class="s2">"open"</span><span class="p">,</span><span class="w">
</span><span class="nl">"is_original"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nl">"fork_project_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">"fork_project_identifier"</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">"fork_project_user"</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">"reviewers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="s2">"yystopf"</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="mi">266</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">"324"</span><span class="p">,</span><span class="w">
</span><span class="nl">"pr_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1分钟前"</span><span class="p">,</span><span class="w">
</span><span class="nl">"assign_user_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"heh"</span><span class="p">,</span><span class="w">
</span><span class="nl">"assign_user_login"</span><span class="p">:</span><span class="w"> </span><span class="s2">"yystopf"</span><span class="p">,</span><span class="w">
</span><span class="nl">"author_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"heh"</span><span class="p">,</span><span class="w">
</span><span class="nl">"author_login"</span><span class="p">:</span><span class="w"> </span><span class="s2">"yystopf"</span><span class="p">,</span><span class="w">
</span><span class="nl">"avatar_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"system/lets/letter_avatars/2/H/188_239_142/120.png"</span><span class="p">,</span><span class="w">
</span><span class="nl">"priority"</span><span class="p">:</span><span class="w"> </span><span class="s2">"正常"</span><span class="p">,</span><span class="w">
</span><span class="nl">"version"</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">"journals_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
</span><span class="nl">"issue_tags"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<aside class="success">
Success Data.
</aside>
<h2 id='12fc53a2d2'>获取合并请求版本列表</h2>
<p>获取合并请求版本列表</p>
<blockquote>
@@ -13279,9 +13467,9 @@ http://localhost:3000/api/Jason/test-txt/compare/master...Jason/test-txt:develop
</blockquote>
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> GET http://localhost:3000/api/v1/yystopf/ceshi_commit/pulls/3/versions.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_commit/pulls/3/versions.json</span><span class="dl">'</span><span class="p">)</span>
</code></pre></div><h3 id='http-6'>HTTP 请求</h3>
</code></pre></div><h3 id='http-7'>HTTP 请求</h3>
<p><code>GET /api/v1/:owner/:repo/pulls/:index/versions.json</code></p>
<h3 id='2eb6f47757-6'>请求参数:</h3>
<h3 id='2eb6f47757-7'>请求参数:</h3>
<table><thead>
<tr>
<th>参数</th>
@@ -13408,9 +13596,9 @@ http://localhost:3000/api/Jason/test-txt/compare/master...Jason/test-txt:develop
<span class="nt">-d</span> <span class="s2">"filepath=ceshi_dir_1/new_file_1"</span> <span class="se">\</span>
http://localhost:3000/api/v1/yystopf/ceshi_commit/pulls/3/versions/33/diff.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_commit/pulls/3/versions/33/diff.json</span><span class="dl">'</span><span class="p">)</span>
</code></pre></div><h3 id='http-7'>HTTP 请求</h3>
</code></pre></div><h3 id='http-8'>HTTP 请求</h3>
<p><code>GET /api/v1/:owner/:repo/pulls/:index/versions/:version_id/diff.json</code></p>
<h3 id='2eb6f47757-7'>请求参数:</h3>
<h3 id='2eb6f47757-8'>请求参数:</h3>
<table><thead>
<tr>
<th>参数</th>
@@ -13944,9 +14132,9 @@ http://localhost:3000/api/v1/yystopf/ceshi_commit/pulls/3/versions/33/diff.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/pulls/1/reviews.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/pulls/1/reviews.json</span><span class="dl">'</span><span class="p">)</span>
</code></pre></div><h3 id='http-8'>HTTP 请求</h3>
</code></pre></div><h3 id='http-9'>HTTP 请求</h3>
<p><code>POST /api/v1/:owner/:repo/pulls/:index/reviews.json</code></p>
<h3 id='2eb6f47757-8'>请求参数:</h3>
<h3 id='2eb6f47757-9'>请求参数:</h3>
<table><thead>
<tr>
<th>参数</th>